DataTransform (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- loci.visbio.data.DataTransform

All Implemented Interfaces:

Dynamic, Saveable

Direct Known Subclasses:

ArbitrarySlice, ImageTransform, OverlayTransform
```
public abstract class DataTransform
extends Object
implements Dynamic, Saveable
```
DataTransform is the superclass of all data transform types.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`dims` A list of what each dimension in the multidimensional structure means.
`protected Font`	`font` Font used for this transform's text mappings.
`protected String[][]`	`labels` Label for each value at each dimensional axis.
`protected int[]`	`lengths` Length of each dimension in the multidimensional structure.
`protected Vector`	`listeners` List of transform listeners.
`static char`	`MU`
`protected String`	`name` Name of this transform.
`protected static int`	`nextId` Next free transform id number.
`protected DataTransform`	`parent` Parent transform from which this transform obtains its data.
`protected ThumbnailHandler`	`thumbs` Handles logic for creating thumbnails from transform data.
`protected int`	`transformId` ID number for this data transform.

Constructor Summary

Constructors
Constructor and Description
`DataTransform()` Constructs an uninitialized data transform.
`DataTransform(DataTransform parent, String name)` Creates a data transform with the given transform as its parent.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTransformListener(TransformListener l)` Adds the given listener to the list of listeners.
`boolean`	`canDisplay2D()` Gets whether this data object can be displayed in 2D.
`boolean`	`canDisplay3D()` Gets whether this data object can be displayed in 3D.
`void`	`discard()` Called when this object is being discarded in favor of another object with a matching state.
`void`	`displayChanged(DisplayEvent e)` Whenever a display to which this transform is linked changes, the DisplayEvent is passed to this method so that the transform can adjust itself (i.e., is interactive).
`abstract String`	`getCacheId(int[] pos, boolean global)` Gets a string id uniquely describing this data transform at the given dimensional position, for the purposes of thumbnail caching.
`JComponent`	`getControls()` Gets associated GUI controls for this transform.
`abstract Data`	`getData(TransformLink link, int[] pos, int dim, DataCache cache)` Retrieves the data corresponding to the given dimensional position, for the given display dimensionality.
`String[]`	`getDimTypes()` Gets string descriptors for each dimensional axis type.
`Font`	`getFont()` Gets the font used for this transform's text mappings.
`String`	`getHTMLDescription()` Gets a description of this transform, with HTML markup.
`String[][]`	`getLabels()` Gets label for each dimensional position.
`int[]`	`getLengths()` Gets length of each dimensional axis.
`String`	`getName()` Gets the name of this transform.
`DataTransform`	`getParent()` Gets the parent of this transform.
`abstract ScalarMap[]`	`getSuggestedMaps()` Retrieves a set of mappings for displaying this transform effectively.
`ThumbnailHandler`	`getThumbHandler()` Gets thumbnail handler for thumbnail-related operations.
`int`	`getTransformId()` Gets the data transform ID.
`static String`	`getUnitDescription(String dimType, int len)` Gets the unit description for a dimensional type.
`void`	`initState(Dynamic dyn)` Modifies this object's state to match that of the given object.
`boolean`	`isCompatible(Dynamic dyn)` Tests whether the given dynamic object can be used as an argument to initState, for initializing this dynamic object.
`abstract boolean`	`isImmediate()` Gets whether this transform should be drawn immediately, or "burned in" at full resolution after the usual delay by a separate thread.
`abstract boolean`	`isValidDimension(int dim)` Gets whether this transform provides data of the given dimensionality.
`protected void`	`makeLabels()` Creates labels based on data transform parameters.
`boolean`	`matches(Dynamic dyn)` Tests whether two dynamic objects are equivalent.
`void`	`notifyListeners(TransformEvent e)` Notifies transform listeners of a parameter change.
`void`	`removeTransformListener(TransformListener l)` Removes the given listener from the list of listeners.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element (a child of "DataTransforms").
`void`	`saveState(Element el)` Writes the current state to the given DOM element (a child of "DataTransforms").
`void`	`setFont(Font font)` Sets the font used for this transform's text mappings.
`String`	`toString()` Gets a string representation of this transform.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MU
```
public static final char MU
```
    See Also:
    
    Constant Field Values
  - nextId
```
protected static int nextId
```
    Next free transform id number.
  - parent
```
protected DataTransform parent
```
    Parent transform from which this transform obtains its data.
  - name
```
protected String name
```
    Name of this transform.
  - transformId
```
protected int transformId
```
    ID number for this data transform.
  - lengths
```
protected int[] lengths
```
    Length of each dimension in the multidimensional structure.
  - dims
```
protected String[] dims
```
    A list of what each dimension in the multidimensional structure means. Common values include Time, Slice, Channel, Spectra and Lifetime.
  - labels
```
protected String[][] labels
```
    Label for each value at each dimensional axis.
  - thumbs
```
protected ThumbnailHandler thumbs
```
    Handles logic for creating thumbnails from transform data.
  - font
```
protected Font font
```
    Font used for this transform's text mappings.
  - listeners
```
protected Vector listeners
```
    List of transform listeners.
- Constructor Detail
  - DataTransform
```
public DataTransform()
```
    Constructs an uninitialized data transform.
  - DataTransform
```
public DataTransform(DataTransform parent,
                     String name)
```
    Creates a data transform with the given transform as its parent.
- Method Detail
  - getData
```
public abstract Data getData(TransformLink link,
                             int[] pos,
                             int dim,
                             DataCache cache)
```
    Retrieves the data corresponding to the given dimensional position, for the given display dimensionality.
    
    Returns:
    
    null if the transform does not provide data of that dimensionality
  - isValidDimension
```
public abstract boolean isValidDimension(int dim)
```
    Gets whether this transform provides data of the given dimensionality.
  - getSuggestedMaps
```
public abstract ScalarMap[] getSuggestedMaps()
```
    Retrieves a set of mappings for displaying this transform effectively.
  - getCacheId
```
public abstract String getCacheId(int[] pos,
                                  boolean global)
```
    Gets a string id uniquely describing this data transform at the given dimensional position, for the purposes of thumbnail caching. If global flag is true, the id is suitable for use in the default, global cache file.
  - isImmediate
```
public abstract boolean isImmediate()
```
    Gets whether this transform should be drawn immediately, or "burned in" at full resolution after the usual delay by a separate thread. It is recommended that most transforms not be immediate, unless they are fast to render and require frequent, high-priority updates (see OverlayTransform for one such example).
  - getParent
```
public DataTransform getParent()
```
    Gets the parent of this transform.
  - getName
```
public String getName()
```
    Gets the name of this transform.
  - getTransformId
```
public int getTransformId()
```
    Gets the data transform ID.
  - getLengths
```
public int[] getLengths()
```
    Gets length of each dimensional axis.
  - getDimTypes
```
public String[] getDimTypes()
```
    Gets string descriptors for each dimensional axis type. Common values include Time, Slice, Channel, Spectra and Lifetime.
  - canDisplay2D
```
public boolean canDisplay2D()
```
    Gets whether this data object can be displayed in 2D.
  - canDisplay3D
```
public boolean canDisplay3D()
```
    Gets whether this data object can be displayed in 3D.
  - getThumbHandler
```
public ThumbnailHandler getThumbHandler()
```
    Gets thumbnail handler for thumbnail-related operations.
  - getControls
```
public JComponent getControls()
```
    Gets associated GUI controls for this transform.
  - getHTMLDescription
```
public String getHTMLDescription()
```
    Gets a description of this transform, with HTML markup.
  - getLabels
```
public String[][] getLabels()
```
    Gets label for each dimensional position.
  - setFont
```
public void setFont(Font font)
```
    Sets the font used for this transform's text mappings.
  - getFont
```
public Font getFont()
```
    Gets the font used for this transform's text mappings.
  - displayChanged
```
public void displayChanged(DisplayEvent e)
```
    Whenever a display to which this transform is linked changes, the DisplayEvent is passed to this method so that the transform can adjust itself (i.e., is interactive).
  - addTransformListener
```
public void addTransformListener(TransformListener l)
```
    Adds the given listener to the list of listeners.
  - removeTransformListener
```
public void removeTransformListener(TransformListener l)
```
    Removes the given listener from the list of listeners.
  - notifyListeners
```
public void notifyListeners(TransformEvent e)
```
    Notifies transform listeners of a parameter change.
  - makeLabels
```
protected void makeLabels()
```
    Creates labels based on data transform parameters.
  - toString
```
public String toString()
```
    Gets a string representation of this transform.
    
    Overrides:
    
    toString in class Object
  - matches
```
public boolean matches(Dynamic dyn)
```
    Tests whether two dynamic objects are equivalent.
    
    Specified by:
    
    matches in interface Dynamic
  - isCompatible
```
public boolean isCompatible(Dynamic dyn)
```
    Tests whether the given dynamic object can be used as an argument to initState, for initializing this dynamic object.
    
    Specified by:
    
    isCompatible in interface Dynamic
  - initState
```
public void initState(Dynamic dyn)
```
    Modifies this object's state to match that of the given object. If the argument is null, the object is initialized according to its current state instead.
    
    Specified by:
    
    initState in interface Dynamic
  - discard
```
public void discard()
```
    Called when this object is being discarded in favor of another object with a matching state.
    
    Specified by:
    
    discard in interface Dynamic
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element (a child of "DataTransforms").
    
    Specified by:
    
    saveState in interface Saveable
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element (a child of "DataTransforms").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Throws:
    
    SaveException
  - getUnitDescription
```
public static String getUnitDescription(String dimType,
                                        int len)
```
    Gets the unit description for a dimensional type. For example, for dimensional type "Slice" the unit would be "focal plane," and for type "Channel" the unit would be "spectral channel."

Class DataTransform

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MU

nextId

parent

name

transformId

lengths

dims

labels

thumbs

font

listeners

Constructor Detail

DataTransform

DataTransform

Method Detail

getData

isValidDimension

getSuggestedMaps

getCacheId

isImmediate

getParent

getName

getTransformId

getLengths

getDimTypes

canDisplay2D

canDisplay3D

getThumbHandler

getControls

getHTMLDescription

getLabels

setFont

getFont

displayChanged

addTransformListener

removeTransformListener

notifyListeners

makeLabels

toString

matches

isCompatible

initState

discard

saveState

restoreState

getUnitDescription