public class SOMDescriptionHTML
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected DatasetInformation |
dataset
contains all available information about the input data
|
private EditableReportProperties |
EP |
private java.lang.String |
imgDir
the directory to which the created images shall be saved
|
static java.lang.String |
imgSubdir
the name of the directory where the image shall be saved - relative to the given baseDir path in the constructor
|
private QMContainer |
qm
Quality Measure Container
|
(package private) java.util.ArrayList |
qualifiers
ArrayList for quality measures
|
private SemanticInterpreterGrid |
sGrid
The SemanticGrid used for Semantic Interpretation of Quality Measures & Classes
|
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 and Description |
---|
SOMDescriptionHTML(ReportFileWriter writer,
DatasetInformation dataset,
TestRunResult testrun,
java.lang.String baseDir,
EditableReportProperties EP)
creates a new instance
|
Modifier and Type | Method and Description |
---|---|
private java.lang.String |
classDistInCluster(int level,
int numbInputs)
returns a formatted string that contains information about the classes present in the given cluster
|
java.lang.String |
createClusterReport(int clusterlevel)
Creates a semantic Report on the Given Clusterlevel
|
private java.lang.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 java.lang.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, ...
|
void |
includeAdditionalVisualizations() |
protected void |
printClusterInfos()
this function prints some information about the possible clusters that can be found on the SOM.
|
protected int[] |
printClusterNode(ClusterNode node,
int parentLevel,
int boundary,
int depth,
int[] nodeInfos)
outputs the subtree in one node of the cluster tree we add to the report.
|
void |
printDataDistribution() |
protected void |
printDistributionDetailTable(java.util.Hashtable<java.lang.String,java.util.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)
|
void |
printQualityMeasureReport()
Prints a report opn all selected qualitymeasures
|
protected void |
printRandomSeed()
prints the random seed used for the initialization of the SOM (taken from the MySOMMapDescription, provided by
the TestRunResult object)
|
void |
printRegionalOverviewReport()
Creates a semantic Report on teh SOM
|
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:
type and topology of SOM
dimensions of the som
different training parameters
neighbourhood function
...
|
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)
|
void |
showSDHSwitchBox(int maxs,
int step)
Generate teh sdh switch box for all possible values of s: create pics, and bind them to the page
|
void |
showTopographicProductSwitchBox(int maxs,
int step)
Generate teh TopographicProduct switch box for all possible values of s: create pics, and bind them to the page
|
void |
showTrustworthyNessSwitchBox(int maxs,
int step)
Generate teh TrustworthyNessImages switch box for all possible values of s: create pics, and bind them to the
page
|
public static final java.lang.String imgSubdir
java.util.ArrayList qualifiers
protected ReportFileWriter writer
protected TestRunResult testrun
protected DatasetInformation dataset
private QMContainer qm
private java.lang.String imgDir
private SemanticInterpreterGrid sGrid
private EditableReportProperties EP
public SOMDescriptionHTML(ReportFileWriter writer, DatasetInformation dataset, TestRunResult testrun, java.lang.String baseDir, EditableReportProperties EP)
writer
- object that handles how the created string is written to a filedataset
- object storing information about input datatestrun
- object storing information about testrun resultspublic 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(java.util.Hashtable<java.lang.String,java.util.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 printTopographicErrorReport()
protected java.lang.String getUnitCoords(UnitQEContainer value)
value
- the container from which the information about the number ob units can be pickedprivate java.lang.String getInputCoords(InputQEContainer value)
value
- a container storing all information required to create the outputprotected void printClusterInfos()
private java.lang.String classDistInCluster(int level, int numbInputs)
level
- the level of the cluster of interestnumbInputs
- the number of input vectors mapped to this clusterprotected int[] printClusterNode(ClusterNode node, int parentLevel, int boundary, int depth, int[] nodeInfos)
node
- the node in the cluster tree, whose subtree shall be createdparentLevel
- the number of the level of the parent node - needed to calculate the number of new clusters
this cluster remains unchangedboundary
- the maximal level, where the recursion shall stopdepth
- the depth of this node in the tree, seen from the rootnodeInfos
- WARNING!!! this array contains two different information: at index 0, the maximal number of new
clusters a cluster "survived" is saved. at index 1, the corresponding level is saved. from index i = 2
to n+1 , the depth of the clusternode of level i is saved.public void showSDHSwitchBox(int maxs, int step)
public void showTrustworthyNessSwitchBox(int maxs, int step)
public void showTopographicProductSwitchBox(int maxs, int step)
public void printRegionalOverviewReport()
public java.lang.String createClusterReport(int clusterlevel)
clusterlevel
- the clusterlevelpublic void printQualityMeasureReport()
public void includeAdditionalVisualizations()