at.tuwien.ifs.somtoolbox.visualization
Class ComponentPlanesVisualizer

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.AbstractItemVisualizer
              extended by at.tuwien.ifs.somtoolbox.visualization.ComponentPlanesVisualizer
All Implemented Interfaces:
BackgroundImageVisualizer, MatrixVisualizer, Comparable<BackgroundImageVisualizer>

public class ComponentPlanesVisualizer
extends AbstractItemVisualizer

This visualiser provides a visualisation of component planes, i.e. of the template vector elements.

Version:
$Id: ComponentPlanesVisualizer.java 3871 2010-10-27 08:43:07Z frank $
Author:
Michael Dittenbach, Rudolf Mayer

Nested Class Summary
private  class ComponentPlanesVisualizer.ComponentPlaneControlPanel
          A control panel extending the generic AbstractBackgroundImageVisualizer.VisualizationControlPanel, adding additionally a JList and a JTextField for selecting a component from the TemplateVector.
 
Nested classes/interfaces inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractItemVisualizer
AbstractItemVisualizer.AbstractSelectedItemVisualizerControlPanel
 
Nested classes/interfaces inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractBackgroundImageVisualizer
AbstractBackgroundImageVisualizer.ContourInterpolationMode, AbstractBackgroundImageVisualizer.ContourMode, AbstractBackgroundImageVisualizer.VisualizationControlPanel
 
Field Summary
private  SOMLibTemplateVector templateVector
           
 
Fields inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractItemVisualizer
currentElement
 
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
ComponentPlanesVisualizer()
           
 
Method Summary
private  BufferedImage createComponentPlaneImage(GrowingSOM gsom, int width, int height)
           
 BufferedImage createVisualization(int index, GrowingSOM gsom, int width, int height)
          Creates a visualisation image.
 BufferedImage createVisualization(int index, int plane, GrowingSOM gsom, int width, int height)
           
protected  String getCacheKey(GrowingSOM gsom, int index, int width, int height)
          The key of a cache is created as follows: VisualisationShortName + Hashcode of the SOM + Width + Height + Opacity.
Sub-classes might add more information to the cache, if needed.
 String getPreferredPaletteName()
          Default implementation using Palettes.getDefaultPalette().
 HashMap<String,BufferedImage> getVisualizationFlavours(int index, GrowingSOM gsom, int width, int height)
          Default implementation which returns a map of size 1 with the standard, unparameterised visualisation of the given variant.
 HashMap<String,BufferedImage> getVisualizationFlavours(int index, GrowingSOM gsom, int width, int height, int maxFlavours)
          Default implementation equal to AbstractBackgroundImageVisualizer.getVisualizationFlavours(int, GrowingSOM, int, int).
 HashMap<String,BufferedImage> getVisualizationFlavours(int index, GrowingSOM gsom, int width, int height, Map<String,String> flavourParameters)
          Default implementation equal to AbstractBackgroundImageVisualizer.getVisualizationFlavours(int, GrowingSOM, int, int).
 
Methods inherited from class at.tuwien.ifs.somtoolbox.visualization.AbstractMatrixVisualizer
computeHitHistogram, computeSpline, constrainWithinPalette, createImage, drawContour, 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, 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
 

Field Detail

templateVector

private SOMLibTemplateVector templateVector
Constructor Detail

ComponentPlanesVisualizer

public ComponentPlanesVisualizer()
Method Detail

getCacheKey

protected String getCacheKey(GrowingSOM gsom,
                             int index,
                             int width,
                             int height)
Description copied from class: AbstractBackgroundImageVisualizer
The key of a cache is created as follows: VisualisationShortName + Hashcode of the SOM + Width + Height + Opacity.
Sub-classes might add more information to the cache, if needed.

Overrides:
getCacheKey in class AbstractMatrixVisualizer

createVisualization

public BufferedImage createVisualization(int index,
                                         int plane,
                                         GrowingSOM gsom,
                                         int width,
                                         int height)
                                  throws SOMToolboxException
Throws:
SOMToolboxException

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

createComponentPlaneImage

private BufferedImage createComponentPlaneImage(GrowingSOM gsom,
                                                int width,
                                                int height)
                                         throws SOMToolboxException
Throws:
SOMToolboxException

getVisualizationFlavours

public HashMap<String,BufferedImage> getVisualizationFlavours(int index,
                                                              GrowingSOM gsom,
                                                              int width,
                                                              int height)
                                                       throws SOMToolboxException
Description copied from class: AbstractBackgroundImageVisualizer
Default implementation which returns a map of size 1 with the standard, unparameterised visualisation of the given variant. Subclasses that want to return more flavours should override this method.

Specified by:
getVisualizationFlavours in interface BackgroundImageVisualizer
Overrides:
getVisualizationFlavours in class AbstractBackgroundImageVisualizer
Throws:
SOMToolboxException

getVisualizationFlavours

public HashMap<String,BufferedImage> getVisualizationFlavours(int index,
                                                              GrowingSOM gsom,
                                                              int width,
                                                              int height,
                                                              int maxFlavours)
                                                       throws SOMToolboxException
Description copied from class: AbstractBackgroundImageVisualizer
Default implementation equal to AbstractBackgroundImageVisualizer.getVisualizationFlavours(int, GrowingSOM, int, int).

Specified by:
getVisualizationFlavours in interface BackgroundImageVisualizer
Overrides:
getVisualizationFlavours in class AbstractBackgroundImageVisualizer
Throws:
SOMToolboxException

getVisualizationFlavours

public HashMap<String,BufferedImage> getVisualizationFlavours(int index,
                                                              GrowingSOM gsom,
                                                              int width,
                                                              int height,
                                                              Map<String,String> flavourParameters)
                                                       throws SOMToolboxException
Description copied from class: AbstractBackgroundImageVisualizer
Default implementation equal to AbstractBackgroundImageVisualizer.getVisualizationFlavours(int, GrowingSOM, int, int).

Specified by:
getVisualizationFlavours in interface BackgroundImageVisualizer
Overrides:
getVisualizationFlavours in class AbstractBackgroundImageVisualizer
Throws:
SOMToolboxException

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