public interface BackgroundImageVisualizer extends Comparable<BackgroundImageVisualizer>
Visualizations.getAvailableVisualizations()
. If your
visualisation requires user input to e.g. control parameters, extend
AbstractBackgroundImageVisualizer.VisualizationControlPanel
to add
your specific control panel inputs.Modifier and Type | Field and Description |
---|---|
static String |
CACHE_KEY_SECTION_SEPARATOR |
static int |
DEFAULT_BACKGROUND_VISUALIZATION_SCALE |
Modifier and Type | Method and Description |
---|---|
AbstractBackgroundImageVisualizer.VisualizationControlPanel |
getControlPanel()
Gets the visualisation control panel.
|
String |
getDefaultVisualisationFileName(int currentVariant)
Generates the default file name for the current visualisation
|
String |
getHTMLVisualisationControl(Map params)
Returns HTML control elements (inputs) to be used by the webserver version of the SOM.
|
int |
getNumberOfVisualizations() |
int |
getPreferredScaleFactor()
Return the preferred scale factor for interpolation for this visualisation.
|
BufferedImage |
getVisualization(int variantIndex,
GrowingSOM gsom,
int width,
int height)
Returns a visualisation image.
|
String |
getVisualizationDescription(int variantIndex)
Gets the descriptions of a specified visualisation variant.
|
String[] |
getVisualizationDescriptions()
Gets the descriptions of all visualisation variants provided by this visualiser.
|
HashMap<String,BufferedImage> |
getVisualizationFlavours(int index,
GrowingSOM gsom,
int width,
int height)
Returns all visualisation flavours of the given variant, e.g.
|
HashMap<String,BufferedImage> |
getVisualizationFlavours(int index,
GrowingSOM gsom,
int width,
int height,
int maxFlavours)
Returns all visualisation flavours of the given variant just as
getVisualizationFlavours(int, GrowingSOM, int, int) , but limiting the number of flavours to the given
maximum number. |
HashMap<String,BufferedImage> |
getVisualizationFlavours(int index,
GrowingSOM gsom,
int width,
int height,
Map<String,String> flavourParameters)
Returns all visualisation flavours of the given variant just as
getVisualizationFlavours(int, GrowingSOM, int, int) , but limiting the number of flavours by the given
parameters. |
String |
getVisualizationName(int variantIndex)
Gets the name of a specified visualisation variant.
|
String[] |
getVisualizationNames()
Gets the names of all visualisation variants provided by this visualiser.
|
String |
getVisualizationShortName(int variantIndex)
Gets the short name of a specified visualisation variant.
|
String[] |
getVisualizationShortNames()
Gets the short names of all visualisation variants provided by this visualiser.
|
String[] |
needsAdditionalFiles()
Checks whether this visualisation still needs some input files to generate an image.
|
void |
setInputObjects(SharedSOMVisualisationData inputObjects)
Sets the input objects needed to create visualisations.
|
void |
setMap(MapPNode map)
Sets the map this visualiser operates on.
|
void |
setSOMData(SOMInputReader reader)
Sets the input data needed to create visualisations.
|
void |
setVisualizationUpdateListener(VisualizationUpdateListener listener)
Sets a new listener for visualisation update events.
|
compareTo
static final int DEFAULT_BACKGROUND_VISUALIZATION_SCALE
static final String CACHE_KEY_SECTION_SEPARATOR
BufferedImage getVisualization(int variantIndex, GrowingSOM gsom, int width, int height) throws SOMToolboxException
variantIndex
- the index of the variant to usegsom
- the GrowingSOM to take build the visualisation forwidth
- the desired width of the image, in pixelsheight
- the desired height of the image, in pixelsSOMToolboxException
- If there was an error creating the visualisationint getNumberOfVisualizations()
String[] getVisualizationNames()
String getVisualizationName(int variantIndex)
variantIndex
- the index of the variant to useString[] getVisualizationShortNames()
String getVisualizationShortName(int variantIndex)
variantIndex
- the index of the variant to useString[] getVisualizationDescriptions()
String getVisualizationDescription(int variantIndex)
variantIndex
- the index of the variant to useAbstractBackgroundImageVisualizer.VisualizationControlPanel getControlPanel()
String[] needsAdditionalFiles()
void setVisualizationUpdateListener(VisualizationUpdateListener listener)
listener
- the new listener to be registeredvoid setInputObjects(SharedSOMVisualisationData inputObjects)
inputObjects
- the new input objectsSOMVisualisationData
void setSOMData(SOMInputReader reader)
reader
- the som input readervoid setMap(MapPNode map)
map
- the mapString getHTMLVisualisationControl(Map params)
params
- the parameters as passed by the web request - used to select the values in the inputs.int getPreferredScaleFactor()
HashMap<String,BufferedImage> getVisualizationFlavours(int index, GrowingSOM gsom, int width, int height) throws SOMToolboxException
SOMToolboxException
HashMap<String,BufferedImage> getVisualizationFlavours(int index, GrowingSOM gsom, int width, int height, int maxFlavours) throws SOMToolboxException
getVisualizationFlavours(int, GrowingSOM, int, int)
, but limiting the number of flavours to the given
maximum number.SOMToolboxException
HashMap<String,BufferedImage> getVisualizationFlavours(int index, GrowingSOM gsom, int width, int height, Map<String,String> flavourParameters) throws SOMToolboxException
getVisualizationFlavours(int, GrowingSOM, int, int)
, but limiting the number of flavours by the given
parameters.SOMToolboxException
String getDefaultVisualisationFileName(int currentVariant)