GenericShortType (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.GenericShortType<T>

All Implemented Interfaces:

Comparable<T>, NativeType<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:

ShortType, UnsignedShortType
```
public abstract class GenericShortType<T extends GenericShortType<T>>
extends AbstractIntegerType<T>
implements NativeType<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 ShortAccess dataAccess

protected NativeImg<?,? extends ShortAccess> img

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

Constructor Summary

Constructors
Constructor and Description
`GenericShortType()`
`GenericShortType(NativeImg<?,? extends ShortAccess> shortStorage)`
`GenericShortType(short value)`
`GenericShortType(ShortAccess access)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(T c)`
`int`	`compareTo(T other)`
`void`	`dec()`
`void`	`div(T c)`
`boolean`	`equals(Object obj)`
`int`	`getBitsPerPixel()`
`Fraction`	`getEntitiesPerPixel()` Get the number of entities in the storage array required to store one pixel value.
`abstract NativeTypeFactory<T,ShortAccess>`	`getNativeTypeFactory()`
`short`	`getShort()` Returns the primitive short value that is used to store this type.
`protected short`	`getValue()` Deprecated. Use `getShort()` instead.
`int`	`hashCode()`
`void`	`inc()`
`Index`	`index()` Get the (modifiable) index into the current data array.
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`mul(T c)`
`void`	`set(T c)` Sets the value of another `Type`.
`void`	`setOne()`
`void`	`setShort(short f)` Sets the primitive short value that is used to store this type.
`protected void`	`setValue(short f)` Deprecated. Use `setShort(short)` instead.
`void`	`setZero()`
`void`	`sub(T c)`
`String`	`toString()`
`void`	`updateContainer(Object c)` This method is used by an accessor (e.g., a `Cursor`) to request an update of the current data array.
`boolean`	`valueEquals(T t)`

Methods inherited from class net.imglib2.type.numeric.integer.AbstractIntegerType
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.NativeType
decIndex, decIndex, duplicateTypeOnSameNativeImg, getIndex, incIndex, incIndex, updateIndex

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 NativeImg<?,? extends ShortAccess> img
```
  - dataAccess
```
protected ShortAccess dataAccess
```
- Constructor Detail
  - GenericShortType
```
public GenericShortType(NativeImg<?,? extends ShortAccess> shortStorage)
```
  - GenericShortType
```
public GenericShortType(short value)
```
  - GenericShortType
```
public GenericShortType(ShortAccess access)
```
  - GenericShortType
```
public GenericShortType()
```
- Method Detail
  - 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<T extends GenericShortType<T>>
    
    Returns:
    
    the number of storage type entities required to store one pixel value.
  - 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<T extends GenericShortType<T>>
    
    Parameters:
    
    c - reference to an accessor which can be passed on to the container (which will know what to do with it).
  - index
```
public Index index()
```
    Description copied from interface: NativeType
    
    Get the (modifiable) index into the current data array. The returned instance will always be the same for the same Type.
    
    Specified by:
    
    index in interface NativeType<T extends GenericShortType<T>>
  - getNativeTypeFactory
```
public abstract NativeTypeFactory<T,ShortAccess> getNativeTypeFactory()
```
    Specified by:
    
    getNativeTypeFactory in interface NativeType<T extends GenericShortType<T>>
  - getValue
```
@Deprecated
protected short getValue()
```
    Deprecated. Use getShort() instead.
  - setValue
```
@Deprecated
protected void setValue(short f)
```
    Deprecated. Use setShort(short) instead.
  - getShort
```
public short getShort()
```
    Returns the primitive short value that is used to store this type.
    
    Returns:
    
    primitive short value
  - setShort
```
public void setShort(short f)
```
    Sets the primitive short value that is used to store this type.
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<T extends GenericShortType<T>>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface MulFloatingPoint
    
    Overrides:
    
    mul in class AbstractRealType<T extends GenericShortType<T>>
  - add
```
public void add(T c)
```
    Specified by:
    
    add in interface Add<T extends GenericShortType<T>>
    
    Overrides:
    
    add in class AbstractRealType<T extends GenericShortType<T>>
  - div
```
public void div(T c)
```
    Specified by:
    
    div in interface Div<T extends GenericShortType<T>>
    
    Overrides:
    
    div in class AbstractRealType<T extends GenericShortType<T>>
  - mul
```
public void mul(T c)
```
    Specified by:
    
    mul in interface Mul<T extends GenericShortType<T>>
    
    Overrides:
    
    mul in class AbstractRealType<T extends GenericShortType<T>>
  - sub
```
public void sub(T c)
```
    Specified by:
    
    sub in interface Sub<T extends GenericShortType<T>>
    
    Overrides:
    
    sub in class AbstractRealType<T extends GenericShortType<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 GenericShortType<T>>
    
    Overrides:
    
    set in class AbstractRealType<T extends GenericShortType<T>>
    
    Parameters:
    
    c - the new value
  - setOne
```
public void setOne()
```
    Specified by:
    
    setOne in interface SetOne
    
    Overrides:
    
    setOne in class AbstractIntegerType<T extends GenericShortType<T>>
  - setZero
```
public void setZero()
```
    Specified by:
    
    setZero in interface SetZero
    
    Overrides:
    
    setZero in class AbstractIntegerType<T extends GenericShortType<T>>
  - inc
```
public void inc()
```
    Specified by:
    
    inc in interface RealType<T extends GenericShortType<T>>
    
    Overrides:
    
    inc in class AbstractIntegerType<T extends GenericShortType<T>>
  - dec
```
public void dec()
```
    Specified by:
    
    dec in interface RealType<T extends GenericShortType<T>>
    
    Overrides:
    
    dec in class AbstractIntegerType<T extends GenericShortType<T>>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractIntegerType<T extends GenericShortType<T>>
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Specified by:
    
    getBitsPerPixel in interface RealType<T extends GenericShortType<T>>
  - compareTo
```
public int compareTo(T other)
```
    Specified by:
    
    compareTo in interface Comparable<T extends GenericShortType<T>>
    
    Overrides:
    
    compareTo in class AbstractIntegerType<T extends GenericShortType<T>>
  - valueEquals
```
public boolean valueEquals(T t)
```
    Specified by:
    
    valueEquals in interface ValueEquals<T extends GenericShortType<T>>
    
    Overrides:
    
    valueEquals in class AbstractIntegerType<T extends GenericShortType<T>>
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AbstractIntegerType<T extends GenericShortType<T>>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractIntegerType<T extends GenericShortType<T>>

Class GenericShortType<T extends GenericShortType<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.NativeType

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

GenericShortType

GenericShortType

GenericShortType

GenericShortType

Method Detail

getEntitiesPerPixel

updateContainer

index

getNativeTypeFactory

getValue

setValue

getShort

setShort

mul

mul

add

div

mul

sub

set

setOne

setZero

inc

dec

toString

getBitsPerPixel

compareTo

valueEquals

equals

hashCode