ComplexFloatType (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.type.TypeImpl<T>
- - mpicbg.imglib.type.numeric.complex.ComplexTypeImpl<ComplexFloatType>
  - - mpicbg.imglib.type.numeric.complex.ComplexFloatType

All Implemented Interfaces:

ComplexType<ComplexFloatType>, NumericType<ComplexFloatType>, Type<ComplexFloatType>
```
public class ComplexFloatType
extends ComplexTypeImpl<ComplexFloatType>
implements ComplexType<ComplexFloatType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

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

Constructor Summary

Constructors
Constructor and Description
`ComplexFloatType()`
`ComplexFloatType(DirectAccessContainer<ComplexFloatType,? extends FloatAccess> complexfloatStorage)`
`ComplexFloatType(float real, float complex)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(ComplexFloatType c)`
`void`	`complexConjugate()`
`ComplexFloatType`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`ComplexFloatType[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`ComplexFloatType[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`ComplexFloatType[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<ComplexFloatType,? 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.
`ComplexFloatType`	`createVariable()` Creates a new `Type` which can only store one value.
`void`	`div(ComplexFloatType c)`
`ComplexFloatType`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`double`	`getComplexDouble()`
`float`	`getComplexFloat()`
`Precision.PrecisionReal`	`getPreferredRealPrecision()`
`double`	`getRealDouble()`
`float`	`getRealFloat()`
`void`	`mul(ComplexFloatType t)`
`void`	`set(ComplexFloatType c)` Sets the value of another `Type`.
`void`	`set(float real, float complex)`
`void`	`setComplex(double complex)`
`void`	`setComplex(float complex)`
`void`	`setReal(double real)`
`void`	`setReal(float real)`
`void`	`sub(ComplexFloatType c)`
`void`	`switchRealComplex()`
`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.complex.ComplexTypeImpl
decIndex, decIndex, getDefaultDisplay, getEntitiesPerPixel, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, incIndex, incIndex, mul, mul, setComplexNumber, setComplexNumber, setOne, setZero, toString, updateIndex

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
getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setComplexNumber, setComplexNumber

Methods inherited from interface mpicbg.imglib.type.numeric.NumericType
mul, mul, setOne, setZero

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

- Constructor Detail
  - ComplexFloatType
```
public ComplexFloatType(DirectAccessContainer<ComplexFloatType,? extends FloatAccess> complexfloatStorage)
```
  - ComplexFloatType
```
public ComplexFloatType(float real,
                        float complex)
```
  - ComplexFloatType
```
public ComplexFloatType()
```
- Method Detail
  - createSuitableDirectAccessContainer
```
public DirectAccessContainer<ComplexFloatType,? 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<ComplexFloatType>
    
    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<ComplexFloatType>
    
    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 ComplexFloatType 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<ComplexFloatType>
    
    Returns:
    
    - a new Type instance working on the same DirectAccessContainer
  - getRealFloat
```
public float getRealFloat()
```
    Specified by:
    
    getRealFloat in interface ComplexType<ComplexFloatType>
  - getRealDouble
```
public double getRealDouble()
```
    Specified by:
    
    getRealDouble in interface ComplexType<ComplexFloatType>
  - getComplexFloat
```
public float getComplexFloat()
```
    Specified by:
    
    getComplexFloat in interface ComplexType<ComplexFloatType>
  - getComplexDouble
```
public double getComplexDouble()
```
    Specified by:
    
    getComplexDouble in interface ComplexType<ComplexFloatType>
  - setReal
```
public void setReal(float real)
```
    Specified by:
    
    setReal in interface ComplexType<ComplexFloatType>
  - setReal
```
public void setReal(double real)
```
    Specified by:
    
    setReal in interface ComplexType<ComplexFloatType>
  - setComplex
```
public void setComplex(float complex)
```
    Specified by:
    
    setComplex in interface ComplexType<ComplexFloatType>
  - setComplex
```
public void setComplex(double complex)
```
    Specified by:
    
    setComplex in interface ComplexType<ComplexFloatType>
  - getPreferredRealPrecision
```
public Precision.PrecisionReal getPreferredRealPrecision()
```
    Specified by:
    
    getPreferredRealPrecision in interface ComplexType<ComplexFloatType>
    
    Overrides:
    
    getPreferredRealPrecision in class ComplexTypeImpl<ComplexFloatType>
  - set
```
public void set(float real,
                float complex)
```
  - add
```
public void add(ComplexFloatType c)
```
    Specified by:
    
    add in interface NumericType<ComplexFloatType>
    
    Overrides:
    
    add in class ComplexTypeImpl<ComplexFloatType>
  - div
```
public void div(ComplexFloatType c)
```
    Specified by:
    
    div in interface NumericType<ComplexFloatType>
    
    Overrides:
    
    div in class ComplexTypeImpl<ComplexFloatType>
  - mul
```
public void mul(ComplexFloatType t)
```
    Specified by:
    
    mul in interface NumericType<ComplexFloatType>
    
    Overrides:
    
    mul in class ComplexTypeImpl<ComplexFloatType>
  - sub
```
public void sub(ComplexFloatType c)
```
    Specified by:
    
    sub in interface NumericType<ComplexFloatType>
    
    Overrides:
    
    sub in class ComplexTypeImpl<ComplexFloatType>
  - complexConjugate
```
public void complexConjugate()
```
    Specified by:
    
    complexConjugate in interface ComplexType<ComplexFloatType>
    
    Overrides:
    
    complexConjugate in class ComplexTypeImpl<ComplexFloatType>
  - switchRealComplex
```
public void switchRealComplex()
```
  - set
```
public void set(ComplexFloatType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<ComplexFloatType>
    
    Overrides:
    
    set in class ComplexTypeImpl<ComplexFloatType>
    
    Parameters:
    
    c - - the new value
  - createArray1D
```
public ComplexFloatType[] createArray1D(int size1)
```
    Description copied from interface: Type
    
    Creates a 1d array of the generic Type
    
    Specified by:
    
    createArray1D in interface Type<ComplexFloatType>
    
    Parameters:
    
    size1 - - the size of the array
    
    Returns:
    
    - T[] array
  - createArray2D
```
public ComplexFloatType[][] createArray2D(int size1,
                                          int size2)
```
    Description copied from interface: Type
    
    Creates a 2d array of the generic Type
    
    Specified by:
    
    createArray2D in interface Type<ComplexFloatType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    Returns:
    
    - T[][] array
  - createArray3D
```
public ComplexFloatType[][][] 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<ComplexFloatType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    size3 - - the size of the array
    
    Returns:
    
    - T[][][] array
  - createVariable
```
public ComplexFloatType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<ComplexFloatType>
    
    Returns:
    
    - a new Type instance
  - copy
```
public ComplexFloatType 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<ComplexFloatType>
    
    Specified by:
    
    copy in class TypeImpl<ComplexFloatType>
    
    Returns:
    
    - a new Type instance

Class ComplexFloatType

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

Constructor Summary

Method Summary

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.numeric.NumericType

Methods inherited from interface mpicbg.imglib.type.Type

Constructor Detail

ComplexFloatType

ComplexFloatType

ComplexFloatType

Method Detail

createSuitableDirectAccessContainer

updateContainer

duplicateTypeOnSameDirectAccessContainer

getRealFloat

getRealDouble

getComplexFloat

getComplexDouble

setReal

setReal

setComplex

setComplex

getPreferredRealPrecision

set

add

div

mul

sub

complexConjugate

switchRealComplex

set

createArray1D

createArray2D

createArray3D

createVariable

copy