CollapseTransform (LOCI Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Dynamic, Saveable
```
public class CollapseTransform
extends ImageTransform
```
CollapseTransform converts a dimensional axis into a series of range components.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`axis` Dimensional axis to collapse.
`protected CollapseWidget`	`controls` Controls for this dimensional collapse.
`protected RealType[]`	`range` Range display mappings.

Fields inherited from class loci.visbio.data.ImageTransform
MICRON, micronHeight, micronStep, micronWidth, xType, yType, zType

Fields inherited from class loci.visbio.data.DataTransform
dims, font, labels, lengths, listeners, MU, name, nextId, parent, thumbs, transformId

Constructor Summary

Constructors
Constructor and Description
`CollapseTransform()` Creates an uninitialized dimensional collapse.
`CollapseTransform(DataTransform parent, String name, int axis)` Creates a dimensional collapse from the given transform.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FlatField`	`collapse(FlatField[] fields, RealType[] types)` Collapses the given fields.
`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.
`Data`	`getData(TransformLink link, int[] pos, int dim, DataCache cache)` Retrieves the data corresponding to the given dimensional position, for the given display dimensionality.
`int`	`getImageHeight()` Gets height of each image.
`int`	`getImageWidth()` Gets width of each image.
`int`	`getRangeCount()` Gets number of range components at each pixel.
`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.
`static boolean`	`isParentRequired()` Indicates whether this transform type requires a parent transform.
`boolean`	`isValidDimension(int dim)` Gets whether this transform provides data of the given dimensionality.
`static boolean`	`isValidParent(DataTransform data)` Indicates whether this transform type would accept the given transform as its parent transform.
`static DataTransform`	`makeTransform(DataManager dm)` Creates a new dimensional collapse, with user interaction.
`boolean`	`matches(Dynamic dyn)` Tests whether two dynamic objects are equivalent.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("DimensionalCollapse").
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("DataTransforms").
`void`	`setParameters(int axis)` Assigns the parameters for this dimensional collapse.

Methods inherited from class loci.visbio.data.ImageTransform
canDisplay3D, getHTMLDescription, getImage, getImageUnits, getMicronHeight, getMicronStep, getMicronStep, getMicronWidth, getRangeTypes, getSuggestedMaps, getType, getXType, getYType, getZType, getZUnit, isImmediate

Methods inherited from class loci.visbio.data.DataTransform
addTransformListener, canDisplay2D, discard, displayChanged, getDimTypes, getFont, getLabels, getLengths, getName, getParent, getThumbHandler, getTransformId, getUnitDescription, makeLabels, notifyListeners, removeTransformListener, setFont, toString

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

- Field Detail
  - axis
```
protected int axis
```
    Dimensional axis to collapse.
  - range
```
protected RealType[] range
```
    Range display mappings.
  - controls
```
protected CollapseWidget controls
```
    Controls for this dimensional collapse.
- Constructor Detail
  - CollapseTransform
```
public CollapseTransform()
```
    Creates an uninitialized dimensional collapse.
  - CollapseTransform
```
public CollapseTransform(DataTransform parent,
                         String name,
                         int axis)
```
    Creates a dimensional collapse from the given transform.
- Method Detail
  - setParameters
```
public void setParameters(int axis)
```
    Assigns the parameters for this dimensional collapse.
  - getImageWidth
```
public int getImageWidth()
```
    Gets width of each image.
    
    Specified by:
    
    getImageWidth in class ImageTransform
  - getImageHeight
```
public int getImageHeight()
```
    Gets height of each image.
    
    Specified by:
    
    getImageHeight in class ImageTransform
  - getRangeCount
```
public int getRangeCount()
```
    Gets number of range components at each pixel.
    
    Specified by:
    
    getRangeCount in class ImageTransform
  - makeTransform
```
public static DataTransform makeTransform(DataManager dm)
```
    Creates a new dimensional collapse, with user interaction.
  - isValidParent
```
public static boolean isValidParent(DataTransform data)
```
    Indicates whether this transform type would accept the given transform as its parent transform.
  - isParentRequired
```
public static boolean isParentRequired()
```
    Indicates whether this transform type requires a parent transform.
  - getData
```
public Data getData(TransformLink link,
                    int[] pos,
                    int dim,
                    DataCache cache)
```
    Retrieves the data corresponding to the given dimensional position, for the given display dimensionality.
    
    Overrides:
    
    getData in class ImageTransform
    
    Returns:
    
    null if the transform does not provide data of that dimensionality
  - isValidDimension
```
public boolean isValidDimension(int dim)
```
    Gets whether this transform provides data of the given dimensionality.
    
    Specified by:
    
    isValidDimension in class DataTransform
  - getCacheId
```
public 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.
    
    Specified by:
    
    getCacheId in class DataTransform
  - getControls
```
public JComponent getControls()
```
    Gets associated GUI controls for this transform.
    
    Overrides:
    
    getControls in class DataTransform
  - matches
```
public boolean matches(Dynamic dyn)
```
    Tests whether two dynamic objects are equivalent.
    
    Specified by:
    
    matches in interface Dynamic
    
    Overrides:
    
    matches in class DataTransform
  - 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
    
    Overrides:
    
    isCompatible in class DataTransform
  - 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
    
    Overrides:
    
    initState in class DataTransform
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("DataTransforms").
    
    Specified by:
    
    saveState in interface Saveable
    
    Overrides:
    
    saveState in class ImageTransform
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("DimensionalCollapse").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Overrides:
    
    restoreState in class ImageTransform
    
    Throws:
    
    SaveException
  - collapse
```
public static FlatField collapse(FlatField[] fields,
                                 RealType[] types)
```
    Collapses the given fields.

Class CollapseTransform

Field Summary

Fields inherited from class loci.visbio.data.ImageTransform

Fields inherited from class loci.visbio.data.DataTransform

Constructor Summary

Method Summary

Methods inherited from class loci.visbio.data.ImageTransform

Methods inherited from class loci.visbio.data.DataTransform

Methods inherited from class java.lang.Object

Field Detail

axis

range

controls

Constructor Detail

CollapseTransform

CollapseTransform

Method Detail

setParameters

getImageWidth

getImageHeight

getRangeCount

makeTransform

isValidParent

isParentRequired

getData

isValidDimension

getCacheId

getControls

matches

isCompatible

initState

saveState

restoreState

collapse