net.imglib2.type.numeric.integer.Unsigned128BitType

All Implemented Interfaces:: Comparable<Unsigned128BitType>, NativeType<Unsigned128BitType>, ComplexType<Unsigned128BitType>, IntegerType<Unsigned128BitType>, NumericType<Unsigned128BitType>, RealType<Unsigned128BitType>, Add<Unsigned128BitType>, Div<Unsigned128BitType>, Mul<Unsigned128BitType>, MulFloatingPoint, SetOne, SetZero, Sub<Unsigned128BitType>, ValueEquals<Unsigned128BitType>, Type<Unsigned128BitType>

public class Unsigned128BitType extends AbstractIntegerType<Unsigned128BitType> implements NativeType<Unsigned128BitType>

A Type with a bit depth of 128. Each value is stored in two adjacent long in an array, with the lower long first, then the upper long. Currently the math methods defined in the superinterface NumericType are implemented using BigInteger and BigDecimal. This class is not Thread-safe; do a copy() first to operate on a different Thread.

Author:: Albert Cardona

Field Summary

Fields

Modifier and Type

Field

Description

protected final byte[]

bytes

protected LongAccess

dataAccess

protected final NativeImg<?,? extends LongAccess>

img
Constructor Summary

Constructors

Constructor

Description

Unsigned128BitType()

Unsigned128BitType(long lower, long upper)

Unsigned128BitType(BigInteger value)

Unsigned128BitType(LongAccess access)

Unsigned128BitType(NativeImg<?,? extends LongAccess> bitStorage)
Method Summary

Modifier and Type

Method

Description

void

add(Unsigned128BitType t)

Relies on BigInteger.add(BigInteger).

int

compareTo(Unsigned128BitType t)

Unsigned128BitType

copy()

Creates a new Type variable that has the value of this Type

NativeImg<Unsigned128BitType,? extends LongAccess>

createSuitableNativeImg(NativeImgFactory<Unsigned128BitType> storageFactory, long[] dim)

The NativeType creates the NativeImg used for storing image data; based on the given storage strategy and its size.

Unsigned128BitType

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(Unsigned128BitType t)

Relies on BigInteger.divide(BigInteger).

Unsigned128BitType

duplicateTypeOnSameNativeImg()

Creates a new NativeType which stores in the same physical array.

BigInteger

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()

Return the lowest 32 bits, like BigInteger.intValue().

long

getIntegerLong()

Return the lowest 64 bits, like BigInteger.intValue().

BigInteger

getMaxBigIntegerValue()

The true maximum value, unlike getMaxValue() which cannot represent it in a double.

double

getMaxValue()

The maximum value that can be stored is Math.pow(2, 128) -1, which cannot be represented with precision using a double

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(double c)

Implemented using BigDecimal.multiply(BigDecimal) and BigDecimal.toBigInteger().

void

mul(float c)

See mul(double).

void

mul(Unsigned128BitType t)

Relies on BigInteger.multiply(BigInteger).

void

set(byte[] bytes)

The first byte is the most significant byte, like in BigInteger.toByteArray().

void

set(long lower, long upper)

void

set(BigInteger value)

void

setBigInteger(BigInteger b)

void

setInteger(int value)

void

setInteger(long value)

void

setOne()

void

setZero()

void

sub(Unsigned128BitType t)

Relies on BigInteger.subtract(BigInteger).

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(Unsigned128BitType t)

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

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType
equals, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, set, 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.ComplexType
complexConjugate, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setComplexNumber, setComplexNumber, setImaginary, setImaginary

Methods inherited from interface net.imglib2.type.Type
set

Field Details
- img
  
  protected final NativeImg<?,? extends LongAccess> img
- bytes
  
  protected final byte[] bytes
- dataAccess
  
  protected LongAccess dataAccess
Constructor Details
- Unsigned128BitType
  
  public Unsigned128BitType(NativeImg<?,? extends LongAccess> bitStorage)
- Unsigned128BitType
  
  public Unsigned128BitType(long lower, long upper)
- Unsigned128BitType
  
  public Unsigned128BitType(BigInteger value)
- Unsigned128BitType
  
  public Unsigned128BitType(LongAccess access)
- Unsigned128BitType
  
  public Unsigned128BitType()
Method Details
- createSuitableNativeImg
  
  public NativeImg<Unsigned128BitType,? extends LongAccess> createSuitableNativeImg(NativeImgFactory<Unsigned128BitType> 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<Unsigned128BitType>
  
  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<Unsigned128BitType>
  
  Parameters:
  
  c - reference to an accessor which can be passed on to the container (which will know what to do with it).
- duplicateTypeOnSameNativeImg
  
  public Unsigned128BitType 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<Unsigned128BitType>
  
  Returns:
  
  a new NativeType instance working on the same NativeImg
- set
  
  public void set(byte[] bytes)
  
  The first byte is the most significant byte, like in BigInteger.toByteArray(). Only the last 16 bytes are read, if there are more.
- get
  
  public BigInteger get()
- set
  
  public void set(BigInteger value)
- set
  
  public void set(long lower, long upper)
- getInteger
  
  public int getInteger()
  
  Return the lowest 32 bits, like BigInteger.intValue().
  
  Specified by:
  
  getInteger in interface IntegerType<Unsigned128BitType>
- getIntegerLong
  
  public long getIntegerLong()
  
  Return the lowest 64 bits, like BigInteger.intValue().
  
  Specified by:
  
  getIntegerLong in interface IntegerType<Unsigned128BitType>
- getBigInteger
  
  public BigInteger getBigInteger()
  
  Specified by:
  
  getBigInteger in interface IntegerType<Unsigned128BitType>
- setInteger
  
  public void setInteger(int value)
  
  Specified by:
  
  setInteger in interface IntegerType<Unsigned128BitType>
- setInteger
  
  public void setInteger(long value)
  
  Specified by:
  
  setInteger in interface IntegerType<Unsigned128BitType>
- setBigInteger
  
  public void setBigInteger(BigInteger b)
  
  Specified by:
  
  setBigInteger in interface IntegerType<Unsigned128BitType>
- getMaxValue
  
  public double getMaxValue()
  
  The maximum value that can be stored is Math.pow(2, 128) -1, which cannot be represented with precision using a double
  
  Specified by:
  
  getMaxValue in interface RealType<Unsigned128BitType>
- getMaxBigIntegerValue
  
  public BigInteger getMaxBigIntegerValue()
  
  The true maximum value, unlike getMaxValue() which cannot represent it in a double.
- getMinValue
  
  public double getMinValue()
  
  Specified by:
  
  getMinValue in interface RealType<Unsigned128BitType>
- 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<Unsigned128BitType>
  
  Returns:
  
  the current index into the underlying data array
- 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<Unsigned128BitType>
  
  Parameters:
  
  index - the new array index
- 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<Unsigned128BitType>
- 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<Unsigned128BitType>
  
  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<Unsigned128BitType>
- 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<Unsigned128BitType>
  
  Parameters:
  
  decrement - how many steps
- createVariable
  
  public Unsigned128BitType createVariable()
  
  Description copied from interface: Type
  
  Creates a new Type variable which can only store one value.
  
  Specified by:
  
  createVariable in interface Type<Unsigned128BitType>
  
  Returns:
  
  a new Type variable
- copy
  
  public Unsigned128BitType copy()
  
  Description copied from interface: Type
  
  Creates a new Type variable that has the value of this Type
  
  Specified by:
  
  copy in interface Type<Unsigned128BitType>
  
  Returns:
  
  a new Type variable
- 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<Unsigned128BitType>
  
  Returns:
  
  the number of storage type entities required to store one pixel value.
- getBitsPerPixel
  
  public int getBitsPerPixel()
  
  Specified by:
  
  getBitsPerPixel in interface RealType<Unsigned128BitType>
- inc
  
  public void inc()
  
  Specified by:
  
  inc in interface RealType<Unsigned128BitType>
  
  Overrides:
  
  inc in class AbstractIntegerType<Unsigned128BitType>
- dec
  
  public void dec()
  
  Specified by:
  
  dec in interface RealType<Unsigned128BitType>
  
  Overrides:
  
  dec in class AbstractIntegerType<Unsigned128BitType>
- setZero
  
  public void setZero()
  
  Specified by:
  
  setZero in interface SetZero
  
  Overrides:
  
  setZero in class AbstractIntegerType<Unsigned128BitType>
- setOne
  
  public void setOne()
  
  Specified by:
  
  setOne in interface SetOne
  
  Overrides:
  
  setOne in class AbstractIntegerType<Unsigned128BitType>
- mul
  
  public void mul(float c)
  
  See mul(double).
  
  Specified by:
  
  mul in interface MulFloatingPoint
  
  Overrides:
  
  mul in class AbstractRealType<Unsigned128BitType>
- mul
  
  public void mul(double c)
  
  Implemented using BigDecimal.multiply(BigDecimal) and BigDecimal.toBigInteger().
  
  Specified by:
  
  mul in interface MulFloatingPoint
  
  Overrides:
  
  mul in class AbstractRealType<Unsigned128BitType>
- add
  
  public void add(Unsigned128BitType t)
  
  Relies on BigInteger.add(BigInteger).
  
  Specified by:
  
  add in interface Add<Unsigned128BitType>
  
  Overrides:
  
  add in class AbstractRealType<Unsigned128BitType>
- sub
  
  public void sub(Unsigned128BitType t)
  
  Relies on BigInteger.subtract(BigInteger).
  
  Specified by:
  
  sub in interface Sub<Unsigned128BitType>
  
  Overrides:
  
  sub in class AbstractRealType<Unsigned128BitType>
- mul
  
  public void mul(Unsigned128BitType t)
  
  Relies on BigInteger.multiply(BigInteger).
  
  Specified by:
  
  mul in interface Mul<Unsigned128BitType>
  
  Overrides:
  
  mul in class AbstractRealType<Unsigned128BitType>
- div
  
  public void div(Unsigned128BitType t)
  
  Relies on BigInteger.divide(BigInteger).
  
  Specified by:
  
  div in interface Div<Unsigned128BitType>
  
  Overrides:
  
  div in class AbstractRealType<Unsigned128BitType>
- compareTo
  
  public int compareTo(Unsigned128BitType t)
  
  Specified by:
  
  compareTo in interface Comparable<Unsigned128BitType>
  
  Overrides:
  
  compareTo in class AbstractIntegerType<Unsigned128BitType>
- valueEquals
  
  public boolean valueEquals(Unsigned128BitType t)
  
  Specified by:
  
  valueEquals in interface ValueEquals<Unsigned128BitType>

Class Unsigned128BitType

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.ComplexType

Methods inherited from interface net.imglib2.type.Type

Field Details

img

bytes

dataAccess

Constructor Details

Unsigned128BitType

Unsigned128BitType

Unsigned128BitType

Unsigned128BitType

Unsigned128BitType

Method Details

createSuitableNativeImg

updateContainer

duplicateTypeOnSameNativeImg

set

get

set

set

getInteger

getIntegerLong

getBigInteger

setInteger

setInteger

setBigInteger

getMaxValue

getMaxBigIntegerValue

getMinValue

getIndex

updateIndex

incIndex

incIndex

decIndex

decIndex

createVariable

copy

getEntitiesPerPixel

getBitsPerPixel

inc

dec

setZero

setOne

mul

mul

add

sub

mul

div

compareTo

valueEquals