FloatType (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.type.TypeImpl<T>
- - mpicbg.imglib.type.numeric.complex.ComplexTypeImpl<T>
  - - mpicbg.imglib.type.numeric.real.RealTypeImpl<FloatType>
    - - mpicbg.imglib.type.numeric.real.FloatType

All Implemented Interfaces:

Comparable<FloatType>, ComplexType<FloatType>, NumericType<FloatType>, RealType<FloatType>, Type<FloatType>
```
public class FloatType
extends RealTypeImpl<FloatType>
implements RealType<FloatType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary
- Fields inherited from class mpicbg.imglib.type.TypeImpl
  i

Constructor Summary

Constructors
Constructor and Description

FloatType()

FloatType(DirectAccessContainer<FloatType,? extends FloatAccess> floatStorage)

FloatType(float value)

Constructors
Constructor and Description
`FloatType()`
`FloatType(DirectAccessContainer<FloatType,? extends FloatAccess> floatStorage)`
`FloatType(float value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(FloatType c)`
`int`	`compareTo(FloatType c)`
`FloatType`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`FloatType[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`FloatType[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`FloatType[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<FloatType,? extends FloatAccess>`	`createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory, int[] dim)` The `Type` creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size.
`FloatType`	`createVariable()` Creates a new `Type` which can only store one value.
`void`	`dec()`
`void`	`div(FloatType c)`
`FloatType`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`float`	`get()`
`double`	`getMaxValue()`
`double`	`getMinIncrement()`
`double`	`getMinValue()`
`Precision.PrecisionReal`	`getPreferredRealPrecision()`
`double`	`getRealDouble()`
`float`	`getRealFloat()`
`void`	`inc()`
`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(Cursor<?> c)` This method is used by the `Cursor`s to update the data current data array of the `Type`, for example when moving from one `Cell` to the next.

Methods inherited from class mpicbg.imglib.type.numeric.real.RealTypeImpl
decIndex, decIndex, getComplexDouble, getComplexFloat, getDefaultDisplay, getEntitiesPerPixel, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, incIndex, incIndex, setComplex, setComplex, toString, updateIndex

Methods inherited from class mpicbg.imglib.type.numeric.complex.ComplexTypeImpl
complexConjugate, setComplexNumber, setComplexNumber

Methods inherited from class mpicbg.imglib.type.TypeImpl
getIndex

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface mpicbg.imglib.type.numeric.ComplexType
complexConjugate, getComplexDouble, getComplexFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setComplex, setComplex, setComplexNumber, setComplexNumber

Methods inherited from interface mpicbg.imglib.type.Type
decIndex, decIndex, getDefaultDisplay, getEntitiesPerPixel, getIndex, incIndex, incIndex, updateIndex

- Constructor Detail
  - FloatType
```
public FloatType(DirectAccessContainer<FloatType,? extends FloatAccess> floatStorage)
```
  - FloatType
```
public FloatType(float value)
```
  - FloatType
```
public FloatType()
```
- Method Detail
  - createSuitableDirectAccessContainer
```
public DirectAccessContainer<FloatType,? extends FloatAccess> createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory,
                                                                                                  int[] dim)
```
    Description copied from interface: Type
    
    The Type creates the DirectAccessContainer 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 Image and the basic types.
    
    Specified by:
    
    createSuitableDirectAccessContainer in interface Type<FloatType>
    
    Parameters:
    
    storageFactory - - Which storage strategy is used
    
    dim - - the dimensions
    
    Returns:
    
    - the instantiated DirectAccessContainer where only the Type knowns the BasicType it contains.
  - updateContainer
```
public void updateContainer(Cursor<?> c)
```
    Description copied from interface: Type
    
    This method is used by the Cursors to update the data current data array of the Type, for example when moving from one Cell to the next. If it is only an Array the Cursors never have to call that function. The idea behind this concept is maybe not obvious. The Type knows which basic type is used (float, int, byte, ...) but does not know how it is stored (Array, CellDirectAccessContainer, ...) to prevent multiple implementations of Type. That's why Type asks the DataAccess to give the actual basic array by passing the Cursor that calls the method. The DataAccess is also an Array, CellDirectAccessContainer, ... which can then communicate with the ArrayCursor, CellCursor, ... and return the current basic type array. A typical implementation of this method looks like that (this is the FloatType implementation): float[] v = floatStorage.getCurrentStorageArray( c );
    
    Specified by:
    
    updateContainer in interface Type<FloatType>
    
    Parameters:
    
    c - - the Cursor gives a link to itself so that the Type tell its DataAccess to get the new basic type array.
  - duplicateTypeOnSameDirectAccessContainer
```
public FloatType duplicateTypeOnSameDirectAccessContainer()
```
    Description copied from interface: Type
    
    Creates a new Type which stores in the same physical array. This is only used internally.
    
    Specified by:
    
    duplicateTypeOnSameDirectAccessContainer in interface Type<FloatType>
    
    Returns:
    
    - a new Type instance working on the same DirectAccessContainer
  - 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>
  - getPreferredRealPrecision
```
public Precision.PrecisionReal getPreferredRealPrecision()
```
    Specified by:
    
    getPreferredRealPrecision in interface ComplexType<FloatType>
    
    Overrides:
    
    getPreferredRealPrecision in class ComplexTypeImpl<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 NumericType<FloatType>
    
    Overrides:
    
    mul in class RealTypeImpl<FloatType>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface NumericType<FloatType>
    
    Overrides:
    
    mul in class RealTypeImpl<FloatType>
  - add
```
public void add(FloatType c)
```
    Specified by:
    
    add in interface NumericType<FloatType>
    
    Overrides:
    
    add in class RealTypeImpl<FloatType>
  - div
```
public void div(FloatType c)
```
    Specified by:
    
    div in interface NumericType<FloatType>
    
    Overrides:
    
    div in class RealTypeImpl<FloatType>
  - mul
```
public void mul(FloatType c)
```
    Specified by:
    
    mul in interface NumericType<FloatType>
    
    Overrides:
    
    mul in class RealTypeImpl<FloatType>
  - sub
```
public void sub(FloatType c)
```
    Specified by:
    
    sub in interface NumericType<FloatType>
    
    Overrides:
    
    sub in class RealTypeImpl<FloatType>
  - compareTo
```
public int compareTo(FloatType c)
```
    Specified by:
    
    compareTo in interface Comparable<FloatType>
    
    Overrides:
    
    compareTo in class RealTypeImpl<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 RealTypeImpl<FloatType>
    
    Parameters:
    
    c - - the new value
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface NumericType<FloatType>
    
    Overrides:
    
    setOne in class RealTypeImpl<FloatType>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface NumericType<FloatType>
    
    Overrides:
    
    setZero in class RealTypeImpl<FloatType>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<FloatType>
    
    Overrides:
    
    inc in class RealTypeImpl<FloatType>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<FloatType>
    
    Overrides:
    
    dec in class RealTypeImpl<FloatType>
  - createArray1D
```
public FloatType[] createArray1D(int size1)
```
    Description copied from interface: Type
    
    Creates a 1d array of the generic Type
    
    Specified by:
    
    createArray1D in interface Type<FloatType>
    
    Parameters:
    
    size1 - - the size of the array
    
    Returns:
    
    - T[] array
  - createArray2D
```
public FloatType[][] createArray2D(int size1,
                                   int size2)
```
    Description copied from interface: Type
    
    Creates a 2d array of the generic Type
    
    Specified by:
    
    createArray2D in interface Type<FloatType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    Returns:
    
    - T[][] array
  - createArray3D
```
public FloatType[][][] createArray3D(int size1,
                                     int size2,
                                     int size3)
```
    Description copied from interface: Type
    
    Creates a 3d array of the generic Type
    
    Specified by:
    
    createArray3D in interface Type<FloatType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    size3 - - the size of the array
    
    Returns:
    
    - T[][][] array
  - createVariable
```
public FloatType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<FloatType>
    
    Returns:
    
    - a new Type instance
  - copy
```
public FloatType copy()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value but contains the value of this Type
    
    Specified by:
    
    copy in interface Type<FloatType>
    
    Specified by:
    
    copy in class TypeImpl<FloatType>
    
    Returns:
    
    - a new Type instance

Class FloatType

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

Constructor Summary

Method Summary

Methods inherited from class mpicbg.imglib.type.numeric.real.RealTypeImpl

Methods inherited from class mpicbg.imglib.type.numeric.complex.ComplexTypeImpl

Methods inherited from class mpicbg.imglib.type.TypeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.imglib.type.numeric.ComplexType

Methods inherited from interface mpicbg.imglib.type.Type

Constructor Detail

FloatType

FloatType

FloatType

Method Detail

createSuitableDirectAccessContainer

updateContainer

duplicateTypeOnSameDirectAccessContainer

get

set

getRealFloat

getRealDouble

setReal

setReal

getPreferredRealPrecision

getMaxValue

getMinValue

getMinIncrement

mul

mul

add

div

mul

sub

compareTo

set

setOne

setZero

inc

dec

createArray1D

createArray2D

createArray3D

createVariable

copy