NativeARGBDoubleType (ImgLib2 Core Library 4.5.0 API)

java.lang.Object
- net.imglib2.type.numeric.AbstractARGBDoubleType<NativeARGBDoubleType>
- - net.imglib2.type.numeric.NativeARGBDoubleType

All Implemented Interfaces:

NativeType<NativeARGBDoubleType>, NumericType<NativeARGBDoubleType>, Add<NativeARGBDoubleType>, Div<NativeARGBDoubleType>, Mul<NativeARGBDoubleType>, MulFloatingPoint, SetOne, SetZero, Sub<NativeARGBDoubleType>, ValueEquals<NativeARGBDoubleType>, Type<NativeARGBDoubleType>
```
public class NativeARGBDoubleType
extends AbstractARGBDoubleType<NativeARGBDoubleType>
implements NativeType<NativeARGBDoubleType>
```
Author:

Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected DoubleAccess dataAccess

protected NativeImg<?,? extends DoubleAccess> img

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

Constructor Summary

Constructors
Constructor and Description
`NativeARGBDoubleType()`
`NativeARGBDoubleType(DoubleAccess access)`
`NativeARGBDoubleType(double a, double r, double g, double b)`
`NativeARGBDoubleType(NativeImg<?,? extends DoubleAccess> img)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NativeARGBDoubleType`	`copy()` Creates a new `Type` variable that has the value of this `Type`
`NativeImg<NativeARGBDoubleType,? extends DoubleAccess>`	`createSuitableNativeImg(NativeImgFactory<NativeARGBDoubleType> storageFactory, long[] dim)` The `NativeType` creates the `NativeImg` used for storing image data; based on the given storage strategy and its size.
`NativeARGBDoubleType`	`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.
`NativeARGBDoubleType`	`duplicateTypeOnSameNativeImg()` Creates a new `NativeType` which stores in the same physical array.
`double`	`getA()`
`double`	`getB()`
`Fraction`	`getEntitiesPerPixel()` Get the number of entities in the storage array required to store one pixel value.
`double`	`getG()`
`int`	`getIndex()` Get the current index into the current data array.
`double`	`getR()`
`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`	`set(ARGBDoubleType c)`
`void`	`set(double a, double r, double g, double b)`
`void`	`setA(double a)`
`void`	`setB(double b)`
`void`	`setG(double g)`
`void`	`setR(double r)`
`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.

Methods inherited from class net.imglib2.type.numeric.AbstractARGBDoubleType
add, div, mul, mul, mul, set, setOne, setZero, sub, toARGBInt, valueEquals

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

Methods inherited from interface net.imglib2.type.Type
set

Methods inherited from interface net.imglib2.type.operators.ValueEquals
valueEquals

- Field Detail
  - img
```
protected final NativeImg<?,? extends DoubleAccess> img
```
  - dataAccess
```
protected DoubleAccess dataAccess
```
- Constructor Detail
  - NativeARGBDoubleType
```
public NativeARGBDoubleType(NativeImg<?,? extends DoubleAccess> img)
```
  - NativeARGBDoubleType
```
public NativeARGBDoubleType(double a,
                            double r,
                            double g,
                            double b)
```
  - NativeARGBDoubleType
```
public NativeARGBDoubleType(DoubleAccess access)
```
  - NativeARGBDoubleType
```
public NativeARGBDoubleType()
```
- Method Detail
  - createSuitableNativeImg
```
public NativeImg<NativeARGBDoubleType,? extends DoubleAccess> createSuitableNativeImg(NativeImgFactory<NativeARGBDoubleType> 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<NativeARGBDoubleType>
    
    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<NativeARGBDoubleType>
    
    Parameters:
    
    c - reference to an accessor which can be passed on to the container (which will know what to do with it).
  - duplicateTypeOnSameNativeImg
```
public NativeARGBDoubleType 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<NativeARGBDoubleType>
    
    Returns:
    
    a new NativeType instance working on the same NativeImg
  - getA
```
public double getA()
```
    Specified by:
    
    getA in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - getR
```
public double getR()
```
    Specified by:
    
    getR in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - getG
```
public double getG()
```
    Specified by:
    
    getG in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - getB
```
public double getB()
```
    Specified by:
    
    getB in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - setA
```
public void setA(double a)
```
    Specified by:
    
    setA in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - setR
```
public void setR(double r)
```
    Specified by:
    
    setR in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - setG
```
public void setG(double g)
```
    Specified by:
    
    setG in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - setB
```
public void setB(double b)
```
    Specified by:
    
    setB in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - set
```
public void set(double a,
                double r,
                double g,
                double b)
```
    Overrides:
    
    set in class AbstractARGBDoubleType<NativeARGBDoubleType>
  - set
```
public void set(ARGBDoubleType c)
```
  - createVariable
```
public NativeARGBDoubleType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type variable which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<NativeARGBDoubleType>
    
    Returns:
    
    a new Type variable
  - copy
```
public NativeARGBDoubleType copy()
```
    Description copied from interface: Type
    
    Creates a new Type variable that has the value of this Type
    
    Specified by:
    
    copy in interface Type<NativeARGBDoubleType>
    
    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<NativeARGBDoubleType>
    
    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<NativeARGBDoubleType>
    
    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<NativeARGBDoubleType>
  - 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<NativeARGBDoubleType>
    
    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<NativeARGBDoubleType>
  - 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<NativeARGBDoubleType>
    
    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<NativeARGBDoubleType>
    
    Returns:
    
    the current index into the underlying data array

Class NativeARGBDoubleType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.numeric.AbstractARGBDoubleType

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.type.Type

Methods inherited from interface net.imglib2.type.operators.ValueEquals

Field Detail

img

dataAccess

Constructor Detail

NativeARGBDoubleType

NativeARGBDoubleType

NativeARGBDoubleType

NativeARGBDoubleType

Method Detail

createSuitableNativeImg

updateContainer

duplicateTypeOnSameNativeImg

getA

getR

getG

getB

setA

setR

setG

setB

set

set

createVariable

copy

getEntitiesPerPixel

updateIndex

incIndex

incIndex

decIndex

decIndex

getIndex