BasePairCharType (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.type.TypeImpl<BasePairCharType>
- - mpicbg.imglib.type.label.BasePairCharType

All Implemented Interfaces:

Comparable<BasePairCharType>, BasePairType<BasePairCharType>, Type<BasePairCharType>
```
public class BasePairCharType
extends TypeImpl<BasePairCharType>
implements BasePairType<BasePairCharType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary
- Fields inherited from class mpicbg.imglib.type.TypeImpl
  i

Constructor Summary

Constructors
Constructor and Description
`BasePairCharType()`
`BasePairCharType(BasePairBitType.Base value)`
`BasePairCharType(char value)`
`BasePairCharType(DirectAccessContainer<BasePairCharType,? extends CharAccess> charStorage)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte`	`baseToValue()`
`int`	`compareTo(BasePairCharType c)`
`void`	`complement()`
`BasePairCharType`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`BasePairCharType[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`BasePairCharType[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`BasePairCharType[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<BasePairCharType,? extends CharAccess>`	`createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory, int[] dim)` The `Type` creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size.
`BasePairCharType`	`createVariable()` Creates a new `Type` which can only store one value.
`BasePairCharType`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`BasePairBitType.Base`	`get()`
`char`	`getChar()`
`BasePairTypeDisplay<BasePairCharType>`	`getDefaultDisplay(Image<BasePairCharType> image)` The `Type` creates the default `Display` for displaying the image contents.
`int`	`getEntitiesPerPixel()`
`void`	`set(BasePairBitType.Base base)`
`void`	`set(BasePairCharType c)` Sets the value of another `Type`.
`void`	`setChar(char f)`
`String`	`toString()`
`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.

Methods inherited from class mpicbg.imglib.type.TypeImpl
decIndex, decIndex, getIndex, incIndex, incIndex, updateIndex

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

Methods inherited from interface mpicbg.imglib.type.Type
decIndex, decIndex, getIndex, incIndex, incIndex, updateIndex

- Constructor Detail
  - BasePairCharType
```
public BasePairCharType(DirectAccessContainer<BasePairCharType,? extends CharAccess> charStorage)
```
  - BasePairCharType
```
public BasePairCharType(BasePairBitType.Base value)
```
  - BasePairCharType
```
public BasePairCharType(char value)
```
  - BasePairCharType
```
public BasePairCharType()
```
- Method Detail
  - getEntitiesPerPixel
```
public int getEntitiesPerPixel()
```
    Specified by:
    
    getEntitiesPerPixel in interface Type<BasePairCharType>
  - createSuitableDirectAccessContainer
```
public DirectAccessContainer<BasePairCharType,? extends CharAccess> createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory,
                                                                                                        int[] dim)
```
    Description copied from interface: Type
    
    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.
    
    Specified by:
    
    createSuitableDirectAccessContainer in interface Type<BasePairCharType>
    
    Parameters:
    
    storageFactory - - Which storage strategy is used
    
    dim - - the dimensions
    
    Returns:
    
    - the instantiated DirectAccessContainer where only the Type knowns the BasicType it contains.
  - updateContainer
```
public void updateContainer(Cursor<?> c)
```
    Description copied from interface: Type
    
    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 );
    
    Specified by:
    
    updateContainer in interface Type<BasePairCharType>
    
    Parameters:
    
    c - - the Cursor gives a link to itself so that the Type tell its DataAccess to get the new basic type array.
  - duplicateTypeOnSameDirectAccessContainer
```
public BasePairCharType duplicateTypeOnSameDirectAccessContainer()
```
    Description copied from interface: Type
    
    Creates a new Type which stores in the same physical array. This is only used internally.
    
    Specified by:
    
    duplicateTypeOnSameDirectAccessContainer in interface Type<BasePairCharType>
    
    Returns:
    
    - a new Type instance working on the same DirectAccessContainer
  - getDefaultDisplay
```
public BasePairTypeDisplay<BasePairCharType> getDefaultDisplay(Image<BasePairCharType> image)
```
    Description copied from interface: Type
    
    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.
    
    Specified by:
    
    getDefaultDisplay in interface Type<BasePairCharType>
    
    Parameters:
    
    image - - the image to create the Display for
    
    Returns:
    
    the Display
  - getChar
```
public char getChar()
```
  - setChar
```
public void setChar(char f)
```
  - set
```
public void set(BasePairBitType.Base base)
```
    Specified by:
    
    set in interface BasePairType<BasePairCharType>
  - get
```
public BasePairBitType.Base get()
```
    Specified by:
    
    get in interface BasePairType<BasePairCharType>
  - set
```
public void set(BasePairCharType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<BasePairCharType>
    
    Parameters:
    
    c - - the new value
  - compareTo
```
public int compareTo(BasePairCharType c)
```
    Specified by:
    
    compareTo in interface Comparable<BasePairCharType>
  - complement
```
public void complement()
```
    Specified by:
    
    complement in interface BasePairType<BasePairCharType>
  - baseToValue
```
public byte baseToValue()
```
    Specified by:
    
    baseToValue in interface BasePairType<BasePairCharType>
  - createArray1D
```
public BasePairCharType[] createArray1D(int size1)
```
    Description copied from interface: Type
    
    Creates a 1d array of the generic Type
    
    Specified by:
    
    createArray1D in interface Type<BasePairCharType>
    
    Parameters:
    
    size1 - - the size of the array
    
    Returns:
    
    - T[] array
  - createArray2D
```
public BasePairCharType[][] createArray2D(int size1,
                                          int size2)
```
    Description copied from interface: Type
    
    Creates a 2d array of the generic Type
    
    Specified by:
    
    createArray2D in interface Type<BasePairCharType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    Returns:
    
    - T[][] array
  - createArray3D
```
public BasePairCharType[][][] createArray3D(int size1,
                                            int size2,
                                            int size3)
```
    Description copied from interface: Type
    
    Creates a 3d array of the generic Type
    
    Specified by:
    
    createArray3D in interface Type<BasePairCharType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    size3 - - the size of the array
    
    Returns:
    
    - T[][][] array
  - createVariable
```
public BasePairCharType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<BasePairCharType>
    
    Returns:
    
    - a new Type instance
  - copy
```
public BasePairCharType copy()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value but contains the value of this Type
    
    Specified by:
    
    copy in interface Type<BasePairCharType>
    
    Specified by:
    
    copy in class TypeImpl<BasePairCharType>
    
    Returns:
    
    - a new Type instance
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class TypeImpl<BasePairCharType>

Class BasePairCharType

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

Constructor Summary

Method Summary

Methods inherited from class mpicbg.imglib.type.TypeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.imglib.type.Type

Constructor Detail

BasePairCharType

BasePairCharType

BasePairCharType

BasePairCharType

Method Detail

getEntitiesPerPixel

createSuitableDirectAccessContainer

updateContainer

duplicateTypeOnSameDirectAccessContainer

getDefaultDisplay

getChar

setChar

set

get

set

compareTo

complement

baseToValue

createArray1D

createArray2D

createArray3D

createVariable

copy

toString