Type (Fiji Javadocs 0-SNAPSHOT API)

Type Parameters:

T - - the specialized version

All Known Subinterfaces:

BasePairType<T>, BooleanType<T>, ComplexType<T>, ExponentialMathType<T>, IntegerType<T>, NumericType<T>, RealType<T>

All Known Implementing Classes:

BasePairBitType, BasePairCharType, BitType, ByteType, ComplexDoubleType, ComplexFloatType, ComplexTypeImpl, DoubleType, FakeType, FloatType, GenericByteType, GenericIntType, GenericShortType, IntegerTypeImpl, IntType, LabelingType, LongType, RealTypeImpl, RGBALegacyType, ShortType, TypeImpl, Unsigned12BitType, UnsignedByteType, UnsignedIntType, UnsignedShortType
```
public interface Type<T extends Type<T>>
```
The Type class is responsible for computing. It can be instaniated as a variable holding one single value only or with a DirectAccessContainer. There is no differentiation between the two cases except for the constructor to avoid double implementations. The Type is the only class that is aware of the actual data type, i.e. which basic type (DataAccess) is used to store the data. On the other hand it does not know the storage type (Array, Cursor, ...). This is not necessary for computation and avoid complicated re-implementations. The method public void updateDataArray( Cursor c ); links the DirectAccessContainer and the cursor which define the current position as well as the current storage array.

Author:

Stephan Preibisch, Stephan Saalfeld

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`T[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`T[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`T[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<T,?>`	`createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory, int[] dim)` The `Type` creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size.
`T`	`createVariable()` Creates a new `Type` which can only store one value.
`void`	`decIndex()` Decreases the array index, this is called by the `Cursor`s which iterate over the image.
`void`	`decIndex(int decrement)` Decreases the index by increment steps, this is called by the `Cursor`s which iterate over the image.
`T`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`Display<T>`	`getDefaultDisplay(Image<T> image)` The `Type` creates the default `Display` for displaying the image contents.
`int`	`getEntitiesPerPixel()`
`int`	`getIndex()` Returns the current index in the storage array, this is called by the `Cursor`s which iterate over the image.
`void`	`incIndex()` Increases the array index, this is called by the `Cursor`s which iterate over the image.
`void`	`incIndex(int increment)` Increases the index by increment steps, this is called by the `Cursor`s which iterate over the image.
`void`	`set(T c)` Sets the value of another `Type`.
`void`	`updateContainer(Cursor<?> c)` This method is used by the `Cursor`s to update the data current data array of the `Type`, for example when moving from one `Cell` to the next.
`void`	`updateIndex(int i)` Set the array position of the `Type`.

- Method Detail
  - getEntitiesPerPixel
```
int getEntitiesPerPixel()
```
  - createSuitableDirectAccessContainer
```
DirectAccessContainer<T,?> createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory,
                                                               int[] dim)
```
    The Type creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size. It basically only decides here which BasicType it uses (float, int, byte, bit, ...) and how many entities per pixel it needs (e.g. 2 floats per pixel for a complex number). This enables the separation of Image and the basic types.
    
    Parameters:
    
    storageFactory - - Which storage strategy is used
    
    dim - - the dimensions
    
    Returns:
    
    - the instantiated DirectAccessContainer where only the Type knowns the BasicType it contains.
  - getDefaultDisplay
```
Display<T> getDefaultDisplay(Image<T> image)
```
    The Type creates the default Display for displaying the image contents. Only Type can do this as in Image the Type is only a Generic. Later the user can create its own Displays if wanted. This could be basically a static function.
    
    Parameters:
    
    image - - the image to create the Display for
    
    Returns:
    
    the Display
  - updateContainer
```
void updateContainer(Cursor<?> c)
```
    This method is used by the Cursors to update the data current data array of the Type, for example when moving from one Cell to the next. If it is only an Array the Cursors never have to call that function. The idea behind this concept is maybe not obvious. The Type knows which basic type is used (float, int, byte, ...) but does not know how it is stored (Array, CellDirectAccessContainer, ...) to prevent multiple implementations of Type. That's why Type asks the DataAccess to give the actual basic array by passing the Cursor that calls the method. The DataAccess is also an Array, CellDirectAccessContainer, ... which can then communicate with the ArrayCursor, CellCursor, ... and return the current basic type array. A typical implementation of this method looks like that (this is the FloatType implementation): float[] v = floatStorage.getCurrentStorageArray( c );
    
    Parameters:
    
    c - - the Cursor gives a link to itself so that the Type tell its DataAccess to get the new basic type array.
  - updateIndex
```
void updateIndex(int i)
```
    Set the array position of the Type.
    
    Parameters:
    
    i - - index value
  - getIndex
```
int getIndex()
```
    Returns the current index in the storage array, this is called by the Cursors which iterate over the image.
    
    Returns:
    
    - int index
  - incIndex
```
void incIndex()
```
    Increases the array index, this is called by the Cursors which iterate over the image.
  - incIndex
```
void incIndex(int increment)
```
    Increases the index by increment steps, this is called by the Cursors which iterate over the image.
    
    Parameters:
    
    increment - - how many steps
  - decIndex
```
void decIndex()
```
    Decreases the array index, this is called by the Cursors which iterate over the image.
  - decIndex
```
void decIndex(int decrement)
```
    Decreases the index by increment steps, this is called by the Cursors which iterate over the image.
    
    Parameters:
    
    increment - - how many steps
  - createVariable
```
T createVariable()
```
    Creates a new Type which can only store one value.
    
    Returns:
    
    - a new Type instance
  - copy
```
T copy()
```
    Creates a new Type which can only store one value but contains the value of this Type
    
    Returns:
    
    - a new Type instance
  - duplicateTypeOnSameDirectAccessContainer
```
T duplicateTypeOnSameDirectAccessContainer()
```
    Creates a new Type which stores in the same physical array. This is only used internally.
    
    Returns:
    
    - a new Type instance working on the same DirectAccessContainer
  - set
```
void set(T c)
```
    Sets the value of another Type.
    
    Parameters:
    
    c - - the new value
  - createArray1D
```
T[] createArray1D(int size1)
```
    Creates a 1d array of the generic Type
    
    Parameters:
    
    size1 - - the size of the array
    
    Returns:
    
    - T[] array
  - createArray2D
```
T[][] createArray2D(int size1,
                    int size2)
```
    Creates a 2d array of the generic Type
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    Returns:
    
    - T[][] array
  - createArray3D
```
T[][][] createArray3D(int size1,
                      int size2,
                      int size3)
```
    Creates a 3d array of the generic Type
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    size3 - - the size of the array
    
    Returns:
    
    - T[][][] array

Interface Type<T extends Type<T>>

Method Summary

Method Detail

getEntitiesPerPixel

createSuitableDirectAccessContainer

getDefaultDisplay

updateContainer

updateIndex

getIndex

incIndex

incIndex

decIndex

decIndex

createVariable

copy

duplicateTypeOnSameDirectAccessContainer

set

createArray1D

createArray2D

createArray3D