ArbitrarySlice (LOCI Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

TransformListener, Dynamic, Saveable
```
public class ArbitrarySlice
extends DataTransform
implements TransformListener
```
A transform for slicing a stack of images in 3D.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`axis` Dimensional axis to slice through.
`protected boolean`	`compute` Flag indicating whether arbitrary slice should actually be computed.
`protected SliceWidget`	`controls` Controls for the arbitrary slice.
`protected float`	`loc` Arbitrary slice's location along slicing line.
`protected float`	`pitch` Vertical rotatational angle of slicing line.
`protected int`	`res` Resolution of arbitrary slice.
`protected boolean`	`showLine` Flag indicating whether slicing line should be shown.
`protected float`	`yaw` Horizontal rotational angle of slicing line.

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
`ArbitrarySlice()` Creates an uninitialized arbitrary slice.
`ArbitrarySlice(DataTransform parent, String name)` Creates an overlay object for the given transform.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAxis()` Gets the axis through which to slice.
`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.
`float`	`getLocation()` Gets the location for the arbitrary slice.
`float`	`getPitch()` Gets the pitch for the slicing line.
`int`	`getResolution()` Gets the resolution for the slicing line.
`ScalarMap[]`	`getSuggestedMaps()` Retrieves a set of mappings for displaying this transform effectively.
`float`	`getYaw()` Gets the yaw for the slicing line.
`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.
`boolean`	`isImmediate()` Arbitrary slices are rendered immediately, due to frequent user interaction.
`boolean`	`isLineVisible()` Gets whether slicing line is shown.
`static boolean`	`isParentRequired()` Indicates whether this transform type requires a parent transform.
`boolean`	`isSliceComputed()` Gets whether arbitary slice is computed.
`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 set of overlays, 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 ("ArbitrarySlice").
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("DataTransforms").
`void`	`setAxis(int axis)` Sets the axis through which to slice.
`void`	`setLineVisible(boolean showLine)` Sets whether white line is shown.
`void`	`setLocation(float loc)` Sets the location for the arbitrary slice.
`void`	`setParameters(int axis, float yaw, float pitch, float loc, int res, boolean showLine, boolean compute)` Sets the parameters for the arbitrary slice, recomputing the slice if the compute flag is set.
`void`	`setPitch(float pitch)` Sets the pitch for the slicing line.
`void`	`setResolution(int res)` Sets the resolution for the slicing line.
`void`	`setSliceComputed(boolean compute)` Sets whether arbitrary slice is computed.
`void`	`setYaw(float yaw)` Sets the yaw for the slicing line.
`void`	`transformChanged(TransformEvent e)` Called when parent data transform's parameters are updated.

Methods inherited from class loci.visbio.data.DataTransform
addTransformListener, canDisplay2D, canDisplay3D, discard, displayChanged, getDimTypes, getFont, getHTMLDescription, 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 slice through.
  - yaw
```
protected float yaw
```
    Horizontal rotational angle of slicing line.
  - pitch
```
protected float pitch
```
    Vertical rotatational angle of slicing line.
  - loc
```
protected float loc
```
    Arbitrary slice's location along slicing line.
  - res
```
protected int res
```
    Resolution of arbitrary slice.
  - showLine
```
protected boolean showLine
```
    Flag indicating whether slicing line should be shown.
  - compute
```
protected boolean compute
```
    Flag indicating whether arbitrary slice should actually be computed.
  - controls
```
protected SliceWidget controls
```
    Controls for the arbitrary slice.
- Constructor Detail
  - ArbitrarySlice
```
public ArbitrarySlice()
```
    Creates an uninitialized arbitrary slice.
  - ArbitrarySlice
```
public ArbitrarySlice(DataTransform parent,
                      String name)
```
    Creates an overlay object for the given transform.
- Method Detail
  - setParameters
```
public void setParameters(int axis,
                          float yaw,
                          float pitch,
                          float loc,
                          int res,
                          boolean showLine,
                          boolean compute)
```
    Sets the parameters for the arbitrary slice, recomputing the slice if the compute flag is set.
  - setAxis
```
public void setAxis(int axis)
```
    Sets the axis through which to slice.
  - setYaw
```
public void setYaw(float yaw)
```
    Sets the yaw for the slicing line.
  - setPitch
```
public void setPitch(float pitch)
```
    Sets the pitch for the slicing line.
  - setLocation
```
public void setLocation(float loc)
```
    Sets the location for the arbitrary slice.
  - setResolution
```
public void setResolution(int res)
```
    Sets the resolution for the slicing line.
  - setLineVisible
```
public void setLineVisible(boolean showLine)
```
    Sets whether white line is shown.
  - setSliceComputed
```
public void setSliceComputed(boolean compute)
```
    Sets whether arbitrary slice is computed.
  - getAxis
```
public int getAxis()
```
    Gets the axis through which to slice.
  - getYaw
```
public float getYaw()
```
    Gets the yaw for the slicing line.
  - getPitch
```
public float getPitch()
```
    Gets the pitch for the slicing line.
  - getLocation
```
public float getLocation()
```
    Gets the location for the arbitrary slice.
  - getResolution
```
public int getResolution()
```
    Gets the resolution for the slicing line.
  - isLineVisible
```
public boolean isLineVisible()
```
    Gets whether slicing line is shown.
  - isSliceComputed
```
public boolean isSliceComputed()
```
    Gets whether arbitary slice is computed.
  - makeTransform
```
public static DataTransform makeTransform(DataManager dm)
```
    Creates a new set of overlays, 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.
    
    Specified by:
    
    getData in class DataTransform
    
    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
  - getSuggestedMaps
```
public ScalarMap[] getSuggestedMaps()
```
    Retrieves a set of mappings for displaying this transform effectively.
    
    Specified by:
    
    getSuggestedMaps 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
  - isImmediate
```
public boolean isImmediate()
```
    Arbitrary slices are rendered immediately, due to frequent user interaction.
    
    Specified by:
    
    isImmediate 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 DataTransform
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("ArbitrarySlice").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Overrides:
    
    restoreState in class DataTransform
    
    Throws:
    
    SaveException
  - transformChanged
```
public void transformChanged(TransformEvent e)
```
    Called when parent data transform's parameters are updated.
    
    Specified by:
    
    transformChanged in interface TransformListener

Class ArbitrarySlice

Field Summary

Fields inherited from class loci.visbio.data.DataTransform

Constructor Summary

Method Summary

Methods inherited from class loci.visbio.data.DataTransform

Methods inherited from class java.lang.Object

Field Detail

axis

yaw

pitch

loc

res

showLine

compute

controls

Constructor Detail

ArbitrarySlice

ArbitrarySlice

Method Detail

setParameters

setAxis

setYaw

setPitch

setLocation

setResolution

setLineVisible

setSliceComputed

getAxis

getYaw

getPitch

getLocation

getResolution

isLineVisible

isSliceComputed

makeTransform

isValidParent

isParentRequired

getData

isValidDimension

getSuggestedMaps

getCacheId

isImmediate

getControls

matches

isCompatible

initState

saveState

restoreState

transformChanged