Class DoubleType

java.lang.Object

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

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

net.imglib2.type.numeric.real.DoubleType

All Implemented Interfaces:

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

Direct Known Subclasses:

VolatileDoubleType.WrappedDoubleType

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

TODO

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DoubleType()
DoubleType(double value)
DoubleType(DoubleAccess access)
DoubleType(NativeImg<?, ? extends DoubleAccess> doubleStorage)

Method Summary

Modifier and Type	Method	Description
DoubleType	copy()	Creates a new Type variable that has the value of this Type
DoubleType	createVariable()	Creates a new Type variable which can only store one value.
static RealComposite<DoubleType>	createVector(int n)	Create an n-dimensional RealComposite of DoubleType backed by a 1-dimensional ArrayImg.
DoubleType	duplicateTypeOnSameNativeImg()	Creates a new NativeType which stores in the same physical array.
static boolean	equals(double a, double b)
double	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<DoubleType, DoubleAccess>	getNativeTypeFactory()
double	getRealDouble()
float	getRealFloat()
Index	index()	Get the (modifiable) index into the current data array.
void	set(double f)
void	setReal(double real)
void	setReal(float real)
void	updateContainer(Object c)	This method is used by an accessor (e.g., a Cursor) to request an update of the current data array.
static RealComposite<DoubleType>	wrapVector(double[] array)	Wrap an array as an n-dimensional RealComposite of DoubleType.

Methods inherited from class AbstractRealType

add, compareTo, dec, div, equals, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, hashCode, inc, mul, mul, mul, pow, pow, set, setImaginary, setImaginary, setOne, setZero, sub, toString, valueEquals

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

Methods inherited from interface Type

set

Methods inherited from interface ValueEquals

valueEquals

Field Details

i

private final Index i

img

protected final NativeImg<?, ? extends DoubleAccess> img

dataAccess

protected DoubleAccess dataAccess

typeFactory

private static final NativeTypeFactory<DoubleType, DoubleAccess> typeFactory

Constructor Details

DoubleType

public DoubleType(NativeImg<?, ? extends DoubleAccess> doubleStorage)

DoubleType

public DoubleType(double value)

DoubleType

public DoubleType(DoubleAccess access)

DoubleType

public DoubleType()

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

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

duplicateTypeOnSameNativeImg

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

Returns:

a new NativeType instance working on the same NativeImg

getNativeTypeFactory

public NativeTypeFactory<DoubleType, DoubleAccess> getNativeTypeFactory()

Specified by:

getNativeTypeFactory in interface NativeType<DoubleType>

get

public double get()

set

public void set(double f)

getRealFloat

public float getRealFloat()

Specified by:

getRealFloat in interface ComplexType<DoubleType>

getRealDouble

public double getRealDouble()

Specified by:

getRealDouble in interface ComplexType<DoubleType>

setReal

public void setReal(float real)

Specified by:

setReal in interface ComplexType<DoubleType>

setReal

public void setReal(double real)

Specified by:

setReal in interface ComplexType<DoubleType>

getMaxValue

public double getMaxValue()

Specified by:

getMaxValue in interface RealType<DoubleType>

getMinValue

public double getMinValue()

Specified by:

getMinValue in interface RealType<DoubleType>

getMinIncrement

public double getMinIncrement()

Specified by:

getMinIncrement in interface RealType<DoubleType>

createVariable

public DoubleType createVariable()

Description copied from interface: Type

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

Specified by:

createVariable in interface Type<DoubleType>

Returns:

a new Type variable

copy

public DoubleType copy()

Description copied from interface: Type

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

Specified by:

copy in interface Type<DoubleType>

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

Returns:

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

getBitsPerPixel

public int getBitsPerPixel()

Specified by:

getBitsPerPixel in interface RealType<DoubleType>

equals

public static boolean equals(double a,
 double b)

createVector

public static RealComposite<DoubleType> createVector(int n)

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

Parameters:

n - number of dimensions

Returns:

wrapVector

public static RealComposite<DoubleType> wrapVector(double[] array)

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

Parameters:

array -

Returns: