BasicViewSetup (Fiji Javadocs 0-SNAPSHOT API)

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

Direct Known Subclasses:

ViewSetup, ViewSetupWrapper
```
public class BasicViewSetup
extends Entity
```
An view setup is an Entity that may have a name, image size, and voxel size.

Author:

Tobias Pietzsch <tobias.pietzsch@gmail.com>

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BasicViewSetup()`
	`BasicViewSetup(int id, String name, Dimensions size, VoxelDimensions voxelSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Entity> T`	`getAttribute(Class<T> attributeClass)`
`Map<String,Entity>`	`getAttributes()`
`String`	`getName()` Get the name of this setup.
`Dimensions`	`getSize()` Get the `Dimensions` of images from this setup.
`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()`.
`<T extends Entity> void`	`setAttribute(T attribute)`
`protected void`	`setAttributes(Map<String,Entity> attributes)`
`protected void`	`setName(String name)`
`protected void`	`setSize(Dimensions size)`
`protected void`	`setVoxelSize(VoxelDimensions voxelSize)`

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

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

Constructor Detail

BasicViewSetup

public BasicViewSetup(int id,
                      String name,
                      Dimensions size,
                      VoxelDimensions voxelSize)

BasicViewSetup
```
protected BasicViewSetup()
```

Method Detail
- hasName
```
public boolean hasName()
```
  Whether this setup has has a getName().
  
  Returns:
  
  true, if this setup has a name.
- getName
```
public String getName()
```
  Get the name of this setup.
  
  Returns:
  
  the name of this setup or null if it is not set.
- hasSize
```
public boolean hasSize()
```
  Whether this setup has has a getSize().
  
  Returns:
  
  true, if this setup has a size.
- getSize
```
public Dimensions getSize()
```
  Get the Dimensions of images from this setup.
  
  Returns:
  
  the Dimensions of images from this setup or null if it is not set.
- hasVoxelSize
```
public boolean hasVoxelSize()
```
  Whether this setup has has a getVoxelSize().
  
  Returns:
  
  true, if this setup has a voxel size.
- getVoxelSize
```
public VoxelDimensions getVoxelSize()
```
  Get the VoxelDimensions of images from this setup.
  
  Returns:
  
  The VoxelDimensions of images from this setup or null if it is not set.
- getAttributes
```
public Map<String,Entity> getAttributes()
```
- getAttribute
```
public <T extends Entity> T getAttribute(Class<T> attributeClass)
```
- setAttribute
```
public <T extends Entity> void setAttribute(T attribute)
```
- setName
```
protected void setName(String name)
```
- setSize
```
protected void setSize(Dimensions size)
```
- setVoxelSize
```
protected void setVoxelSize(VoxelDimensions voxelSize)
```
- setAttributes
```
protected void setAttributes(Map<String,Entity> attributes)
```

Class BasicViewSetup

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

BasicViewSetup

BasicViewSetup

Method Detail

hasName

getName

hasSize

getSize

hasVoxelSize

getVoxelSize

getAttributes

getAttribute

setAttribute

setName

setSize

setVoxelSize

setAttributes