mpicbg.imglib.type.label

Class BasePairBitType

java.lang.Object

mpicbg.imglib.type.TypeImpl<BasePairBitType>

mpicbg.imglib.type.label.BasePairBitType

All Implemented Interfaces:

Comparable<BasePairBitType>, BasePairType<BasePairBitType>, Type<BasePairBitType>

public class BasePairBitType
extends TypeImpl<BasePairBitType>
implements BasePairType<BasePairBitType>

TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasePairBitType.Base

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

i

Constructor Summary

Constructors

Constructor and Description
BasePairBitType()
BasePairBitType(BasePairBitType.Base value)
BasePairBitType(DirectAccessContainer<BasePairBitType,? extends BitAccess> bitStorage)

Method Summary

Modifier and Type	Method and Description
byte	baseToValue()
int	compareTo(BasePairBitType c)
void	complement()
BasePairBitType	copy() Creates a new Type which can only store one value but contains the value of this Type
BasePairBitType[]	createArray1D(int size1) Creates a 1d array of the generic Type
BasePairBitType[][]	createArray2D(int size1, int size2) Creates a 2d array of the generic Type
BasePairBitType[][][]	createArray3D(int size1, int size2, int size3) Creates a 3d array of the generic Type
DirectAccessContainer<BasePairBitType,? extends BitAccess>	createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory, int[] dim) The Type creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size.
BasePairBitType	createVariable() Creates a new Type which can only store one value.
void	decIndex() Decreases the array index, this is called by the Cursors which iterate over the image.
void	decIndex(int decrement) Decreases the index by increment steps, this is called by the Cursors which iterate over the image.
BasePairBitType	duplicateTypeOnSameDirectAccessContainer() Creates a new Type which stores in the same physical array.
BasePairBitType.Base	get()
Display<BasePairBitType>	getDefaultDisplay(Image<BasePairBitType> image) The Type creates the default Display for displaying the image contents.
int	getEntitiesPerPixel()
void	incIndex() Increases the array index, this is called by the Cursors which iterate over the image.
void	incIndex(int increment) Increases the index by increment steps, this is called by the Cursors which iterate over the image.
void	set(BasePairBitType.Base base)
void	set(BasePairBitType c) Sets the value of another Type.
String	toString()
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.
void	updateIndex(int i) Set the array position of the Type.

Methods inherited from class mpicbg.imglib.type.TypeImpl

getIndex

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

getIndex

Constructor Detail

BasePairBitType

public BasePairBitType(DirectAccessContainer<BasePairBitType,? extends BitAccess> bitStorage)

BasePairBitType

public BasePairBitType(BasePairBitType.Base value)

BasePairBitType

public BasePairBitType()

Method Detail

getEntitiesPerPixel

public int getEntitiesPerPixel()

Specified by:

getEntitiesPerPixel in interface Type<BasePairBitType>

createSuitableDirectAccessContainer

public DirectAccessContainer<BasePairBitType,? extends BitAccess> 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<BasePairBitType>

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<BasePairBitType>

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 BasePairBitType 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<BasePairBitType>

Returns:

- a new Type instance working on the same DirectAccessContainer

updateIndex

public void updateIndex(int i)

Description copied from interface: Type

Set the array position of the Type.

Specified by:

updateIndex in interface Type<BasePairBitType>

Overrides:

updateIndex in class TypeImpl<BasePairBitType>

Parameters:

i - - index value

incIndex

public void incIndex()

Description copied from interface: Type

Increases the array index, this is called by the Cursors which iterate over the image.

Specified by:

incIndex in interface Type<BasePairBitType>

Overrides:

incIndex in class TypeImpl<BasePairBitType>

incIndex

public void incIndex(int increment)

Description copied from interface: Type

Increases the index by increment steps, this is called by the Cursors which iterate over the image.

Specified by:

incIndex in interface Type<BasePairBitType>

Overrides:

incIndex in class TypeImpl<BasePairBitType>

Parameters:

increment - - how many steps

decIndex

public void decIndex()

Description copied from interface: Type

Decreases the array index, this is called by the Cursors which iterate over the image.

Specified by:

decIndex in interface Type<BasePairBitType>

Overrides:

decIndex in class TypeImpl<BasePairBitType>

decIndex

public void decIndex(int decrement)

Description copied from interface: Type

Decreases the index by increment steps, this is called by the Cursors which iterate over the image.

Specified by:

decIndex in interface Type<BasePairBitType>

Overrides:

decIndex in class TypeImpl<BasePairBitType>

getDefaultDisplay

public Display<BasePairBitType> getDefaultDisplay(Image<BasePairBitType> 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<BasePairBitType>

Parameters:

image - - the image to create the Display for

Returns:

the Display

set

public void set(BasePairBitType.Base base)

Specified by:

set in interface BasePairType<BasePairBitType>

get

public BasePairBitType.Base get()

Specified by:

get in interface BasePairType<BasePairBitType>

compareTo

public int compareTo(BasePairBitType c)

Specified by:

compareTo in interface Comparable<BasePairBitType>

complement

public void complement()

Specified by:

complement in interface BasePairType<BasePairBitType>

baseToValue

public byte baseToValue()

Specified by:

baseToValue in interface BasePairType<BasePairBitType>

set

public void set(BasePairBitType c)

Description copied from interface: Type

Sets the value of another Type.

Specified by:

set in interface Type<BasePairBitType>

Parameters:

c - - the new value

createArray1D

public BasePairBitType[] createArray1D(int size1)

Description copied from interface: Type

Creates a 1d array of the generic Type

Specified by:

createArray1D in interface Type<BasePairBitType>

Parameters:

size1 - - the size of the array

Returns:

- T[] array

createArray2D

public BasePairBitType[][] createArray2D(int size1,
                                         int size2)

Description copied from interface: Type

Creates a 2d array of the generic Type

Specified by:

createArray2D in interface Type<BasePairBitType>

Parameters:

size1 - - the size of the array

size2 - - the size of the array

Returns:

- T[][] array

createArray3D

public BasePairBitType[][][] 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<BasePairBitType>

Parameters:

size1 - - the size of the array

size2 - - the size of the array

size3 - - the size of the array

Returns:

- T[][][] array

createVariable

public BasePairBitType createVariable()

Description copied from interface: Type

Creates a new Type which can only store one value.

Specified by:

createVariable in interface Type<BasePairBitType>

Returns:

- a new Type instance

copy

public BasePairBitType 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<BasePairBitType>

Specified by:

copy in class TypeImpl<BasePairBitType>

Returns:

- a new Type instance

toString

public String toString()

Specified by:

toString in class TypeImpl<BasePairBitType>