at.tuwien.ifs.somtoolbox.visualization
Class UMatrix

java.lang.Object
  extended by at.tuwien.ifs.somtoolbox.visualization.AbstractBackgroundImageVisualizer
      extended by at.tuwien.ifs.somtoolbox.visualization.AbstractMatrixVisualizer
          extended by at.tuwien.ifs.somtoolbox.visualization.UMatrix
All Implemented Interfaces:
BackgroundImageVisualizer, MatrixVisualizer, Comparable<BackgroundImageVisualizer>
Direct Known Subclasses:
GapVisualiser, PMatrix

public class UMatrix
extends AbstractMatrixVisualizer
implements BackgroundImageVisualizer

This Visualizer provides two variants of the U-Matrix.

  1. Implementation of the classic U-Matrix as described in Ultsch, A., and Siemon, H.P. Kohonen's Self Organizing Feature Maps for Exploratory Data Analysis. In Proc. Intern. Neural Networks, 1990, pp. 305-308, Kluwer Academic Press, Paris, France..
  2. Same as 1., but D-Matrix Values only.

Version:
$Id: UMatrix.java 3852 2010-10-12 13:32:25Z mayer $
Author:
Michael Dittenbach, Rudolf Mayer

Nested Class Summary
 
Nested classes/interfaces inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractBackgroundImageVisualizer
AbstractBackgroundImageVisualizer.ContourInterpolationMode, AbstractBackgroundImageVisualizer.ContourMode, AbstractBackgroundImageVisualizer.VisualizationControlPanel
 
Field Summary
static String[] UMATRIX_SHORT_NAMES
           
 
Fields inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractMatrixVisualizer
maximumMatrixValue, minimumMatrixValue, palette
 
Fields inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractBackgroundImageVisualizer
cache, CACHE_KEY_SECTION_SEPARATOR, CACHE_KEY_SEPARATOR, contourInterpolationMode, contourMode, controlPanel, currentZDimSlice, inputObjects, interpolate, log, map, MAX_CACHE_SIZE_MB, neededInputObjects, NUM_VISUALIZATIONS, numberOfContours, opacity, preferredScaleFactor, VISUALIZATION_DESCRIPTIONS, VISUALIZATION_NAMES, VISUALIZATION_SHORT_NAMES, visualizationUpdateListener, zSize
 
Fields inherited from interface at.tuwien.ifs.somtoolbox.visualization.BackgroundImageVisualizer
DEFAULT_BACKGROUND_VISUALIZATION_SCALE
 
Constructor Summary
UMatrix()
           
 
Method Summary
private  BufferedImage createOriginalDMatrix(GrowingSOM gsom, int width, int height)
          Creates an image of the D-Matrix visualisation.
private  BufferedImage createOriginalUMatrix(GrowingSOM gsom, int width, int height)
          Creates an image of the U-Matrix visualisation.
 cern.colt.matrix.DoubleMatrix2D createUMatrix(GrowingSOM gsom)
          Creates the height matrix.
 BufferedImage createVisualization(int index, GrowingSOM gsom, int width, int height)
          Creates a visualisation image.
 String getPreferredPaletteName()
          Default implementation using Palettes.getDefaultPalette().
 
Methods inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractMatrixVisualizer
computeHitHistogram, computeSpline, constrainWithinPalette, createImage, drawContour, getCacheKey, getCurrentPalette, getMaximumMatrixValue, getMinimumMatrixValue, getPalette, getVisualization, invalidateCache, reversePalette, setInterpolate, setPalette
 
Methods inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractBackgroundImageVisualizer
appendToCacheKey, buildCacheKey, checkNeededObjectsAvailable, checkVariantIndex, clearVisualisationCache, compareTo, createVisualization, drawBackground, getControlPanel, getHTMLVisualisationControl, getNumberOfVisualizations, getPreferredScaleFactor, getVariantException, getVisualizationDescription, getVisualizationDescriptions, getVisualizationFlavours, getVisualizationFlavours, getVisualizationFlavours, getVisualizationName, getVisualizationNames, getVisualizationShortName, getVisualizationShortNames, invalidateCache, logImageCache, needsAdditionalFiles, setInputObjects, setMap, setSOMData, setVisualizationUpdateListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface at.tuwien.ifs.somtoolbox.visualization.BackgroundImageVisualizer
getControlPanel, getHTMLVisualisationControl, getNumberOfVisualizations, getPreferredScaleFactor, getVisualization, getVisualizationDescription, getVisualizationDescriptions, getVisualizationFlavours, getVisualizationFlavours, getVisualizationFlavours, getVisualizationName, getVisualizationNames, getVisualizationShortName, getVisualizationShortNames, needsAdditionalFiles, setInputObjects, setMap, setSOMData, setVisualizationUpdateListener
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

UMATRIX_SHORT_NAMES

public static final String[] UMATRIX_SHORT_NAMES
Constructor Detail

UMatrix

public UMatrix()
Method Detail

createVisualization

public BufferedImage createVisualization(int index,
                                         GrowingSOM gsom,
                                         int width,
                                         int height)
                                  throws SOMToolboxException
Description copied from class: AbstractBackgroundImageVisualizer
Creates a visualisation image. Subclasses must implement this method.

Specified by:
createVisualization in class AbstractBackgroundImageVisualizer
Parameters:
index - the index of the variant to use
gsom - the GrowingSOM to take build the visualisation for
width - the desired width of the image, in pixels
height - the desired height of the image, in pixels.
Returns:
an image for this visualisation.
Throws:
SOMToolboxException

createOriginalDMatrix

private BufferedImage createOriginalDMatrix(GrowingSOM gsom,
                                            int width,
                                            int height)
                                     throws SOMToolboxException
Creates an image of the D-Matrix visualisation.

Parameters:
gsom - the GrowingSOM to generate the visualisation for
width - the desired width of the image, in pixels
height - the desired height of the image, in pixels.
Returns:
an image for this visualisation.
Throws:
SOMToolboxException

createOriginalUMatrix

private BufferedImage createOriginalUMatrix(GrowingSOM gsom,
                                            int width,
                                            int height)
                                     throws SOMToolboxException
Creates an image of the U-Matrix visualisation.

Parameters:
gsom - the GrowingSOM to generate the visualisation for
width - the desired width of the image, in pixels
height - the desired height of the image, in pixels.
Returns:
an image for this visualisation.
Throws:
SOMToolboxException

createUMatrix

public cern.colt.matrix.DoubleMatrix2D createUMatrix(GrowingSOM gsom)
Creates the height matrix.

Parameters:
gsom - the GrowingSOM to generate the visualisation for
Returns:
a matrix containing heights for each coordinate.

getPreferredPaletteName

public String getPreferredPaletteName()
Description copied from class: AbstractMatrixVisualizer
Default implementation using Palettes.getDefaultPalette(). Subclasses that want to use a different palette should overwrite this method.

Specified by:
getPreferredPaletteName in interface MatrixVisualizer
Overrides:
getPreferredPaletteName in class AbstractMatrixVisualizer