ComplexFloatLongAccessType (ImgLib2 Javadocs 0-SNAPSHOT API)

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

All Implemented Interfaces:

NativeLongAccessType<ComplexFloatLongAccessType>, ComplexType<ComplexFloatLongAccessType>, NumericType<ComplexFloatLongAccessType>, Add<ComplexFloatLongAccessType>, Div<ComplexFloatLongAccessType>, Mul<ComplexFloatLongAccessType>, MulFloatingPoint, Pow<ComplexFloatLongAccessType>, PowFloatingPoint, SetOne, SetZero, Sub<ComplexFloatLongAccessType>, ValueEquals<ComplexFloatLongAccessType>, Type<ComplexFloatLongAccessType>
```
public class ComplexFloatLongAccessType
extends AbstractComplexType<ComplexFloatLongAccessType>
implements NativeLongAccessType<ComplexFloatLongAccessType>
```

Field Summary

Fields
Modifier and Type Field and Description

protected FloatLongAccess dataAccess

protected NativeLongAccessImg<?,? extends FloatLongAccess> img

Fields
Modifier and Type	Field and Description
`protected FloatLongAccess`	`dataAccess`
`protected NativeLongAccessImg<?,? extends FloatLongAccess>`	`img`

Constructor Summary

Constructors
Constructor and Description
`ComplexFloatLongAccessType()`
`ComplexFloatLongAccessType(float r, float i)`
`ComplexFloatLongAccessType(FloatLongAccess access)`
`ComplexFloatLongAccessType(NativeLongAccessImg<?,? extends FloatLongAccess> complexfloatStorage)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(ComplexFloatLongAccessType c)`
`void`	`complexConjugate()`
`ComplexFloatLongAccessType`	`copy()` Creates a new `Type` variable that has the value of this `Type`
`NativeLongAccessImg<ComplexFloatLongAccessType,? extends FloatLongAccess>`	`createSuitableNativeImg(NativeLongAccessImgFactory<ComplexFloatLongAccessType> storageFactory, long[] dim)` The `NativeLongAccessType` creates the `NativeLongAccessImg` used for storing image data; based on the given storage strategy and its size.
`ComplexFloatLongAccessType`	`createVariable()` Creates a new `Type` variable which can only store one value.
`void`	`decIndex()`
`void`	`decIndex(long decrement)` Decrease the index into the current data array by `decrement` steps.
`void`	`div(ComplexFloatLongAccessType c)`
`ComplexFloatLongAccessType`	`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()`
`long`	`getIndexLong()` Get the current index into the current data array.
`NativeLongAccessTypeFactory<ComplexFloatLongAccessType,?>`	`getNativeLongAccessTypeFactory()`
`double`	`getRealDouble()`
`float`	`getRealFloat()`
`void`	`incIndex()`
`void`	`incIndex(long increment)` Increases the index into the current data array by `increment` steps.
`void`	`mul(ComplexFloatLongAccessType t)`
`void`	`set(ComplexFloatLongAccessType 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(ComplexFloatLongAccessType c)`
`void`	`switchRealComplex()`
`void`	`updateContainer(Object c)`
`void`	`updateIndex(long index)` Set the index into the current data array.
`boolean`	`valueEquals(ComplexFloatLongAccessType t)`

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType
equals, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, hashCode, mul, mul, pow, pow, 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 NativeLongAccessImg<?,? extends FloatLongAccess> img
```
  - dataAccess
```
protected FloatLongAccess dataAccess
```
- Constructor Detail
  - ComplexFloatLongAccessType
```
public ComplexFloatLongAccessType(NativeLongAccessImg<?,? extends FloatLongAccess> complexfloatStorage)
```
  - ComplexFloatLongAccessType
```
public ComplexFloatLongAccessType(float r,
                                  float i)
```
  - ComplexFloatLongAccessType
```
public ComplexFloatLongAccessType(FloatLongAccess access)
```
  - ComplexFloatLongAccessType
```
public ComplexFloatLongAccessType()
```
- Method Detail
  - createSuitableNativeImg
```
public NativeLongAccessImg<ComplexFloatLongAccessType,? extends FloatLongAccess> createSuitableNativeImg(NativeLongAccessImgFactory<ComplexFloatLongAccessType> storageFactory,
                                                                                                         long[] dim)
```
    Description copied from interface: NativeLongAccessType
    
    The NativeLongAccessType creates the NativeLongAccessImg 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 NativeLongAccessType<ComplexFloatLongAccessType>
    
    Parameters:
    
    storageFactory - which storage strategy is used
    
    dim - the dimensions
    
    Returns:
    
    the instantiated NativeLongAccessImg where only the Type knows the BasicType it contains.
  - updateContainer
```
public void updateContainer(Object c)
```
    Specified by:
    
    updateContainer in interface NativeLongAccessType<ComplexFloatLongAccessType>
  - duplicateTypeOnSameNativeImg
```
public ComplexFloatLongAccessType duplicateTypeOnSameNativeImg()
```
    Description copied from interface: NativeLongAccessType
    
    Creates a new NativeType which stores in the same physical array. This is only used internally.
    
    Specified by:
    
    duplicateTypeOnSameNativeImg in interface NativeLongAccessType<ComplexFloatLongAccessType>
    
    Returns:
    
    a new NativeType instance working on the same NativeImg
  - getRealFloat
```
public float getRealFloat()
```
    Specified by:
    
    getRealFloat in interface ComplexType<ComplexFloatLongAccessType>
  - getRealDouble
```
public double getRealDouble()
```
    Specified by:
    
    getRealDouble in interface ComplexType<ComplexFloatLongAccessType>
  - getImaginaryFloat
```
public float getImaginaryFloat()
```
    Specified by:
    
    getImaginaryFloat in interface ComplexType<ComplexFloatLongAccessType>
  - getImaginaryDouble
```
public double getImaginaryDouble()
```
    Specified by:
    
    getImaginaryDouble in interface ComplexType<ComplexFloatLongAccessType>
  - setReal
```
public void setReal(float r)
```
    Specified by:
    
    setReal in interface ComplexType<ComplexFloatLongAccessType>
  - setReal
```
public void setReal(double r)
```
    Specified by:
    
    setReal in interface ComplexType<ComplexFloatLongAccessType>
  - setImaginary
```
public void setImaginary(float i)
```
    Specified by:
    
    setImaginary in interface ComplexType<ComplexFloatLongAccessType>
  - setImaginary
```
public void setImaginary(double i)
```
    Specified by:
    
    setImaginary in interface ComplexType<ComplexFloatLongAccessType>
  - set
```
public void set(float r,
                float i)
```
  - add
```
public void add(ComplexFloatLongAccessType c)
```
    Specified by:
    
    add in interface Add<ComplexFloatLongAccessType>
    
    Overrides:
    
    add in class AbstractComplexType<ComplexFloatLongAccessType>
  - div
```
public void div(ComplexFloatLongAccessType c)
```
    Specified by:
    
    div in interface Div<ComplexFloatLongAccessType>
    
    Overrides:
    
    div in class AbstractComplexType<ComplexFloatLongAccessType>
  - mul
```
public void mul(ComplexFloatLongAccessType t)
```
    Specified by:
    
    mul in interface Mul<ComplexFloatLongAccessType>
    
    Overrides:
    
    mul in class AbstractComplexType<ComplexFloatLongAccessType>
  - sub
```
public void sub(ComplexFloatLongAccessType c)
```
    Specified by:
    
    sub in interface Sub<ComplexFloatLongAccessType>
    
    Overrides:
    
    sub in class AbstractComplexType<ComplexFloatLongAccessType>
  - complexConjugate
```
public void complexConjugate()
```
    Specified by:
    
    complexConjugate in interface ComplexType<ComplexFloatLongAccessType>
    
    Overrides:
    
    complexConjugate in class AbstractComplexType<ComplexFloatLongAccessType>
  - switchRealComplex
```
public void switchRealComplex()
```
  - set
```
public void set(ComplexFloatLongAccessType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<ComplexFloatLongAccessType>
    
    Overrides:
    
    set in class AbstractComplexType<ComplexFloatLongAccessType>
    
    Parameters:
    
    c - the new value
  - createVariable
```
public ComplexFloatLongAccessType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type variable which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<ComplexFloatLongAccessType>
    
    Returns:
    
    a new Type variable
  - copy
```
public ComplexFloatLongAccessType copy()
```
    Description copied from interface: Type
    
    Creates a new Type variable that has the value of this Type
    
    Specified by:
    
    copy in interface Type<ComplexFloatLongAccessType>
    
    Returns:
    
    a new Type variable
  - getEntitiesPerPixel
```
public Fraction getEntitiesPerPixel()
```
    Description copied from interface: NativeLongAccessType
    
    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 NativeLongAccessType<ComplexFloatLongAccessType>
    
    Returns:
    
    the number of storage type entities required to store one pixel value.
  - updateIndex
```
public void updateIndex(long index)
```
    Description copied from interface: NativeLongAccessType
    
    Set the index into the current data array.
    This is used by accessors (e.g., a Cursor) to position the NativeLongAccessType in the container.
    
    Specified by:
    
    updateIndex in interface NativeLongAccessType<ComplexFloatLongAccessType>
    
    Parameters:
    
    index - the new array index
  - incIndex
```
public void incIndex()
```
    Specified by:
    
    incIndex in interface NativeLongAccessType<ComplexFloatLongAccessType>
  - incIndex
```
public void incIndex(long increment)
```
    Description copied from interface: NativeLongAccessType
    
    Increases the index into the current data array by increment steps.
    This is used by accessors (e.g., a Cursor) to position the NativeLongAccessType in the container.
    
    Specified by:
    
    incIndex in interface NativeLongAccessType<ComplexFloatLongAccessType>
    
    Parameters:
    
    increment - how many steps
  - decIndex
```
public void decIndex()
```
    Specified by:
    
    decIndex in interface NativeLongAccessType<ComplexFloatLongAccessType>
  - decIndex
```
public void decIndex(long decrement)
```
    Description copied from interface: NativeLongAccessType
    
    Decrease the index into the current data array by decrement steps.
    This is used by accessors (e.g., a Cursor) to position the NativeLongAccessType in the container.
    
    Specified by:
    
    decIndex in interface NativeLongAccessType<ComplexFloatLongAccessType>
    
    Parameters:
    
    decrement - how many steps
  - getIndexLong
```
public long getIndexLong()
```
    Description copied from interface: NativeLongAccessType
    
    Get the current index into the current data array.
    This is used by accessors (e.g., a Cursor) to position the NativeLongAccessType in the container.
    
    Specified by:
    
    getIndexLong in interface NativeLongAccessType<ComplexFloatLongAccessType>
    
    Returns:
    
    the current index into the underlying data array
  - valueEquals
```
public boolean valueEquals(ComplexFloatLongAccessType t)
```
    Specified by:
    
    valueEquals in interface ValueEquals<ComplexFloatLongAccessType>
    
    Overrides:
    
    valueEquals in class AbstractComplexType<ComplexFloatLongAccessType>
  - getNativeLongAccessTypeFactory
```
public NativeLongAccessTypeFactory<ComplexFloatLongAccessType,?> getNativeLongAccessTypeFactory()
```
    Specified by:
    
    getNativeLongAccessTypeFactory in interface NativeLongAccessType<ComplexFloatLongAccessType>

Class ComplexFloatLongAccessType

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

ComplexFloatLongAccessType

ComplexFloatLongAccessType

ComplexFloatLongAccessType

ComplexFloatLongAccessType

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

getIndexLong

valueEquals

getNativeLongAccessTypeFactory