BitType (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.type.TypeImpl<T>
- - mpicbg.imglib.type.numeric.complex.ComplexTypeImpl<T>
  - - mpicbg.imglib.type.numeric.real.RealTypeImpl<T>
    - - mpicbg.imglib.type.numeric.integer.IntegerTypeImpl<BitType>
      - mpicbg.imglib.type.logic.BitType

All Implemented Interfaces:

Comparable<BitType>, BooleanType<BitType>, ComplexType<BitType>, IntegerType<BitType>, NumericType<BitType>, RealType<BitType>, Type<BitType>
```
public class BitType
extends IntegerTypeImpl<BitType>
implements BooleanType<BitType>, RealType<BitType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

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

Constructor Summary

Constructors
Constructor and Description

BitType()

BitType(boolean value)

BitType(DirectAccessContainer<BitType,? extends BitAccess> bitStorage)

Constructors
Constructor and Description
`BitType()`
`BitType(boolean value)`
`BitType(DirectAccessContainer<BitType,? extends BitAccess> bitStorage)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(BitType c)`
`void`	`and(BitType c)`
`int`	`compareTo(BitType c)`
`BitType`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`BitType[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`BitType[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`BitType[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<BitType,? 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.
`BitType`	`createVariable()` Creates a new `Type` which can only store one value.
`void`	`dec()`
`void`	`div(BitType c)`
`BitType`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`boolean`	`get()`
`BitTypeDisplay`	`getDefaultDisplay(Image<BitType> image)` The `Type` creates the default `Display` for displaying the image contents.
`int`	`getInteger()`
`long`	`getIntegerLong()`
`double`	`getMaxValue()`
`double`	`getMinValue()`
`void`	`inc()`
`void`	`mul(BitType c)`
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`not()`
`void`	`or(BitType c)`
`void`	`set(BitType c)` Sets the value of another `Type`.
`void`	`set(boolean value)`
`void`	`setInteger(int f)`
`void`	`setInteger(long f)`
`void`	`setOne()`
`void`	`setZero()`
`void`	`sub(BitType c)`
`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.
`void`	`xor(BitType c)`

Methods inherited from class mpicbg.imglib.type.numeric.integer.IntegerTypeImpl
getMinIncrement, getRealDouble, getRealFloat, setReal, setReal

Methods inherited from class mpicbg.imglib.type.numeric.real.RealTypeImpl
decIndex, decIndex, getComplexDouble, getComplexFloat, getEntitiesPerPixel, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, incIndex, incIndex, setComplex, setComplex, updateIndex

Methods inherited from class mpicbg.imglib.type.numeric.complex.ComplexTypeImpl
complexConjugate, getPreferredRealPrecision, setComplexNumber, setComplexNumber

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.numeric.RealType
getMinIncrement

Methods inherited from interface mpicbg.imglib.type.numeric.ComplexType
complexConjugate, getComplexDouble, getComplexFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, getPreferredRealPrecision, getRealDouble, getRealFloat, setComplex, setComplex, setComplexNumber, setComplexNumber, setReal, setReal

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

- Constructor Detail
  - BitType
```
public BitType(DirectAccessContainer<BitType,? extends BitAccess> bitStorage)
```
  - BitType
```
public BitType(boolean value)
```
  - BitType
```
public BitType()
```
- Method Detail
  - createSuitableDirectAccessContainer
```
public DirectAccessContainer<BitType,? 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<BitType>
    
    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<BitType>
    
    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 BitType 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<BitType>
    
    Returns:
    
    - a new Type instance working on the same DirectAccessContainer
  - getDefaultDisplay
```
public BitTypeDisplay getDefaultDisplay(Image<BitType> 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<BitType>
    
    Overrides:
    
    getDefaultDisplay in class IntegerTypeImpl<BitType>
    
    Parameters:
    
    image - - the image to create the Display for
    
    Returns:
    
    the Display
  - get
```
public boolean get()
```
    Specified by:
    
    get in interface BooleanType<BitType>
  - set
```
public void set(boolean value)
```
    Specified by:
    
    set in interface BooleanType<BitType>
  - getInteger
```
public int getInteger()
```
    Specified by:
    
    getInteger in interface IntegerType<BitType>
  - getIntegerLong
```
public long getIntegerLong()
```
    Specified by:
    
    getIntegerLong in interface IntegerType<BitType>
  - setInteger
```
public void setInteger(int f)
```
    Specified by:
    
    setInteger in interface IntegerType<BitType>
  - setInteger
```
public void setInteger(long f)
```
    Specified by:
    
    setInteger in interface IntegerType<BitType>
  - getMaxValue
```
public double getMaxValue()
```
    Specified by:
    
    getMaxValue in interface RealType<BitType>
  - getMinValue
```
public double getMinValue()
```
    Specified by:
    
    getMinValue in interface RealType<BitType>
  - set
```
public void set(BitType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<BitType>
    
    Overrides:
    
    set in class RealTypeImpl<BitType>
    
    Parameters:
    
    c - - the new value
  - and
```
public void and(BitType c)
```
    Specified by:
    
    and in interface BooleanType<BitType>
  - or
```
public void or(BitType c)
```
    Specified by:
    
    or in interface BooleanType<BitType>
  - xor
```
public void xor(BitType c)
```
    Specified by:
    
    xor in interface BooleanType<BitType>
  - not
```
public void not()
```
    Specified by:
    
    not in interface BooleanType<BitType>
  - add
```
public void add(BitType c)
```
    Specified by:
    
    add in interface NumericType<BitType>
    
    Overrides:
    
    add in class RealTypeImpl<BitType>
  - div
```
public void div(BitType c)
```
    Specified by:
    
    div in interface NumericType<BitType>
    
    Overrides:
    
    div in class RealTypeImpl<BitType>
  - mul
```
public void mul(BitType c)
```
    Specified by:
    
    mul in interface NumericType<BitType>
    
    Overrides:
    
    mul in class RealTypeImpl<BitType>
  - sub
```
public void sub(BitType c)
```
    Specified by:
    
    sub in interface NumericType<BitType>
    
    Overrides:
    
    sub in class RealTypeImpl<BitType>
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface NumericType<BitType>
    
    Overrides:
    
    mul in class RealTypeImpl<BitType>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface NumericType<BitType>
    
    Overrides:
    
    mul in class RealTypeImpl<BitType>
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface NumericType<BitType>
    
    Overrides:
    
    setOne in class IntegerTypeImpl<BitType>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface NumericType<BitType>
    
    Overrides:
    
    setZero in class IntegerTypeImpl<BitType>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<BitType>
    
    Overrides:
    
    inc in class IntegerTypeImpl<BitType>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<BitType>
    
    Overrides:
    
    dec in class IntegerTypeImpl<BitType>
  - compareTo
```
public int compareTo(BitType c)
```
    Specified by:
    
    compareTo in interface Comparable<BitType>
    
    Overrides:
    
    compareTo in class IntegerTypeImpl<BitType>
  - createArray1D
```
public BitType[] createArray1D(int size1)
```
    Description copied from interface: Type
    
    Creates a 1d array of the generic Type
    
    Specified by:
    
    createArray1D in interface Type<BitType>
    
    Parameters:
    
    size1 - - the size of the array
    
    Returns:
    
    - T[] array
  - createArray2D
```
public BitType[][] createArray2D(int size1,
                                 int size2)
```
    Description copied from interface: Type
    
    Creates a 2d array of the generic Type
    
    Specified by:
    
    createArray2D in interface Type<BitType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    Returns:
    
    - T[][] array
  - createArray3D
```
public BitType[][][] 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<BitType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    size3 - - the size of the array
    
    Returns:
    
    - T[][][] array
  - createVariable
```
public BitType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<BitType>
    
    Returns:
    
    - a new Type instance
  - copy
```
public BitType 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<BitType>
    
    Specified by:
    
    copy in class TypeImpl<BitType>
    
    Returns:
    
    - a new Type instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class IntegerTypeImpl<BitType>

Class BitType

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

Constructor Summary

Method Summary

Methods inherited from class mpicbg.imglib.type.numeric.integer.IntegerTypeImpl

Methods inherited from class mpicbg.imglib.type.numeric.real.RealTypeImpl

Methods inherited from class mpicbg.imglib.type.numeric.complex.ComplexTypeImpl

Methods inherited from class mpicbg.imglib.type.TypeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.imglib.type.numeric.RealType

Methods inherited from interface mpicbg.imglib.type.numeric.ComplexType

Methods inherited from interface mpicbg.imglib.type.Type

Constructor Detail

BitType

BitType

BitType

Method Detail

createSuitableDirectAccessContainer

updateContainer

duplicateTypeOnSameDirectAccessContainer

getDefaultDisplay

get

set

getInteger

getIntegerLong

setInteger

setInteger

getMaxValue

getMinValue

set

and

or

xor

not

add

div

mul

sub

mul

mul

setOne

setZero

inc

dec

compareTo

createArray1D

createArray2D

createArray3D

createVariable

copy

toString