ComplexFloatType (ImgLib2 Core Library 4.5.0 API)

java.lang.Object
- net.imglib2.type.numeric.complex.AbstractComplexType<ComplexFloatType>
- - net.imglib2.type.numeric.complex.ComplexFloatType

All Implemented Interfaces:

NativeType<ComplexFloatType>, ComplexType<ComplexFloatType>, NumericType<ComplexFloatType>, Add<ComplexFloatType>, Div<ComplexFloatType>, Mul<ComplexFloatType>, MulFloatingPoint, SetOne, SetZero, Sub<ComplexFloatType>, ValueEquals<ComplexFloatType>, Type<ComplexFloatType>
```
public class ComplexFloatType
extends AbstractComplexType<ComplexFloatType>
implements NativeType<ComplexFloatType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected FloatAccess dataAccess

protected NativeImg<?,? extends FloatAccess> img

Fields
Modifier and Type	Field and Description
`protected FloatAccess`	`dataAccess`
`protected NativeImg<?,? extends FloatAccess>`	`img`

Constructor Summary

Constructors
Constructor and Description
`ComplexFloatType()`
`ComplexFloatType(FloatAccess access)`
`ComplexFloatType(float r, float i)`
`ComplexFloatType(NativeImg<?,? extends FloatAccess> complexfloatStorage)`

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` variable that has the value of this `Type`
`NativeImg<ComplexFloatType,? extends FloatAccess>`	`createSuitableNativeImg(NativeImgFactory<ComplexFloatType> storageFactory, long[] dim)` The `NativeType` creates the `NativeImg` used for storing image data; based on the given storage strategy and its size.
`ComplexFloatType`	`createVariable()` Creates a new `Type` variable which can only store one value.
`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(ComplexFloatType c)`
`ComplexFloatType`	`duplicateTypeOnSameNativeImg()` Creates a new `NativeType` which stores in the same physical array.
`Fraction`	`getEntitiesPerPixel()` Get the number of entities in the storage array required to store one pixel value.
`double`	`getImaginaryDouble()`
`float`	`getImaginaryFloat()`
`int`	`getIndex()` Get the current index into the current data array.
`double`	`getRealDouble()`
`float`	`getRealFloat()`
`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(ComplexFloatType t)`
`void`	`set(ComplexFloatType c)` Sets the value of another `Type`.
`void`	`set(float r, float i)`
`void`	`setImaginary(double i)`
`void`	`setImaginary(float i)`
`void`	`setReal(double r)`
`void`	`setReal(float r)`
`void`	`sub(ComplexFloatType c)`
`void`	`switchRealComplex()`
`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(ComplexFloatType t)`

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType
equals, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, hashCode, mul, mul, setComplexNumber, setComplexNumber, setOne, setZero, toString

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

- Field Detail
  - img
```
protected final NativeImg<?,? extends FloatAccess> img
```
  - dataAccess
```
protected FloatAccess dataAccess
```
- Constructor Detail
  - ComplexFloatType
```
public ComplexFloatType(NativeImg<?,? extends FloatAccess> complexfloatStorage)
```
  - ComplexFloatType
```
public ComplexFloatType(float r,
                        float i)
```
  - ComplexFloatType
```
public ComplexFloatType(FloatAccess access)
```
  - ComplexFloatType
```
public ComplexFloatType()
```
- Method Detail
  - createSuitableNativeImg
```
public NativeImg<ComplexFloatType,? extends FloatAccess> createSuitableNativeImg(NativeImgFactory<ComplexFloatType> storageFactory,
                                                                                 long[] dim)
```
    Description copied from interface: NativeType
    
    The NativeType creates the NativeImg 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 containers and the basic types.
    
    Specified by:
    
    createSuitableNativeImg in interface NativeType<ComplexFloatType>
    
    Parameters:
    
    storageFactory - which storage strategy is used
    
    dim - the dimensions
    
    Returns:
    
    the instantiated NativeImg where only the Type knows the BasicType it contains.
  - 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<ComplexFloatType>
    
    Parameters:
    
    c - reference to an accessor which can be passed on to the container (which will know what to do with it).
  - duplicateTypeOnSameNativeImg
```
public ComplexFloatType 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<ComplexFloatType>
    
    Returns:
    
    a new NativeType instance working on the same NativeImg
  - getRealFloat
```
public float getRealFloat()
```
    Specified by:
    
    getRealFloat in interface ComplexType<ComplexFloatType>
  - getRealDouble
```
public double getRealDouble()
```
    Specified by:
    
    getRealDouble in interface ComplexType<ComplexFloatType>
  - getImaginaryFloat
```
public float getImaginaryFloat()
```
    Specified by:
    
    getImaginaryFloat in interface ComplexType<ComplexFloatType>
  - getImaginaryDouble
```
public double getImaginaryDouble()
```
    Specified by:
    
    getImaginaryDouble in interface ComplexType<ComplexFloatType>
  - setReal
```
public void setReal(float r)
```
    Specified by:
    
    setReal in interface ComplexType<ComplexFloatType>
  - setReal
```
public void setReal(double r)
```
    Specified by:
    
    setReal in interface ComplexType<ComplexFloatType>
  - setImaginary
```
public void setImaginary(float i)
```
    Specified by:
    
    setImaginary in interface ComplexType<ComplexFloatType>
  - setImaginary
```
public void setImaginary(double i)
```
    Specified by:
    
    setImaginary in interface ComplexType<ComplexFloatType>
  - set
```
public void set(float r,
                float i)
```
  - add
```
public void add(ComplexFloatType c)
```
    Specified by:
    
    add in interface Add<ComplexFloatType>
    
    Overrides:
    
    add in class AbstractComplexType<ComplexFloatType>
  - div
```
public void div(ComplexFloatType c)
```
    Specified by:
    
    div in interface Div<ComplexFloatType>
    
    Overrides:
    
    div in class AbstractComplexType<ComplexFloatType>
  - mul
```
public void mul(ComplexFloatType t)
```
    Specified by:
    
    mul in interface Mul<ComplexFloatType>
    
    Overrides:
    
    mul in class AbstractComplexType<ComplexFloatType>
  - sub
```
public void sub(ComplexFloatType c)
```
    Specified by:
    
    sub in interface Sub<ComplexFloatType>
    
    Overrides:
    
    sub in class AbstractComplexType<ComplexFloatType>
  - complexConjugate
```
public void complexConjugate()
```
    Specified by:
    
    complexConjugate in interface ComplexType<ComplexFloatType>
    
    Overrides:
    
    complexConjugate in class AbstractComplexType<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 AbstractComplexType<ComplexFloatType>
    
    Parameters:
    
    c - the new value
  - createVariable
```
public ComplexFloatType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type variable which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<ComplexFloatType>
    
    Returns:
    
    a new Type variable
  - copy
```
public ComplexFloatType copy()
```
    Description copied from interface: Type
    
    Creates a new Type variable that has the value of this Type
    
    Specified by:
    
    copy in interface Type<ComplexFloatType>
    
    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<ComplexFloatType>
    
    Returns:
    
    the number of storage type entities required to store one pixel value.
  - 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<ComplexFloatType>
    
    Parameters:
    
    index - the new array index
  - 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<ComplexFloatType>
  - 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<ComplexFloatType>
    
    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<ComplexFloatType>
  - 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<ComplexFloatType>
    
    Parameters:
    
    decrement - how many steps
  - 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<ComplexFloatType>
    
    Returns:
    
    the current index into the underlying data array
  - valueEquals
```
public boolean valueEquals(ComplexFloatType t)
```
    Specified by:
    
    valueEquals in interface ValueEquals<ComplexFloatType>

Class ComplexFloatType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType

Methods inherited from class java.lang.Object

Field Detail

img

dataAccess

Constructor Detail

ComplexFloatType

ComplexFloatType

ComplexFloatType

ComplexFloatType

Method Detail

createSuitableNativeImg

updateContainer

duplicateTypeOnSameNativeImg

getRealFloat

getRealDouble

getImaginaryFloat

getImaginaryDouble

setReal

setReal

setImaginary

setImaginary

set

add

div

mul

sub

complexConjugate

switchRealComplex

set

createVariable

copy

getEntitiesPerPixel

updateIndex

incIndex

incIndex

decIndex

decIndex

getIndex

valueEquals