GenericShortLongAccessType (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.type.numeric.complex.AbstractComplexType<T>
- - net.imglib2.type.numeric.real.AbstractRealType<T>
  - - net.imglib2.type.numeric.integer.AbstractIntegerType<T>
    - - net.imglib2.type.numeric.integer.GenericShortLongAccessType<T>

All Implemented Interfaces:

Comparable<T>, NativeLongAccessType<T>, ComplexType<T>, IntegerType<T>, NumericType<T>, RealType<T>, Add<T>, Div<T>, Mul<T>, MulFloatingPoint, Pow<T>, PowFloatingPoint, SetOne, SetZero, Sub<T>, ValueEquals<T>, Type<T>

Direct Known Subclasses:

ShortLongAccessType, UnsignedShortLongAccessType
```
public abstract class GenericShortLongAccessType<T extends GenericShortLongAccessType<T>>
extends AbstractIntegerType<T>
implements NativeLongAccessType<T>
```
Abstract base class for native IntegerTypes that encode their value into a 16bit short.

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields
Modifier and Type Field and Description

protected ShortLongAccess dataAccess

protected NativeLongAccessImg<?,? extends ShortLongAccess> img

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

Constructor Summary

Constructors
Constructor and Description
`GenericShortLongAccessType()`
`GenericShortLongAccessType(NativeLongAccessImg<?,? extends ShortLongAccess> shortStorage)`
`GenericShortLongAccessType(short value)`
`GenericShortLongAccessType(ShortLongAccess access)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(T c)`
`int`	`compareTo(T c)`
`void`	`dec()`
`void`	`decIndex()`
`void`	`decIndex(long decrement)` Decrease the index into the current data array by `decrement` steps.
`void`	`div(T c)`
`int`	`getBitsPerPixel()`
`Fraction`	`getEntitiesPerPixel()` Get the number of entities in the storage array required to store one pixel value.
`long`	`getIndexLong()` Get the current index into the current data array.
`protected short`	`getValue()`
`int`	`hashCode()`
`void`	`inc()`
`void`	`incIndex()`
`void`	`incIndex(long increment)` Increases the index into the current data array by `increment` steps.
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`mul(T c)`
`void`	`set(T c)` Sets the value of another `Type`.
`void`	`setOne()`
`protected void`	`setValue(short f)`
`void`	`setZero()`
`void`	`sub(T c)`
`String`	`toString()`
`void`	`updateContainer(Object c)`
`void`	`updateIndex(long index)` Set the index into the current data array.
`boolean`	`valueEquals(T t)`

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType
equals, getMinIncrement, getRealDouble, getRealFloat, setReal, setReal

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType
getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, pow, pow, setImaginary, setImaginary

Methods inherited from class net.imglib2.type.numeric.complex.AbstractComplexType
complexConjugate, setComplexNumber, setComplexNumber

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

Methods inherited from interface net.imglib2.type.NativeLongAccessType
createSuitableNativeImg, duplicateTypeOnSameNativeImg, getNativeLongAccessTypeFactory

Methods inherited from interface net.imglib2.type.Type
copy, createVariable

Methods inherited from interface net.imglib2.type.numeric.IntegerType
getBigInteger, getInteger, getIntegerLong, setBigInteger, setInteger, setInteger

Methods inherited from interface net.imglib2.type.numeric.RealType
getMaxValue, getMinValue

Methods inherited from interface net.imglib2.type.numeric.ComplexType
complexConjugate, getImaginaryDouble, getImaginaryFloat, getPhaseDouble, getPhaseFloat, getPowerDouble, getPowerFloat, setComplexNumber, setComplexNumber, setImaginary, setImaginary

Methods inherited from interface net.imglib2.type.operators.Pow
pow

Methods inherited from interface net.imglib2.type.operators.PowFloatingPoint
pow

- Field Detail
  - img
```
protected final NativeLongAccessImg<?,? extends ShortLongAccess> img
```
  - dataAccess
```
protected ShortLongAccess dataAccess
```
- Constructor Detail
  - GenericShortLongAccessType
```
public GenericShortLongAccessType(NativeLongAccessImg<?,? extends ShortLongAccess> shortStorage)
```
  - GenericShortLongAccessType
```
public GenericShortLongAccessType(short value)
```
  - GenericShortLongAccessType
```
public GenericShortLongAccessType(ShortLongAccess access)
```
  - GenericShortLongAccessType
```
public GenericShortLongAccessType()
```
- Method Detail
  - 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<T extends GenericShortLongAccessType<T>>
    
    Returns:
    
    the number of storage type entities required to store one pixel value.
  - updateContainer
```
public void updateContainer(Object c)
```
    Specified by:
    
    updateContainer in interface NativeLongAccessType<T extends GenericShortLongAccessType<T>>
  - getValue
```
protected short getValue()
```
  - setValue
```
protected void setValue(short f)
```
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<T extends GenericShortLongAccessType<T>>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<T extends GenericShortLongAccessType<T>>
  - add
```
public void add(T c)
```
    Specified by:
    
    add in interface Add<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    add in class AbstractRealType<T extends GenericShortLongAccessType<T>>
  - div
```
public void div(T c)
```
    Specified by:
    
    div in interface Div<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    div in class AbstractRealType<T extends GenericShortLongAccessType<T>>
  - mul
```
public void mul(T c)
```
    Specified by:
    
    mul in interface Mul<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    mul in class AbstractRealType<T extends GenericShortLongAccessType<T>>
  - sub
```
public void sub(T c)
```
    Specified by:
    
    sub in interface Sub<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    sub in class AbstractRealType<T extends GenericShortLongAccessType<T>>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>
  - compareTo
```
public int compareTo(T c)
```
    Specified by:
    
    compareTo in interface Comparable<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    compareTo in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>
  - set
```
public void set(T c)
```
    Description copied from interface: Type
    
    Sets the value of another Type.
    
    Specified by:
    
    set in interface Type<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    set in class AbstractRealType<T extends GenericShortLongAccessType<T>>
    
    Parameters:
    
    c - the new value
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface SetOne
    
    Overrides:
    
    setOne in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface SetZero
    
    Overrides:
    
    setZero in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    inc in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    dec in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>
  - 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<T extends GenericShortLongAccessType<T>>
    
    Parameters:
    
    index - the new array index
  - 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<T extends GenericShortLongAccessType<T>>
    
    Returns:
    
    the current index into the underlying data array
  - incIndex
```
public void incIndex()
```
    Specified by:
    
    incIndex in interface NativeLongAccessType<T extends GenericShortLongAccessType<T>>
  - 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<T extends GenericShortLongAccessType<T>>
    
    Parameters:
    
    increment - how many steps
  - decIndex
```
public void decIndex()
```
    Specified by:
    
    decIndex in interface NativeLongAccessType<T extends GenericShortLongAccessType<T>>
  - 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<T extends GenericShortLongAccessType<T>>
    
    Parameters:
    
    decrement - how many steps
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Specified by:
    
    getBitsPerPixel in interface RealType<T extends GenericShortLongAccessType<T>>
  - valueEquals
```
public boolean valueEquals(T t)
```
    Specified by:
    
    valueEquals in interface ValueEquals<T extends GenericShortLongAccessType<T>>
    
    Overrides:
    
    valueEquals in class AbstractIntegerType<T extends GenericShortLongAccessType<T>>

Class GenericShortLongAccessType<T extends GenericShortLongAccessType<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType

Methods inherited from class net.imglib2.type.numeric.real.AbstractRealType

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

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.type.NativeLongAccessType

Methods inherited from interface net.imglib2.type.Type

Methods inherited from interface net.imglib2.type.numeric.IntegerType

Methods inherited from interface net.imglib2.type.numeric.RealType

Methods inherited from interface net.imglib2.type.numeric.ComplexType

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

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

Field Detail

img

dataAccess

Constructor Detail

GenericShortLongAccessType

GenericShortLongAccessType

GenericShortLongAccessType

GenericShortLongAccessType

Method Detail

getEntitiesPerPixel

updateContainer

getValue

setValue

mul

mul

add

div

mul

sub

hashCode

compareTo

set

setOne

setZero

inc

dec

toString

updateIndex

getIndexLong

incIndex

incIndex

decIndex

decIndex

getBitsPerPixel

valueEquals