Class FloatType

java.lang.Object

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

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

net.imglib2.type.numeric.real.FloatType

All Implemented Interfaces:

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

Direct Known Subclasses:

VolatileFloatType.WrappedFloatType

public class FloatType
extends AbstractRealType<FloatType>
implements NativeType<FloatType>

TODO

Field Summary

Fields

Modifier and Type	Field	Description
protected FloatAccess	dataAccess
private final Index	i
protected final NativeImg<?, ? extends FloatAccess>	img
private static final NativeTypeFactory<FloatType, FloatAccess>	typeFactory

Constructor Summary

Constructors

Constructor	Description
FloatType()
FloatType(float value)
FloatType(FloatAccess access)
FloatType(NativeImg<?, ? extends FloatAccess> floatStorage)

Method Summary

Modifier and Type	Method	Description
void	add(FloatType c)
int	compareTo(FloatType other)
FloatType	copy()	Creates a new Type variable that has the value of this Type
FloatType	createVariable()	Creates a new Type variable which can only store one value.
static RealComposite<FloatType>	createVector(int n)	Create an n-dimensional RealComposite of FloatType backed by a 1-dimensional ArrayImg.
void	dec()
void	div(FloatType c)
FloatType	duplicateTypeOnSameNativeImg()	Creates a new NativeType which stores in the same physical array.
static boolean	equals(float a, float b)
boolean	equals(Object obj)
float	get()
int	getBitsPerPixel()
Fraction	getEntitiesPerPixel()	Get the number of entities in the storage array required to store one pixel value.
double	getMaxValue()
double	getMinIncrement()
double	getMinValue()
NativeTypeFactory<FloatType, FloatAccess>	getNativeTypeFactory()
double	getRealDouble()
float	getRealFloat()
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(FloatType c)
void	set(float f)
void	set(FloatType c)	Sets the value of another Type.
void	setOne()
void	setReal(double real)
void	setReal(float real)
void	setZero()
void	sub(FloatType c)
void	updateContainer(Object c)	This method is used by an accessor (e.g., a Cursor) to request an update of the current data array.
boolean	valueEquals(FloatType other)
static RealComposite<FloatType>	wrapVector(float[] array)	Wrap an array as an n-dimensional RealComposite of FloatType.

Methods inherited from class AbstractRealType

getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, pow, pow, setImaginary, setImaginary, toString

Methods inherited from class AbstractComplexType

complexConjugate, setComplexNumber, setComplexNumber

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ComplexType

complexConjugate, setComplexNumber, setComplexNumber

Methods inherited from interface NativeType

decIndex, decIndex, getIndex, incIndex, incIndex, updateIndex

Field Details

i

private final Index i

img

protected final NativeImg<?, ? extends FloatAccess> img

dataAccess

protected FloatAccess dataAccess

typeFactory

private static final NativeTypeFactory<FloatType, FloatAccess> typeFactory

Constructor Details

FloatType

public FloatType(NativeImg<?, ? extends FloatAccess> floatStorage)

FloatType

public FloatType(float value)

FloatType

public FloatType(FloatAccess access)

FloatType

public FloatType()

Method Details

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<FloatType>

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<FloatType>

duplicateTypeOnSameNativeImg

public FloatType 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<FloatType>

Returns:

a new NativeType instance working on the same NativeImg

getNativeTypeFactory

public NativeTypeFactory<FloatType, FloatAccess> getNativeTypeFactory()

Specified by:

getNativeTypeFactory in interface NativeType<FloatType>

get

public float get()

set

public void set(float f)

getRealFloat

public float getRealFloat()

Specified by:

getRealFloat in interface ComplexType<FloatType>

getRealDouble

public double getRealDouble()

Specified by:

getRealDouble in interface ComplexType<FloatType>

setReal

public void setReal(float real)

Specified by:

setReal in interface ComplexType<FloatType>

setReal

public void setReal(double real)

Specified by:

setReal in interface ComplexType<FloatType>

getMaxValue

public double getMaxValue()

Specified by:

getMaxValue in interface RealType<FloatType>

getMinValue

public double getMinValue()

Specified by:

getMinValue in interface RealType<FloatType>

getMinIncrement

public double getMinIncrement()

Specified by:

getMinIncrement in interface RealType<FloatType>

mul

public void mul(float c)

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class AbstractRealType<FloatType>

mul

public void mul(double c)

Specified by:

mul in interface MulFloatingPoint

Overrides:

mul in class AbstractRealType<FloatType>

add

public void add(FloatType c)

Specified by:

add in interface Add<FloatType>

Overrides:

add in class AbstractRealType<FloatType>

div

public void div(FloatType c)

Specified by:

div in interface Div<FloatType>

Overrides:

div in class AbstractRealType<FloatType>

mul

public void mul(FloatType c)

Specified by:

mul in interface Mul<FloatType>

Overrides:

mul in class AbstractRealType<FloatType>

sub

public void sub(FloatType c)

Specified by:

sub in interface Sub<FloatType>

Overrides:

sub in class AbstractRealType<FloatType>

set

public void set(FloatType c)

Description copied from interface: Type

Sets the value of another Type.

Specified by:

set in interface Type<FloatType>

Overrides:

set in class AbstractRealType<FloatType>

Parameters:

c - the new value

setOne

public void setOne()

Specified by:

setOne in interface SetOne

Overrides:

setOne in class AbstractRealType<FloatType>

setZero

public void setZero()

Specified by:

setZero in interface SetZero

Overrides:

setZero in class AbstractRealType<FloatType>

inc

public void inc()

Specified by:

inc in interface RealType<FloatType>

Overrides:

inc in class AbstractRealType<FloatType>

dec

public void dec()

Specified by:

dec in interface RealType<FloatType>

Overrides:

dec in class AbstractRealType<FloatType>

createVariable

public FloatType createVariable()

Description copied from interface: Type

Creates a new Type variable which can only store one value.

Specified by:

createVariable in interface Type<FloatType>

Returns:

a new Type variable

copy

public FloatType copy()

Description copied from interface: Type

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

Specified by:

copy in interface Type<FloatType>

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<FloatType>

Returns:

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

getBitsPerPixel

public int getBitsPerPixel()

Specified by:

getBitsPerPixel in interface RealType<FloatType>

compareTo

public int compareTo(FloatType other)

Specified by:

compareTo in interface Comparable<FloatType>

Overrides:

compareTo in class AbstractRealType<FloatType>

valueEquals

public boolean valueEquals(FloatType other)

Specified by:

valueEquals in interface ValueEquals<FloatType>

Overrides:

valueEquals in class AbstractRealType<FloatType>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractRealType<FloatType>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRealType<FloatType>

equals

public static boolean equals(float a,
 float b)

createVector

public static RealComposite<FloatType> createVector(int n)

Create an n-dimensional RealComposite of FloatType backed by a 1-dimensional ArrayImg.

Parameters:

n - number of dimensions

Returns:

wrapVector

public static RealComposite<FloatType> wrapVector(float[] array)

Wrap an array as an n-dimensional RealComposite of FloatType.

Parameters:

array -

Returns: