ViewSetup (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.spim.data.generic.base.Entity
- - mpicbg.spim.data.generic.sequence.BasicViewSetup
  - - mpicbg.spim.data.sequence.ViewSetup

All Implemented Interfaces:

Comparable<ViewSetup>
```
public class ViewSetup
extends BasicViewSetup
implements Comparable<ViewSetup>
```
A collection of parameters describing the setup for a particular stack coming from a SPIM microscope (angle, illumination direction, etc). A ViewSetup is a BasicViewSetup that must have a channel, angle, and illumination direction.

Author:

Tobias Pietzsch <tobias.pietzsch@gmail.com>, Stephan Preibisch (stephan.preibisch@gmx.de)

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`angleAttributeKey`
`protected static String`	`channelAttributeKey`
`protected static String`	`illuminationAttributeKey`
`protected static String`	`tileAttributeKey`

Constructor Summary

Constructors
Constructor and Description
`ViewSetup(int id, String name, Dimensions size, VoxelDimensions voxelSize, Channel channel, Angle angle, Illumination illumination)` TODO
`ViewSetup(int id, String name, Dimensions size, VoxelDimensions voxelSize, Tile tile, Channel channel, Angle angle, Illumination illumination)` TODO

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ViewSetup o)` Compares the `ids`.
`Angle`	`getAngle()` Get stage rotation `Angle`.
`Channel`	`getChannel()` Get the `Channel`.
`int`	`getId()` Get the unique id of this `ViewSetup`.
`Illumination`	`getIllumination()` Get the `Illumination` direction.
`String`	`getName()` Get the name of this setup.
`Dimensions`	`getSize()` Get the `Dimensions` of images from this setup.
`Tile`	`getTile()` Get the `Tile`.
`VoxelDimensions`	`getVoxelSize()` Get the `VoxelDimensions` of images from this setup.
`boolean`	`hasName()` Whether this setup has has a `getName()`.
`boolean`	`hasSize()` Whether this setup has has a `getSize()`.
`boolean`	`hasVoxelSize()` Whether this setup has has a `getVoxelSize()`.
`protected void`	`setAngle(Angle angle)` Set the rotation `Angle`
`protected void`	`setAttributes(Map<String,Entity> attributes)` Set the attributes map.
`protected void`	`setChannel(Channel channel)` Set the `Channel`.
`protected void`	`setIllumination(Illumination illumination)` Set the `Illumination` direction.
`void`	`setSize(Dimensions size)` Set the `Dimensions` of images from this setup.
`protected void`	`setTile(Tile tile)` Set the `Tile`.
`void`	`setVoxelSize(VoxelDimensions voxelSize)` Set the `VoxelDimensions` of images from this setup.

Methods inherited from class mpicbg.spim.data.generic.sequence.BasicViewSetup
getAttribute, getAttributes, setAttribute, setName

Methods inherited from class mpicbg.spim.data.generic.base.Entity
equals, hashCode, idMap, sortById

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

- Field Detail
  - tileAttributeKey
```
protected static String tileAttributeKey
```
  - channelAttributeKey
```
protected static String channelAttributeKey
```
  - angleAttributeKey
```
protected static String angleAttributeKey
```
  - illuminationAttributeKey
```
protected static String illuminationAttributeKey
```
- Constructor Detail
  - ViewSetup
```
public ViewSetup(int id,
                 String name,
                 Dimensions size,
                 VoxelDimensions voxelSize,
                 Tile tile,
                 Channel channel,
                 Angle angle,
                 Illumination illumination)
```
    TODO
    
    Parameters:
    
    id -
    
    name -
    
    size -
    
    voxelSize -
    
    channel -
    
    angle -
    
    illumination -
  - ViewSetup
```
public ViewSetup(int id,
                 String name,
                 Dimensions size,
                 VoxelDimensions voxelSize,
                 Channel channel,
                 Angle angle,
                 Illumination illumination)
```
    TODO
    
    Parameters:
    
    id -
    
    name -
    
    size -
    
    voxelSize -
    
    channel -
    
    angle -
    
    illumination -
- Method Detail
  - getId
```
public int getId()
```
    Get the unique id of this ViewSetup.
    
    Overrides:
    
    getId in class Entity
    
    Returns:
    
    unique id.
  - hasName
```
public boolean hasName()
```
    Whether this setup has has a getName().
    
    Overrides:
    
    hasName in class BasicViewSetup
    
    Returns:
    
    true, if this setup has a name.
  - getName
```
public String getName()
```
    Get the name of this setup.
    
    Overrides:
    
    getName in class BasicViewSetup
    
    Returns:
    
    the name of this setup or null if it is not set.
  - hasSize
```
public boolean hasSize()
```
    Whether this setup has has a getSize().
    
    Overrides:
    
    hasSize in class BasicViewSetup
    
    Returns:
    
    true, if this setup has a size.
  - getSize
```
public Dimensions getSize()
```
    Get the Dimensions of images from this setup.
    
    Overrides:
    
    getSize in class BasicViewSetup
    
    Returns:
    
    the Dimensions of images from this setup or null if it is not set.
  - setSize
```
public void setSize(Dimensions size)
```
    Set the Dimensions of images from this setup.
    
    Overrides:
    
    setSize in class BasicViewSetup
  - hasVoxelSize
```
public boolean hasVoxelSize()
```
    Whether this setup has has a getVoxelSize().
    
    Overrides:
    
    hasVoxelSize in class BasicViewSetup
    
    Returns:
    
    true, if this setup has a voxel size.
  - getVoxelSize
```
public VoxelDimensions getVoxelSize()
```
    Get the VoxelDimensions of images from this setup.
    
    Overrides:
    
    getVoxelSize in class BasicViewSetup
    
    Returns:
    
    The VoxelDimensions of images from this setup or null if it is not set.
  - setVoxelSize
```
public void setVoxelSize(VoxelDimensions voxelSize)
```
    Set the VoxelDimensions of images from this setup.
    
    Overrides:
    
    setVoxelSize in class BasicViewSetup
  - getTile
```
public Tile getTile()
```
    Get the Tile.
    
    Returns:
    
    the tile
  - setTile
```
protected void setTile(Tile tile)
```
    Set the Tile.
    
    Parameters:
    
    tile - the tile
  - getChannel
```
public Channel getChannel()
```
    Get the Channel.
    
    Returns:
    
    the channel
  - setChannel
```
protected void setChannel(Channel channel)
```
    Set the Channel.
    
    Parameters:
    
    channel - the channel
  - getAngle
```
public Angle getAngle()
```
    Get stage rotation Angle.
    
    Returns:
    
    the angle.
  - setAngle
```
protected void setAngle(Angle angle)
```
    Set the rotation Angle
    
    Parameters:
    
    angle - the angle.
  - getIllumination
```
public Illumination getIllumination()
```
    Get the Illumination direction.
    
    Returns:
    
    the illumination direction
  - setIllumination
```
protected void setIllumination(Illumination illumination)
```
    Set the Illumination direction.
    
    Parameters:
    
    illumination - the illumination direction
  - compareTo
```
public int compareTo(ViewSetup o)
```
    Compares the ids.
    
    Specified by:
    
    compareTo in interface Comparable<ViewSetup>
  - setAttributes
```
protected void setAttributes(Map<String,Entity> attributes)
```
    Set the attributes map. And set the individual angle, channel, and illumination fields.
    
    Overrides:
    
    setAttributes in class BasicViewSetup

Class ViewSetup

Field Summary

Constructor Summary

Method Summary

Methods inherited from class mpicbg.spim.data.generic.sequence.BasicViewSetup

Methods inherited from class mpicbg.spim.data.generic.base.Entity

Methods inherited from class java.lang.Object

Field Detail

tileAttributeKey

channelAttributeKey

angleAttributeKey

illuminationAttributeKey

Constructor Detail

ViewSetup

ViewSetup

Method Detail

getId

hasName

getName

hasSize

getSize

setSize

hasVoxelSize

getVoxelSize

setVoxelSize

getTile

setTile

getChannel

setChannel

getAngle

setAngle

getIllumination

setIllumination

compareTo

setAttributes