Package net.imglib2.type.numeric.integer

Class GenericIntType<T extends GenericIntType<T>>

java.lang.Object

net.imglib2.type.numeric.complex.AbstractComplexType<T>

net.imglib2.type.numeric.real.AbstractRealType<T>

net.imglib2.type.numeric.integer.AbstractIntegerType<T>

net.imglib2.type.numeric.integer.GenericIntType<T>

All Implemented Interfaces:

java.lang.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:

IntType, UnsignedIntType

public abstract class GenericIntType<T extends GenericIntType<T>>
extends AbstractIntegerType<T>
implements NativeType<T>

TODO

Field Summary

Fields

Modifier and Type	Field	Description
protected IntAccess	dataAccess
(package private) Index	i
protected NativeImg<?,? extends IntAccess>	img

Constructor Summary

Constructors

Constructor	Description
GenericIntType()
GenericIntType(int value)
GenericIntType(IntAccess access)
GenericIntType(NativeImg<?,? extends IntAccess> intStorage)

Method Summary

Modifier and Type	Method	Description
void	add(T c)
int	compareTo(T other)
void	dec()
void	div(T c)
boolean	equals(java.lang.Object obj)
int	getBitsPerPixel()
Fraction	getEntitiesPerPixel()	Get the number of entities in the storage array required to store one pixel value.
int	getInt()	Returns the primitive int value that is used to store this type.
abstract NativeTypeFactory<T,IntAccess>	getNativeTypeFactory()
protected int	getValue()	Deprecated. Use getInt() instead.
int	hashCode()
void	inc()
Index	index()	Get the (modifiable) index into the current data array.
void	mul(double c)
void	mul(float c)
void	mul(T c)
void	pow(double power)
void	pow(T c)
void	set(T c)	Sets the value of another Type.
void	setInt(int f)	Sets the primitive int value that is used to store this type.
void	setOne()
protected void	setValue(int f)	Deprecated. Use setInt(int) instead.
void	setZero()
void	sub(T c)
java.lang.String	toString()
void	updateContainer(java.lang.Object c)	This method is used by an accessor (e.g., a Cursor) to request an update of the current data array.
boolean	valueEquals(T t)

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

getMinIncrement, getRealDouble, getRealFloat, setReal, setReal

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

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

complexConjugate, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setComplexNumber, setComplexNumber, setImaginary, setImaginary

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

getBigInteger, getInteger, getIntegerLong, setBigInteger, setInteger, setInteger

Methods inherited from interface net.imglib2.type.NativeType

decIndex, decIndex, duplicateTypeOnSameNativeImg, getIndex, incIndex, incIndex, updateIndex

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

getMaxValue, getMinValue

Methods inherited from interface net.imglib2.type.Type

copy, createVariable

Field Detail

i

final Index i

img

protected final NativeImg<?,? extends IntAccess> img

dataAccess

protected IntAccess dataAccess

Constructor Detail

GenericIntType

public GenericIntType(NativeImg<?,? extends IntAccess> intStorage)

GenericIntType

public GenericIntType(int value)

GenericIntType

public GenericIntType(IntAccess access)

GenericIntType

public GenericIntType()

Method Detail

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<T extends GenericIntType<T>>

Returns:

the number of storage type entities required to store one pixel value.

updateContainer

public void updateContainer(java.lang.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<T extends GenericIntType<T>>

Parameters:

c - reference to an accessor which can be passed on to the container (which will know what to do with it).

index

public Index index()

Description copied from interface: NativeType

Get the (modifiable) index into the current data array. The returned instance will always be the same for the same Type.

Specified by:

index in interface NativeType<T extends GenericIntType<T>>

getNativeTypeFactory

public abstract NativeTypeFactory<T,IntAccess> getNativeTypeFactory()

Specified by:

getNativeTypeFactory in interface NativeType<T extends GenericIntType<T>>

getValue

@Deprecated
protected int getValue()

Deprecated.

Use getInt() instead.

setValue

@Deprecated
protected void setValue(int f)

Deprecated.

Use setInt(int) instead.

getInt

public int getInt()

Returns the primitive int value that is used to store this type.

Returns:

primitive int value

setInt

public void setInt(int f)

Sets the primitive int value that is used to store this type.

mul

public void mul(float c)

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class AbstractRealType<T extends GenericIntType<T>>

mul

public void mul(double c)

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class AbstractRealType<T extends GenericIntType<T>>

add

public void add(T c)

Specified by:

add in interface Add<T extends GenericIntType<T>>

Overrides:

add in class AbstractRealType<T extends GenericIntType<T>>

div

public void div(T c)

Specified by:

div in interface Div<T extends GenericIntType<T>>

Overrides:

div in class AbstractRealType<T extends GenericIntType<T>>

mul

public void mul(T c)

Specified by:

mul in interface Mul<T extends GenericIntType<T>>

Overrides:

mul in class AbstractRealType<T extends GenericIntType<T>>

sub

public void sub(T c)

Specified by:

sub in interface Sub<T extends GenericIntType<T>>

Overrides:

sub in class AbstractRealType<T extends GenericIntType<T>>

pow

public void pow(T c)

Specified by:

pow in interface Pow<T extends GenericIntType<T>>

Overrides:

pow in class AbstractRealType<T extends GenericIntType<T>>

pow

public void pow(double power)

Specified by:

pow in interface PowFloatingPoint

Overrides:

pow in class AbstractRealType<T extends GenericIntType<T>>

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 GenericIntType<T>>

Overrides:

set in class AbstractRealType<T extends GenericIntType<T>>

Parameters:

c - the new value

setOne

public void setOne()

Specified by:

setOne in interface SetOne

Overrides:

setOne in class AbstractIntegerType<T extends GenericIntType<T>>

setZero

public void setZero()

Specified by:

setZero in interface SetZero

Overrides:

setZero in class AbstractIntegerType<T extends GenericIntType<T>>

inc

public void inc()

Specified by:

inc in interface RealType<T extends GenericIntType<T>>

Overrides:

inc in class AbstractIntegerType<T extends GenericIntType<T>>

dec

public void dec()

Specified by:

dec in interface RealType<T extends GenericIntType<T>>

Overrides:

dec in class AbstractIntegerType<T extends GenericIntType<T>>

toString

public java.lang.String toString()

Overrides:

toString in class AbstractIntegerType<T extends GenericIntType<T>>

getBitsPerPixel

public int getBitsPerPixel()

Specified by:

getBitsPerPixel in interface RealType<T extends GenericIntType<T>>

compareTo

public int compareTo(T other)

Specified by:

compareTo in interface java.lang.Comparable<T extends GenericIntType<T>>

Overrides:

compareTo in class AbstractIntegerType<T extends GenericIntType<T>>

valueEquals

public boolean valueEquals(T t)

Specified by:

valueEquals in interface ValueEquals<T extends GenericIntType<T>>

Overrides:

valueEquals in class AbstractIntegerType<T extends GenericIntType<T>>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractIntegerType<T extends GenericIntType<T>>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractIntegerType<T extends GenericIntType<T>>