net.imglib2.type.numeric.integer

Class GenericByteType<T extends GenericByteType<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.GenericByteType<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

ByteType, UnsignedByteType

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

TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteAccess	dataAccess
protected NativeImg<?,? extends ByteAccess>	img

Constructor Summary

Constructors

Constructor and Description
GenericByteType()
GenericByteType(byte value)
GenericByteType(ByteAccess access)
GenericByteType(NativeImg<?,? extends ByteAccess> byteStorage)

Method Summary

Modifier and Type	Method and Description
void	add(T c)
int	compareTo(T c)
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(T c)
int	getBitsPerPixel()
byte	getByte() Returns the primitive byte value that is used to store this type.
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.
protected byte	getValue() Deprecated. Use getByte() instead.
int	hashCode()
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)
void	mul(float c)
void	mul(T c)
void	set(T c) Sets the value of another Type.
void	setByte(byte f) Sets the primitive byte value that is used to store this type.
void	setOne()
protected void	setValue(byte f) Deprecated. Use setByte(byte) instead.
void	setZero()
void	sub(T 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(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

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

createSuitableNativeImg, duplicateTypeOnSameNativeImg

Methods inherited from interface net.imglib2.type.Type

copy, createVariable

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

getBigInteger, getInteger, getIntegerLong, setBigInteger, setInteger, setInteger

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

getMaxValue, getMinValue

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

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

Field Detail

img

protected final NativeImg<?,? extends ByteAccess> img

dataAccess

protected ByteAccess dataAccess

Constructor Detail

GenericByteType

public GenericByteType(NativeImg<?,? extends ByteAccess> byteStorage)

GenericByteType

public GenericByteType(byte value)

GenericByteType

public GenericByteType(ByteAccess access)

GenericByteType

public GenericByteType()

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

Returns:

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

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

Parameters:

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

getValue

@Deprecated
protected byte getValue()

Deprecated. Use getByte() instead.

setValue

@Deprecated
protected void setValue(byte f)

Deprecated. Use setByte(byte) instead.

getByte

public byte getByte()

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

Returns:

primitive byte value

setByte

public void setByte(byte f)

Sets the primitive byte 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 GenericByteType<T>>

mul

public void mul(double c)

Specified by:

mul in interface MulFloatingPoint

Overrides:

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

add

public void add(T c)

Specified by:

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

Overrides:

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

div

public void div(T c)

Specified by:

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

Overrides:

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

mul

public void mul(T c)

Specified by:

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

Overrides:

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

sub

public void sub(T c)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Overrides:

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

compareTo

public int compareTo(T c)

Specified by:

compareTo in interface Comparable<T extends GenericByteType<T>>

Overrides:

compareTo in class AbstractIntegerType<T extends GenericByteType<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 GenericByteType<T>>

Overrides:

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

Parameters:

c - the new value

setOne

public void setOne()

Specified by:

setOne in interface SetOne

Overrides:

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

setZero

public void setZero()

Specified by:

setZero in interface SetZero

Overrides:

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

inc

public void inc()

Specified by:

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

Overrides:

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

dec

public void dec()

Specified by:

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

Overrides:

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

toString

public String toString()

Overrides:

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

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

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

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

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

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

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

Parameters:

decrement - how many steps

getBitsPerPixel

public int getBitsPerPixel()

Specified by:

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

valueEquals

public boolean valueEquals(T t)

Specified by:

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