BitType (ImgLib2 Core Library 4.5.0 API)

java.lang.Object
- net.imglib2.type.numeric.complex.AbstractComplexType<T>
- - net.imglib2.type.numeric.real.AbstractRealType<T>
  - - net.imglib2.type.numeric.integer.AbstractIntegerType<BitType>
    - - net.imglib2.type.logic.BitType

All Implemented Interfaces:

Comparable<BitType>, BooleanType<BitType>, NativeType<BitType>, ComplexType<BitType>, IntegerType<BitType>, NumericType<BitType>, RealType<BitType>, Add<BitType>, Div<BitType>, Mul<BitType>, MulFloatingPoint, SetOne, SetZero, Sub<BitType>, ValueEquals<BitType>, Type<BitType>
```
public class BitType
extends AbstractIntegerType<BitType>
implements BooleanType<BitType>, NativeType<BitType>, IntegerType<BitType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected LongAccess dataAccess

protected int i

protected NativeImg<?,? extends LongAccess> img

Fields
Modifier and Type	Field and Description
`protected LongAccess`	`dataAccess`
`protected int`	`i`
`protected NativeImg<?,? extends LongAccess>`	`img`

Constructor Summary

Constructors
Constructor and Description

BitType()

BitType(boolean value)

BitType(LongAccess access)

BitType(NativeImg<?,? extends LongAccess> bitStorage)

Constructors
Constructor and Description
`BitType()`
`BitType(boolean value)`
`BitType(LongAccess access)`
`BitType(NativeImg<?,? extends LongAccess> 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` variable that has the value of this `Type`
`NativeImg<BitType,? extends LongAccess>`	`createSuitableNativeImg(NativeImgFactory<BitType> storageFactory, long[] dim)` The `NativeType` creates the `NativeImg` used for storing image data; based on the given storage strategy and its size.
`BitType`	`createVariable()` Creates a new `Type` variable which can only store one value.
`void`	`dec()`
`void`	`decIndex()` Decrement the index into the current data array.
`void`	`decIndex(int decrement)` Decrease the index into the current data array by `decrement` steps.
`void`	`div(BitType c)`
`BitType`	`duplicateTypeOnSameNativeImg()` Creates a new `NativeType` which stores in the same physical array.
`boolean`	`get()`
`BigInteger`	`getBigInteger()`
`int`	`getBitsPerPixel()`
`Fraction`	`getEntitiesPerPixel()` Get the number of entities in the storage array required to store one pixel value.
`int`	`getIndex()` Get the current index into the current data array.
`int`	`getInteger()`
`long`	`getIntegerLong()`
`double`	`getMaxValue()`
`double`	`getMinValue()`
`void`	`inc()`
`void`	`incIndex()` Increment the index into the current data array.
`void`	`incIndex(int increment)` Increases the index into the current data array by `increment` steps.
`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`	`setBigInteger(BigInteger b)`
`void`	`setInteger(int f)`
`void`	`setInteger(long f)`
`void`	`setOne()`
`void`	`setZero()`
`void`	`sub(BitType c)`
`String`	`toString()`
`void`	`updateContainer(Object c)` This method is used by an accessor (e.g., a `Cursor`) to request an update of the current data array.
`void`	`updateIndex(int index)` Set the index into the current data array.
`boolean`	`valueEquals(BitType t)`
`void`	`xor(BitType c)`

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType
getMinIncrement, getRealDouble, getRealFloat, hashCode, setReal, setReal

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType
equals, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setImaginary, setImaginary

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType
complexConjugate, setComplexNumber, setComplexNumber

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

Methods inherited from interface net.imglib2.type.numeric.RealType
getMinIncrement

Methods inherited from interface net.imglib2.type.numeric.ComplexType
complexConjugate, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, getRealDouble, getRealFloat, setComplexNumber, setComplexNumber, setImaginary, setImaginary, setReal, setReal

- Field Detail
  - i
```
protected int i
```
  - img
```
protected final NativeImg<?,? extends LongAccess> img
```
  - dataAccess
```
protected LongAccess dataAccess
```
- Constructor Detail
  - BitType
```
public BitType(NativeImg<?,? extends LongAccess> bitStorage)
```
  - BitType
```
public BitType(boolean value)
```
  - BitType
```
public BitType(LongAccess access)
```
  - BitType
```
public BitType()
```
- Method Detail
  - createSuitableNativeImg
```
public NativeImg<BitType,? extends LongAccess> createSuitableNativeImg(NativeImgFactory<BitType> storageFactory,
                                                                       long[] dim)
```
    Description copied from interface: NativeType
    
    The NativeType creates the NativeImg 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 containers and the basic types.
    
    Specified by:
    
    createSuitableNativeImg in interface NativeType<BitType>
    
    Parameters:
    
    storageFactory - which storage strategy is used
    
    dim - the dimensions
    
    Returns:
    
    the instantiated NativeImg where only the Type knows the BasicType it contains.
  - updateContainer
```
public void updateContainer(Object c)
```
    Description copied from interface: NativeType
    
    This method is used by an accessor (e.g., a Cursor) to request an update of the current data array.
    As an example consider a CellCursor moving on a CellImg. The cursor maintains a NativeType which provides access to the image data. When the cursor moves from one cell to the next, the underlying data array of the NativeType must be switched to the data array of the new cell.
    
    To achieve this, the CellCursor calls updateContainer() with itself as the argument. updateContainer() in turn will call NativeImg.update(Object) on it's container, passing along the reference to the cursor. In this example, the container would be a CellImg. While the NativeType does not know about the type of the cursor, the container does. CellImg knows that it is passed a CellCursor instance, which can be used to figure out the current cell and the underlying data array, which is then returned to the NativeType.
    
    The idea behind this concept is maybe not obvious. The NativeType knows which basic type is used (float, int, byte, ...). However, it does not know how the data is stored (ArrayImg, CellImg, ...). This prevents the need for multiple implementations of NativeType .
    
    Specified by:
    
    updateContainer in interface NativeType<BitType>
    
    Parameters:
    
    c - reference to an accessor which can be passed on to the container (which will know what to do with it).
  - duplicateTypeOnSameNativeImg
```
public BitType duplicateTypeOnSameNativeImg()
```
    Description copied from interface: NativeType
    
    Creates a new NativeType which stores in the same physical array. This is only used internally.
    
    Specified by:
    
    duplicateTypeOnSameNativeImg in interface NativeType<BitType>
    
    Returns:
    
    a new NativeType instance working on the same NativeImg
  - 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>
  - getBigInteger
```
public BigInteger getBigInteger()
```
    Specified by:
    
    getBigInteger 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>
  - setBigInteger
```
public void setBigInteger(BigInteger b)
```
    Specified by:
    
    setBigInteger 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 AbstractRealType<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 Add<BitType>
    
    Overrides:
    
    add in class AbstractRealType<BitType>
  - div
```
public void div(BitType c)
```
    Specified by:
    
    div in interface Div<BitType>
    
    Overrides:
    
    div in class AbstractRealType<BitType>
  - mul
```
public void mul(BitType c)
```
    Specified by:
    
    mul in interface Mul<BitType>
    
    Overrides:
    
    mul in class AbstractRealType<BitType>
  - sub
```
public void sub(BitType c)
```
    Specified by:
    
    sub in interface Sub<BitType>
    
    Overrides:
    
    sub in class AbstractRealType<BitType>
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<BitType>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<BitType>
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface SetOne
    
    Overrides:
    
    setOne in class AbstractIntegerType<BitType>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface SetZero
    
    Overrides:
    
    setZero in class AbstractIntegerType<BitType>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<BitType>
    
    Overrides:
    
    inc in class AbstractIntegerType<BitType>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<BitType>
    
    Overrides:
    
    dec in class AbstractIntegerType<BitType>
  - compareTo
```
public int compareTo(BitType c)
```
    Specified by:
    
    compareTo in interface Comparable<BitType>
    
    Overrides:
    
    compareTo in class AbstractIntegerType<BitType>
  - createVariable
```
public BitType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type variable which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<BitType>
    
    Returns:
    
    a new Type variable
  - copy
```
public BitType copy()
```
    Description copied from interface: Type
    
    Creates a new Type variable that has the value of this Type
    
    Specified by:
    
    copy in interface Type<BitType>
    
    Returns:
    
    a new Type variable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractIntegerType<BitType>
  - getEntitiesPerPixel
```
public Fraction getEntitiesPerPixel()
```
    Description copied from interface: NativeType
    
    Get the number of entities in the storage array required to store one pixel value. A pixel value may be spread over several or less than one entity. For example, a complex number may require 2 entries of a float[] array to store one pixel. Or a 12-bit type might need 12/64th entries of a long[] array.
    
    Specified by:
    
    getEntitiesPerPixel in interface NativeType<BitType>
    
    Returns:
    
    the number of storage type entities required to store one pixel value.
  - updateIndex
```
public void updateIndex(int index)
```
    Description copied from interface: NativeType
    
    Set the index into the current data array.
    This is used by accessors (e.g., a Cursor) to position the NativeType in the container.
    
    Specified by:
    
    updateIndex in interface NativeType<BitType>
    
    Parameters:
    
    index - the new array index
  - getIndex
```
public int getIndex()
```
    Description copied from interface: NativeType
    
    Get the current index into the current data array.
    This is used by accessors (e.g., a Cursor) to position the NativeType in the container.
    
    Specified by:
    
    getIndex in interface NativeType<BitType>
    
    Returns:
    
    the current index into the underlying data array
  - incIndex
```
public void incIndex()
```
    Description copied from interface: NativeType
    
    Increment the index into the current data array.
    This is used by accessors (e.g., a Cursor) to position the NativeType in the container.
    
    Specified by:
    
    incIndex in interface NativeType<BitType>
  - incIndex
```
public void incIndex(int increment)
```
    Description copied from interface: NativeType
    
    Increases the index into the current data array by increment steps.
    This is used by accessors (e.g., a Cursor) to position the NativeType in the container.
    
    Specified by:
    
    incIndex in interface NativeType<BitType>
    
    Parameters:
    
    increment - how many steps
  - decIndex
```
public void decIndex()
```
    Description copied from interface: NativeType
    
    Decrement the index into the current data array.
    This is used by accessors (e.g., a Cursor) to position the NativeType in the container.
    
    Specified by:
    
    decIndex in interface NativeType<BitType>
  - decIndex
```
public void decIndex(int decrement)
```
    Description copied from interface: NativeType
    
    Decrease the index into the current data array by decrement steps.
    This is used by accessors (e.g., a Cursor) to position the NativeType in the container.
    
    Specified by:
    
    decIndex in interface NativeType<BitType>
    
    Parameters:
    
    decrement - how many steps
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Specified by:
    
    getBitsPerPixel in interface RealType<BitType>
  - valueEquals
```
public boolean valueEquals(BitType t)
```
    Specified by:
    
    valueEquals in interface ValueEquals<BitType>

Class BitType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.type.numeric.RealType

Methods inherited from interface net.imglib2.type.numeric.ComplexType

Field Detail

i

img

dataAccess

Constructor Detail

BitType

BitType

BitType

BitType

Method Detail

createSuitableNativeImg

updateContainer

duplicateTypeOnSameNativeImg

get

set

getInteger

getIntegerLong

getBigInteger

setInteger

setInteger

setBigInteger

getMaxValue

getMinValue

set

and

or

xor

not

add

div

mul

sub

mul

mul

setOne

setZero

inc

dec

compareTo

createVariable

copy

toString

getEntitiesPerPixel

updateIndex

getIndex

incIndex

incIndex

decIndex

decIndex

getBitsPerPixel

valueEquals