DataSampling (LOCI Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

Dynamic, Saveable
```
public class DataSampling
extends ImageTransform
```
DataSampling is a resampling of another transform.

Field Summary

Fields
Modifier and Type	Field and Description
`protected SamplingWidget`	`controls` Controls for this data sampling.
`protected int[]`	`max` Maximum index value for each dimension.
`protected int[]`	`min` Minimum index value for each dimension.
`protected int`	`numRange` Range component count for each image.
`protected boolean[]`	`range` List of included range components.
`protected int`	`resX` Width of each image.
`protected int`	`resY` Height of each image.
`protected int[]`	`step` Index step value for each dimension.

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
`DataSampling()` Creates an uninitialized data sampling.
`DataSampling(DataTransform parent, String name, int[] min, int[] max, int[] step, int resX, int resY, boolean[] range)` Creates a data sampling from the given transform.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`String`	`getHTMLDescription()` Gets a description of this transform, with HTML markup.
`BufferedImage`	`getImage(int[] pos)` Obtains an image from the source(s) at the given dimensional position.
`int`	`getImageHeight()` Gets height of each image.
`int`	`getImageWidth()` Gets width of each image.
`int[]`	`getMax()` Gets maximum dimensional index values.
`double`	`getMicronStep(int axis)` Gets the physical distance between image planes in microns for the given axis.
`int[]`	`getMin()` Gets minimum dimensional index values.
`boolean[]`	`getRange()` Gets included range components.
`int`	`getRangeCount()` Gets number of range components at each pixel.
`int[]`	`getStep()` Gets dimensional index step values.
`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.
`protected void`	`makeLabels()` Creates labels based on data transform parameters.
`static DataTransform`	`makeTransform(DataManager dm)` Creates a new data sampling, 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 ("DataSampling").
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("DataTransforms").
`void`	`setParameters(int[] min, int[] max, int[] step, int resX, int resY, boolean[] range)` Assigns the parameters for this data sampling.

Methods inherited from class loci.visbio.data.ImageTransform
canDisplay3D, getData, getImageUnits, getMicronHeight, 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, notifyListeners, removeTransformListener, setFont, toString

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

- Field Detail
  - min
```
protected int[] min
```
    Minimum index value for each dimension.
  - max
```
protected int[] max
```
    Maximum index value for each dimension.
  - step
```
protected int[] step
```
    Index step value for each dimension.
  - resX
```
protected int resX
```
    Width of each image.
  - resY
```
protected int resY
```
    Height of each image.
  - range
```
protected boolean[] range
```
    List of included range components.
  - numRange
```
protected int numRange
```
    Range component count for each image.
  - controls
```
protected SamplingWidget controls
```
    Controls for this data sampling.
- Constructor Detail
  - DataSampling
```
public DataSampling()
```
    Creates an uninitialized data sampling.
  - DataSampling
```
public DataSampling(DataTransform parent,
                    String name,
                    int[] min,
                    int[] max,
                    int[] step,
                    int resX,
                    int resY,
                    boolean[] range)
```
    Creates a data sampling from the given transform.
- Method Detail
  - setParameters
```
public void setParameters(int[] min,
                          int[] max,
                          int[] step,
                          int resX,
                          int resY,
                          boolean[] range)
```
    Assigns the parameters for this data sampling.
  - getMin
```
public int[] getMin()
```
    Gets minimum dimensional index values.
  - getMax
```
public int[] getMax()
```
    Gets maximum dimensional index values.
  - getStep
```
public int[] getStep()
```
    Gets dimensional index step values.
  - getRange
```
public boolean[] getRange()
```
    Gets included range components.
  - 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
  - getImage
```
public BufferedImage getImage(int[] pos)
```
    Obtains an image from the source(s) at the given dimensional position.
    
    Overrides:
    
    getImage in class ImageTransform
  - getMicronStep
```
public double getMicronStep(int axis)
```
    Gets the physical distance between image planes in microns for the given axis.
    
    Overrides:
    
    getMicronStep in class ImageTransform
  - makeTransform
```
public static DataTransform makeTransform(DataManager dm)
```
    Creates a new data sampling, 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.
  - 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
  - getHTMLDescription
```
public String getHTMLDescription()
```
    Gets a description of this transform, with HTML markup.
    
    Overrides:
    
    getHTMLDescription in class ImageTransform
  - makeLabels
```
protected void makeLabels()
```
    Creates labels based on data transform parameters.
    
    Overrides:
    
    makeLabels 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 ("DataSampling").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Overrides:
    
    restoreState in class ImageTransform
    
    Throws:
    
    SaveException

Class DataSampling

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

min

max

step

resX

resY

range

numRange

controls

Constructor Detail

DataSampling

DataSampling

Method Detail

setParameters

getMin

getMax

getStep

getRange

getImageWidth

getImageHeight

getRangeCount

getImage

getMicronStep

makeTransform

isValidParent

isParentRequired

isValidDimension

getCacheId

getControls

getHTMLDescription

makeLabels

matches

isCompatible

initState

saveState

restoreState