AbstractIntegerBitType (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.type.AbstractBitType<T>
- - net.imglib2.type.numeric.integer.AbstractIntegerBitType<T>

All Implemented Interfaces:

Comparable<T>, NativeType<T>, ComplexType<T>, IntegerType<T>, NumericType<T>, RealType<T>, Add<T>, Div<T>, Mul<T>, MulFloatingPoint, Pow<T>, PowFloatingPoint, SetOne, SetZero, Sub<T>, ValueEquals<T>, Type<T>

Direct Known Subclasses:

Unsigned12BitType, Unsigned2BitType, Unsigned4BitType
```
public abstract class AbstractIntegerBitType<T extends AbstractIntegerBitType<T>>
extends AbstractBitType<T>
implements IntegerType<T>
```
The performance of this type is traded off for the gain in memory storage.

Author:

Albert Cardona

Field Summary
- Fields inherited from class net.imglib2.type.AbstractBitType
  dataAccess, i, img, nBits

Constructor Summary

Constructors
Constructor and Description

AbstractIntegerBitType(NativeImg<?,? extends LongAccess> bitStorage, int nBits)

Constructors
Constructor and Description
`AbstractIntegerBitType(NativeImg<?,? extends LongAccess> bitStorage, int nBits)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(T t)`
`int`	`compareTo(T other)`
`void`	`complexConjugate()`
`void`	`dec()`
`void`	`div(T t)`
`boolean`	`equals(Object obj)`
`abstract long`	`get()`
`BigInteger`	`getBigInteger()`
`int`	`getBitsPerPixel()`
`double`	`getImaginaryDouble()`
`float`	`getImaginaryFloat()`
`int`	`getInteger()`
`long`	`getIntegerLong()`
`double`	`getMaxValue()` The maximum value that can be stored is `Math.pow(2, nBits) -1`.
`double`	`getMinIncrement()`
`double`	`getMinValue()`
`double`	`getPhaseDouble()`
`float`	`getPhaseFloat()`
`double`	`getPowerDouble()`
`float`	`getPowerFloat()`
`double`	`getRealDouble()`
`float`	`getRealFloat()`
`int`	`hashCode()`
`void`	`inc()`
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`mul(T t)`
`void`	`pow(double power)`
`void`	`pow(T t)`
`abstract void`	`set(long value)`
`void`	`set(T c)` Sets the value of another `Type`.
`void`	`setBigInteger(BigInteger b)`
`void`	`setComplexNumber(double r, double i)`
`void`	`setComplexNumber(float r, float i)`
`void`	`setImaginary(double complex)`
`void`	`setImaginary(float complex)`
`void`	`setInteger(int f)`
`void`	`setInteger(long f)`
`void`	`setOne()`
`void`	`setReal(double real)`
`void`	`setReal(float real)`
`void`	`setZero()`
`void`	`sub(T t)`
`String`	`toString()`
`boolean`	`valueEquals(T t)` Default test at long precision.

Methods inherited from class net.imglib2.type.AbstractBitType
getEntitiesPerPixel, getNativeTypeFactory, index, updateContainer

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

Methods inherited from interface net.imglib2.type.Type
copy, createVariable

Methods inherited from interface net.imglib2.type.NativeType
decIndex, decIndex, duplicateTypeOnSameNativeImg, getIndex, incIndex, incIndex, updateIndex

- Constructor Detail
  - AbstractIntegerBitType
```
public AbstractIntegerBitType(NativeImg<?,? extends LongAccess> bitStorage,
                              int nBits)
```
- Method Detail
  - get
```
public abstract long get()
```
  - set
```
public abstract void set(long value)
```
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Specified by:
    
    getBitsPerPixel in interface RealType<T extends AbstractIntegerBitType<T>>
  - getMinIncrement
```
public double getMinIncrement()
```
    Specified by:
    
    getMinIncrement in interface RealType<T extends AbstractIntegerBitType<T>>
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
  - getRealFloat
```
public float getRealFloat()
```
    Specified by:
    
    getRealFloat in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - getRealDouble
```
public double getRealDouble()
```
    Specified by:
    
    getRealDouble in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - setReal
```
public void setReal(float real)
```
    Specified by:
    
    setReal in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - setReal
```
public void setReal(double real)
```
    Specified by:
    
    setReal in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface SetZero
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface SetOne
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getInteger
```
public int getInteger()
```
    Specified by:
    
    getInteger in interface IntegerType<T extends AbstractIntegerBitType<T>>
  - getIntegerLong
```
public long getIntegerLong()
```
    Specified by:
    
    getIntegerLong in interface IntegerType<T extends AbstractIntegerBitType<T>>
  - getBigInteger
```
public BigInteger getBigInteger()
```
    Specified by:
    
    getBigInteger in interface IntegerType<T extends AbstractIntegerBitType<T>>
  - setInteger
```
public void setInteger(int f)
```
    Specified by:
    
    setInteger in interface IntegerType<T extends AbstractIntegerBitType<T>>
  - setInteger
```
public void setInteger(long f)
```
    Specified by:
    
    setInteger in interface IntegerType<T extends AbstractIntegerBitType<T>>
  - setBigInteger
```
public void setBigInteger(BigInteger b)
```
    Specified by:
    
    setBigInteger in interface IntegerType<T extends AbstractIntegerBitType<T>>
  - getMaxValue
```
public double getMaxValue()
```
    The maximum value that can be stored is Math.pow(2, nBits) -1.
    
    Specified by:
    
    getMaxValue in interface RealType<T extends AbstractIntegerBitType<T>>
  - getMinValue
```
public double getMinValue()
```
    Specified by:
    
    getMinValue in interface RealType<T extends AbstractIntegerBitType<T>>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<T extends AbstractIntegerBitType<T>>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<T extends AbstractIntegerBitType<T>>
  - add
```
public void add(T t)
```
    Specified by:
    
    add in interface Add<T extends AbstractIntegerBitType<T>>
  - sub
```
public void sub(T t)
```
    Specified by:
    
    sub in interface Sub<T extends AbstractIntegerBitType<T>>
  - mul
```
public void mul(T t)
```
    Specified by:
    
    mul in interface Mul<T extends AbstractIntegerBitType<T>>
  - div
```
public void div(T t)
```
    Specified by:
    
    div in interface Div<T extends AbstractIntegerBitType<T>>
  - pow
```
public void pow(T t)
```
    Specified by:
    
    pow in interface Pow<T extends AbstractIntegerBitType<T>>
  - pow
```
public void pow(double power)
```
    Specified by:
    
    pow in interface PowFloatingPoint
  - set
```
public void set(T c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<T extends AbstractIntegerBitType<T>>
    
    Parameters:
    
    c - the new value
  - getImaginaryFloat
```
public float getImaginaryFloat()
```
    Specified by:
    
    getImaginaryFloat in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - getImaginaryDouble
```
public double getImaginaryDouble()
```
    Specified by:
    
    getImaginaryDouble in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - setImaginary
```
public void setImaginary(float complex)
```
    Specified by:
    
    setImaginary in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - setImaginary
```
public void setImaginary(double complex)
```
    Specified by:
    
    setImaginary in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - getPhaseFloat
```
public float getPhaseFloat()
```
    Specified by:
    
    getPhaseFloat in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - getPhaseDouble
```
public double getPhaseDouble()
```
    Specified by:
    
    getPhaseDouble in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - getPowerFloat
```
public float getPowerFloat()
```
    Specified by:
    
    getPowerFloat in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - getPowerDouble
```
public double getPowerDouble()
```
    Specified by:
    
    getPowerDouble in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - setComplexNumber
```
public void setComplexNumber(float r,
                             float i)
```
    Specified by:
    
    setComplexNumber in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - setComplexNumber
```
public void setComplexNumber(double r,
                             double i)
```
    Specified by:
    
    setComplexNumber in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - complexConjugate
```
public void complexConjugate()
```
    Specified by:
    
    complexConjugate in interface ComplexType<T extends AbstractIntegerBitType<T>>
  - compareTo
```
public int compareTo(T other)
```
    Specified by:
    
    compareTo in interface Comparable<T extends AbstractIntegerBitType<T>>
  - valueEquals
```
public boolean valueEquals(T t)
```
    Default test at long precision. Please override for types longer than 64bit.
    
    Specified by:
    
    valueEquals in interface ValueEquals<T extends AbstractIntegerBitType<T>>
    
    Parameters:
    
    t -
    
    Returns:
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AbstractIntegerBitType<T extends AbstractIntegerBitType<T>>

Field Summary

Fields inherited from class net.imglib2.type.AbstractBitType

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.AbstractBitType

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.type.Type

Methods inherited from interface net.imglib2.type.NativeType

Constructor Detail

AbstractIntegerBitType

Method Detail

get

set

getBitsPerPixel

getMinIncrement

mul

mul

getRealFloat

getRealDouble

setReal

setReal

setZero

setOne

toString

getInteger

getIntegerLong

getBigInteger

setInteger

setInteger

setBigInteger

getMaxValue

getMinValue

inc

dec

add

sub

mul

div

pow

pow

set

getImaginaryFloat

getImaginaryDouble

setImaginary

setImaginary

getPhaseFloat

getPhaseDouble

getPowerFloat

getPowerDouble

setComplexNumber

setComplexNumber

complexConjugate

compareTo

valueEquals

equals

hashCode