|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectat.tuwien.ifs.somtoolbox.reportgenerator.output.SOMDescriptionLATEX
public class SOMDescriptionLATEX
this class is the base class for generating the part of the reports that describes a SOM. it creates output containing information about basic properties of the learning process and the created SOM, as well as about the distribution of the input data on this SOM. This class implements the description of a standard GrowingSOM, and is subtyped for creating proper description of other SOMs.
Field Summary | |
---|---|
protected DatasetInformation |
dataset
contains all available information about the input data |
protected String |
imgDir
the directory to which the created images shall be saved |
static String |
imgSubdir
the name of the directory where the image shall be saved - relative to the given baseDir path in the constructor |
protected TestRunResult |
testrun
encapsulates all available information about the testrun - just ask |
protected ReportFileWriter |
writer
all strings that shall be in the output are sent to this object |
Constructor Summary | |
---|---|
SOMDescriptionLATEX(ReportFileWriter writer,
DatasetInformation dataset,
TestRunResult testrun,
String baseDir)
creates a new instance |
Method Summary | |
---|---|
private String |
classDistInCluster(int level,
int numbInputs)
returns a formatted string that contains information about the classes present in the given cluster |
private String |
getInputCoords(InputQEContainer value)
formats a list of input vectors for use in the quantization error list the created format is: "on input vector(s) "id" on unit at[x,y], "id2" on unit at [x2,y2],... |
protected String |
getUnitCoords(UnitQEContainer value)
formats a list of units for use in the quantization error list the created format is "on unit(s) at [x,y] - z vectors mapped, [x2,y2] - z2 vectors mapped, ... |
protected void |
printClusterInfos()
this function prints some information about the possible clusters that can be found on the SOM. |
void |
printDataDistribution()
|
protected void |
printDistributionDetailTable(Hashtable<String,Vector<InputDatum>> lookup,
boolean classInformationAvailable)
creates and outputs one out of two possible tables the first possible table: \\\\ the first table contains for each unit only the number of input vectors mapped to it, and a pie chart image of the class distribution within this unit. |
protected void |
printLearningRate()
prints the type of how the learning rate changes, and the initial learning rate (taken from the MySOMMapDescription, provided by the TestRunResult object) |
protected void |
printMapLayout(boolean classInfoAvailable)
Creates output describing the layout of the created som this includes tables showing the distribution of the input vectors of the som, as well as (if available) the distribution of the classes on the som. |
protected void |
printMetricUsed()
prints the metric used to calculate the distance between two vectors (taken from the MySOMMapDescription, provided by the TestRunResult object) |
protected void |
printNeighbourhoodFunction()
Prints the neighbourhood type and the initial neighbourhood range used for training (taken from the MySOMMapDescription, provided by the TestRunResult object) |
protected void |
printNumberOfIterations()
prints the number of iterations used in the training process (taken from the MySOMMapDescription, provided by the TestRunResult object) |
protected void |
printQuantizationErrorReport()
prints a list with different quantization errors. |
protected void |
printRandomSeed()
prints the random seed used for the initialization of the SOM (taken from the MySOMMapDescription, provided by the TestRunResult object) |
protected void |
printSigma()
prints the value of the sigma, as one of the learning parameters (taken from the SOMProperty object) |
void |
printSOMDescription()
initiates the creation of the output Creates the description of the SOM and training properties |
protected void |
printSOMDimensions()
Prints the dimension of the SOM, that is the number of units in x and y direction (for Growing SOM this is enough) (taken from the MySOMMapDescription, provided by the TestRunResult object) |
protected void |
printSOMProperties()
prints a list of properties describing the training process and the generated SOM this list contains besides others: \\begin{itemize} \\item type and topology of SOM \\item dimensions of the som \\item different training parameters \\item neighbourhood function \\item ... |
protected void |
printTau()
prints the value of the tau, as one of the learning parameters (taken from the SOMProperty object) |
protected void |
printTopographicErrorReport()
adds information about the topographic error on the map to the report beside a list containing the topographic error of the map and the min/max top. |
protected void |
printTopologyOfSOM()
Prints the topology and type of the SOM (unit shape, type of SOM, ...) the value is dependent of the value keyTopoology specified by the TestRunResult Object |
protected void |
printTrainingDate()
if available, prints the time and date of the training (taken from the MySOMMapDescription, provided by the TestRunResult object) |
protected void |
printTrainingTime()
if available, prints the time the training of the SOM needed (taken from the MySOMMapDescription, provided by the TestRunResult object) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String imgSubdir
protected ReportFileWriter writer
protected TestRunResult testrun
protected DatasetInformation dataset
protected String imgDir
Constructor Detail |
---|
public SOMDescriptionLATEX(ReportFileWriter writer, DatasetInformation dataset, TestRunResult testrun, String baseDir)
writer
- object that handles how the created string is written to a filedataset
- object storing information about input datatestrun
- object storing information about testrun resultsbaseDir
- path to the directory where created images shall be storedMethod Detail |
---|
public void printSOMDescription()
protected void printSOMProperties()
protected void printTopologyOfSOM()
protected void printSOMDimensions()
protected void printSigma()
protected void printTau()
protected void printMetricUsed()
protected void printNumberOfIterations()
protected void printTrainingDate()
protected void printTrainingTime()
protected void printRandomSeed()
protected void printNeighbourhoodFunction()
protected void printLearningRate()
public void printDataDistribution()
protected void printMapLayout(boolean classInfoAvailable)
classInfoAvailable
- true if class information are available (and therefore a piechart should be inserted,
false otherwise)protected void printDistributionDetailTable(Hashtable<String,Vector<InputDatum>> lookup, boolean classInformationAvailable)
lookup
- a hashtable with the content specified above to map input vectors to unitsclassInformationAvailable
- true if class information (and therefore pie chart diagrams for the units are
available, false otherwiseprotected void printQuantizationErrorReport()
protected void printTopographicErrorReport()
protected String getUnitCoords(UnitQEContainer value)
value
- the container from which the information about the number ob units can be picked
private String getInputCoords(InputQEContainer value)
value
- a container storing all information required to create the output
protected void printClusterInfos()
private String classDistInCluster(int level, int numbInputs)
level
- the level of the cluster of interestnumbInputs
- the number of input vectors mapped to this cluster
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |