RGBALegacyType (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.type.TypeImpl<RGBALegacyType>
- - mpicbg.imglib.type.numeric.RGBALegacyType

All Implemented Interfaces:

NumericType<RGBALegacyType>, Type<RGBALegacyType>
```
public final class RGBALegacyType
extends TypeImpl<RGBALegacyType>
implements NumericType<RGBALegacyType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

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

Constructor Summary

Constructors
Constructor and Description

RGBALegacyType()

RGBALegacyType(DirectAccessContainer<RGBALegacyType,? extends IntAccess> byteStorage)

RGBALegacyType(int value)

Constructors
Constructor and Description
`RGBALegacyType()`
`RGBALegacyType(DirectAccessContainer<RGBALegacyType,? extends IntAccess> byteStorage)`
`RGBALegacyType(int value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(RGBALegacyType c)`
`static int`	`alpha(int value)`
`static int`	`blue(int value)`
`RGBALegacyType`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`RGBALegacyType[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`RGBALegacyType[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`RGBALegacyType[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<RGBALegacyType,? extends IntAccess>`	`createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory, int[] dim)` The `Type` creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size.
`RGBALegacyType`	`createVariable()` Creates a new `Type` which can only store one value.
`void`	`div(RGBALegacyType c)`
`RGBALegacyType`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`int`	`get()`
`RGBALegacyTypeDisplay`	`getDefaultDisplay(Image<RGBALegacyType> image)` The `Type` creates the default `Display` for displaying the image contents.
`int`	`getEntitiesPerPixel()`
`static int`	`green(int value)`
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`mul(RGBALegacyType c)`
`static int`	`red(int value)`
`static int`	`rgba(double r, double g, double b, double a)`
`static int`	`rgba(float r, float g, float b, float a)`
`static int`	`rgba(int r, int g, int b, int a)`
`void`	`set(int f)`
`void`	`set(RGBALegacyType c)` Sets the value of another `Type`.
`void`	`setOne()`
`void`	`setZero()`
`void`	`sub(RGBALegacyType c)`
`String`	`toString()`
`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.TypeImpl
decIndex, decIndex, getIndex, incIndex, incIndex, updateIndex

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

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

- Constructor Detail
  - RGBALegacyType
```
public RGBALegacyType(DirectAccessContainer<RGBALegacyType,? extends IntAccess> byteStorage)
```
  - RGBALegacyType
```
public RGBALegacyType(int value)
```
  - RGBALegacyType
```
public RGBALegacyType()
```
- Method Detail
  - createSuitableDirectAccessContainer
```
public DirectAccessContainer<RGBALegacyType,? extends IntAccess> 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<RGBALegacyType>
    
    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<RGBALegacyType>
    
    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 RGBALegacyType 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<RGBALegacyType>
    
    Returns:
    
    - a new Type instance working on the same DirectAccessContainer
  - getDefaultDisplay
```
public RGBALegacyTypeDisplay getDefaultDisplay(Image<RGBALegacyType> image)
```
    Description copied from interface: Type
    
    The Type creates the default Display for displaying the image contents. Only Type can do this as in Image the Type is only a Generic. Later the user can create its own Displays if wanted. This could be basically a static function.
    
    Specified by:
    
    getDefaultDisplay in interface Type<RGBALegacyType>
    
    Parameters:
    
    image - - the image to create the Display for
    
    Returns:
    
    the Display
  - rgba
```
public static final int rgba(int r,
                             int g,
                             int b,
                             int a)
```
  - rgba
```
public static final int rgba(float r,
                             float g,
                             float b,
                             float a)
```
  - rgba
```
public static final int rgba(double r,
                             double g,
                             double b,
                             double a)
```
  - red
```
public static final int red(int value)
```
  - green
```
public static final int green(int value)
```
  - blue
```
public static final int blue(int value)
```
  - alpha
```
public static final int alpha(int value)
```
  - get
```
public int get()
```
  - set
```
public void set(int f)
```
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface NumericType<RGBALegacyType>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface NumericType<RGBALegacyType>
  - add
```
public void add(RGBALegacyType c)
```
    Specified by:
    
    add in interface NumericType<RGBALegacyType>
  - div
```
public void div(RGBALegacyType c)
```
    Specified by:
    
    div in interface NumericType<RGBALegacyType>
  - mul
```
public void mul(RGBALegacyType c)
```
    Specified by:
    
    mul in interface NumericType<RGBALegacyType>
  - sub
```
public void sub(RGBALegacyType c)
```
    Specified by:
    
    sub in interface NumericType<RGBALegacyType>
  - set
```
public void set(RGBALegacyType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<RGBALegacyType>
    
    Parameters:
    
    c - - the new value
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface NumericType<RGBALegacyType>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface NumericType<RGBALegacyType>
  - createArray1D
```
public RGBALegacyType[] createArray1D(int size1)
```
    Description copied from interface: Type
    
    Creates a 1d array of the generic Type
    
    Specified by:
    
    createArray1D in interface Type<RGBALegacyType>
    
    Parameters:
    
    size1 - - the size of the array
    
    Returns:
    
    - T[] array
  - createArray2D
```
public RGBALegacyType[][] createArray2D(int size1,
                                        int size2)
```
    Description copied from interface: Type
    
    Creates a 2d array of the generic Type
    
    Specified by:
    
    createArray2D in interface Type<RGBALegacyType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    Returns:
    
    - T[][] array
  - createArray3D
```
public RGBALegacyType[][][] 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<RGBALegacyType>
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    size3 - - the size of the array
    
    Returns:
    
    - T[][][] array
  - createVariable
```
public RGBALegacyType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value.
    
    Specified by:
    
    createVariable in interface Type<RGBALegacyType>
    
    Returns:
    
    - a new Type instance
  - copy
```
public RGBALegacyType 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<RGBALegacyType>
    
    Specified by:
    
    copy in class TypeImpl<RGBALegacyType>
    
    Returns:
    
    - a new Type instance
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class TypeImpl<RGBALegacyType>
  - getEntitiesPerPixel
```
public int getEntitiesPerPixel()
```
    Specified by:
    
    getEntitiesPerPixel in interface Type<RGBALegacyType>

Class RGBALegacyType

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

Constructor Summary

Method Summary

Methods inherited from class mpicbg.imglib.type.TypeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface mpicbg.imglib.type.Type

Constructor Detail

RGBALegacyType

RGBALegacyType

RGBALegacyType

Method Detail

createSuitableDirectAccessContainer

updateContainer

duplicateTypeOnSameDirectAccessContainer

getDefaultDisplay

rgba

rgba

rgba

red

green

blue

alpha

get

set

mul

mul

add

div

mul

sub

set

setOne

setZero

createArray1D

createArray2D

createArray3D

createVariable

copy

toString

getEntitiesPerPixel