LongType (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- mpicbg.imglib.type.TypeImpl<T>
- - mpicbg.imglib.type.numeric.complex.ComplexTypeImpl<T>
  - - mpicbg.imglib.type.numeric.real.RealTypeImpl<T>
    - - mpicbg.imglib.type.numeric.integer.IntegerTypeImpl<LongType>
      - mpicbg.imglib.type.numeric.integer.LongType

All Implemented Interfaces:

Comparable<LongType>, ComplexType<LongType>, IntegerType<LongType>, NumericType<LongType>, RealType<LongType>, Type<LongType>
```
public final class LongType
extends IntegerTypeImpl<LongType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

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

Constructor Summary

Constructors
Constructor and Description

LongType()

LongType(DirectAccessContainer<LongType,? extends LongAccess> longStorage)

LongType(long value)

Constructors
Constructor and Description
`LongType()`
`LongType(DirectAccessContainer<LongType,? extends LongAccess> longStorage)`
`LongType(long value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(LongType c)`
`int`	`compareTo(LongType c)`
`LongType`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`LongType[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`LongType[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`LongType[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<LongType,? extends LongAccess>`	`createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory, int[] dim)` The `Type` creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size.
`LongType`	`createVariable()` Creates a new `Type` which can only store one value.
`void`	`dec()`
`void`	`div(LongType c)`
`LongType`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`long`	`get()`
`int`	`getInteger()`
`long`	`getIntegerLong()`
`double`	`getMaxValue()`
`double`	`getMinValue()`
`void`	`inc()`
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`mul(LongType c)`
`void`	`set(long f)`
`void`	`set(LongType c)` Sets the value of another `Type`.
`void`	`setInteger(int f)`
`void`	`setInteger(long f)`
`void`	`setOne()`
`void`	`setZero()`
`void`	`sub(LongType c)`
`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.integer.IntegerTypeImpl
getDefaultDisplay, getMinIncrement, getRealDouble, getRealFloat, setReal, setReal, toString

Methods inherited from class mpicbg.imglib.type.numeric.real.RealTypeImpl
decIndex, decIndex, getComplexDouble, getComplexFloat, getEntitiesPerPixel, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, incIndex, incIndex, setComplex, setComplex, updateIndex

Methods inherited from class mpicbg.imglib.type.numeric.complex.ComplexTypeImpl
complexConjugate, getPreferredRealPrecision, setComplexNumber, setComplexNumber

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
complexConjugate, getComplexDouble, getComplexFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, getPreferredRealPrecision, setComplex, setComplex, setComplexNumber, setComplexNumber

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

- Constructor Detail
  - LongType
```
public LongType(DirectAccessContainer<LongType,? extends LongAccess> longStorage)
```
  - LongType
```
public LongType(long value)
```
  - LongType
```
public LongType()
```
- Method Detail
  - createSuitableDirectAccessContainer
```
public DirectAccessContainer<LongType,? extends LongAccess> 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.
    
    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 );
    
    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 LongType duplicateTypeOnSameDirectAccessContainer()
```
    Description copied from interface: Type
    
    Creates a new Type which stores in the same physical array. This is only used internally.
    
    Returns:
    
    - a new Type instance working on the same DirectAccessContainer
  - get
```
public long get()
```
  - set
```
public void set(long f)
```
  - getInteger
```
public int getInteger()
```
  - getIntegerLong
```
public long getIntegerLong()
```
  - setInteger
```
public void setInteger(int f)
```
  - setInteger
```
public void setInteger(long f)
```
  - getMaxValue
```
public double getMaxValue()
```
  - getMinValue
```
public double getMinValue()
```
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface NumericType<LongType>
    
    Overrides:
    
    mul in class RealTypeImpl<LongType>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface NumericType<LongType>
    
    Overrides:
    
    mul in class RealTypeImpl<LongType>
  - add
```
public void add(LongType c)
```
    Specified by:
    
    add in interface NumericType<LongType>
    
    Overrides:
    
    add in class RealTypeImpl<LongType>
  - div
```
public void div(LongType c)
```
    Specified by:
    
    div in interface NumericType<LongType>
    
    Overrides:
    
    div in class RealTypeImpl<LongType>
  - mul
```
public void mul(LongType c)
```
    Specified by:
    
    mul in interface NumericType<LongType>
    
    Overrides:
    
    mul in class RealTypeImpl<LongType>
  - sub
```
public void sub(LongType c)
```
    Specified by:
    
    sub in interface NumericType<LongType>
    
    Overrides:
    
    sub in class RealTypeImpl<LongType>
  - compareTo
```
public int compareTo(LongType c)
```
    Specified by:
    
    compareTo in interface Comparable<LongType>
    
    Overrides:
    
    compareTo in class IntegerTypeImpl<LongType>
  - set
```
public void set(LongType c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<LongType>
    
    Overrides:
    
    set in class RealTypeImpl<LongType>
    
    Parameters:
    
    c - - the new value
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface NumericType<LongType>
    
    Overrides:
    
    setOne in class IntegerTypeImpl<LongType>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface NumericType<LongType>
    
    Overrides:
    
    setZero in class IntegerTypeImpl<LongType>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<LongType>
    
    Overrides:
    
    inc in class IntegerTypeImpl<LongType>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<LongType>
    
    Overrides:
    
    dec in class IntegerTypeImpl<LongType>
  - createArray1D
```
public LongType[] createArray1D(int size1)
```
    Description copied from interface: Type
    
    Creates a 1d array of the generic Type
    
    Parameters:
    
    size1 - - the size of the array
    
    Returns:
    
    - T[] array
  - createArray2D
```
public LongType[][] createArray2D(int size1,
                                  int size2)
```
    Description copied from interface: Type
    
    Creates a 2d array of the generic Type
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    Returns:
    
    - T[][] array
  - createArray3D
```
public LongType[][][] createArray3D(int size1,
                                    int size2,
                                    int size3)
```
    Description copied from interface: Type
    
    Creates a 3d array of the generic Type
    
    Parameters:
    
    size1 - - the size of the array
    
    size2 - - the size of the array
    
    size3 - - the size of the array
    
    Returns:
    
    - T[][][] array
  - createVariable
```
public LongType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value.
    
    Returns:
    
    - a new Type instance
  - copy
```
public LongType 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<LongType>
    
    Specified by:
    
    copy in class TypeImpl<LongType>
    
    Returns:
    
    - a new Type instance

Class LongType

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

Constructor Summary

Method Summary

Methods inherited from class mpicbg.imglib.type.numeric.integer.IntegerTypeImpl

Methods inherited from class mpicbg.imglib.type.numeric.real.RealTypeImpl

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.Type

Constructor Detail

LongType

LongType

LongType

Method Detail

createSuitableDirectAccessContainer

updateContainer

duplicateTypeOnSameDirectAccessContainer

get

set

getInteger

getIntegerLong

setInteger

setInteger

getMaxValue

getMinValue

mul

mul

add

div

mul

sub

compareTo

set

setOne

setZero

inc

dec

createArray1D

createArray2D

createArray3D

createVariable

copy