|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BackgroundImageVisualizer
Interface defining a visualisation of a SOM. If you want to provide new visualisers, you have to implement this
interface and register your visualisation in Visualizations.getAvailableVisualizations()
. If your
visualisation requires user input to e.g. control parameters, extend
AbstractBackgroundImageVisualizer.VisualizationControlPanel
to add
your specific control panel inputs.
Field Summary | |
---|---|
static int |
DEFAULT_BACKGROUND_VISUALIZATION_SCALE
|
Method Summary | |
---|---|
AbstractBackgroundImageVisualizer.VisualizationControlPanel |
getControlPanel()
Gets the visualisation control panel. |
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. |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
---|
static final int DEFAULT_BACKGROUND_VISUALIZATION_SCALE
Method Detail |
---|
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 pixels
SOMToolboxException
- If there was an error creating the visualisationint getNumberOfVisualizations()
String[] getVisualizationNames()
String getVisualizationName(int variantIndex)
variantIndex
- the index of the variant to use
String[] getVisualizationShortNames()
String getVisualizationShortName(int variantIndex)
variantIndex
- the index of the variant to use
String[] getVisualizationDescriptions()
String getVisualizationDescription(int variantIndex)
variantIndex
- the index of the variant to use
AbstractBackgroundImageVisualizer.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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |