UnsignedShortType (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<T>
      - mpicbg.imglib.type.numeric.integer.GenericShortType<UnsignedShortType>
        
        mpicbg.imglib.type.numeric.integer.UnsignedShortType

All Implemented Interfaces:

Comparable<UnsignedShortType>, ComplexType<UnsignedShortType>, IntegerType<UnsignedShortType>, NumericType<UnsignedShortType>, RealType<UnsignedShortType>, Type<UnsignedShortType>
```
public class UnsignedShortType
extends GenericShortType<UnsignedShortType>
```
TODO

Author:

Stephan Preibisch, Stephan Saalfeld

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

Constructor Summary

Constructors
Constructor and Description
`UnsignedShortType()`
`UnsignedShortType(DirectAccessContainer<UnsignedShortType,? extends ShortAccess> shortStorage)`
`UnsignedShortType(int value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(UnsignedShortType c)`
`UnsignedShortType`	`copy()` Creates a new `Type` which can only store one value but contains the value of this `Type`
`UnsignedShortType[]`	`createArray1D(int size1)` Creates a 1d array of the generic `Type`
`UnsignedShortType[][]`	`createArray2D(int size1, int size2)` Creates a 2d array of the generic `Type`
`UnsignedShortType[][][]`	`createArray3D(int size1, int size2, int size3)` Creates a 3d array of the generic `Type`
`DirectAccessContainer<UnsignedShortType,? extends ShortAccess>`	`createSuitableDirectAccessContainer(DirectAccessContainerFactory storageFactory, int[] dim)` The `Type` creates the DirectAccessContainer used for storing image data; based on the given storage strategy and its size.
`UnsignedShortType`	`createVariable()` Creates a new `Type` which can only store one value.
`void`	`div(UnsignedShortType c)`
`UnsignedShortType`	`duplicateTypeOnSameDirectAccessContainer()` Creates a new `Type` which stores in the same physical array.
`int`	`get()`
`static short`	`getCodedSignedShort(int unsignedShort)`
`static short`	`getCodedSignedShortChecked(int unsignedShort)`
`int`	`getInteger()`
`long`	`getIntegerLong()`
`double`	`getMaxValue()`
`double`	`getMinValue()`
`static int`	`getUnsignedShort(short signedShort)`
`void`	`mul(double c)`
`void`	`mul(float c)`
`void`	`set(int f)`
`void`	`setInteger(int f)`
`void`	`setInteger(long f)`

Methods inherited from class mpicbg.imglib.type.numeric.integer.GenericShortType
add, dec, getValue, inc, mul, set, setOne, setValue, setZero, sub, toString, updateContainer

Methods inherited from class mpicbg.imglib.type.numeric.integer.IntegerTypeImpl
getDefaultDisplay, getMinIncrement, getRealDouble, getRealFloat, setReal, setReal

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
  - UnsignedShortType
```
public UnsignedShortType(DirectAccessContainer<UnsignedShortType,? extends ShortAccess> shortStorage)
```
  - UnsignedShortType
```
public UnsignedShortType(int value)
```
  - UnsignedShortType
```
public UnsignedShortType()
```
- Method Detail
  - getCodedSignedShortChecked
```
public static short getCodedSignedShortChecked(int unsignedShort)
```
  - getCodedSignedShort
```
public static short getCodedSignedShort(int unsignedShort)
```
  - getUnsignedShort
```
public static int getUnsignedShort(short signedShort)
```
  - createSuitableDirectAccessContainer
```
public DirectAccessContainer<UnsignedShortType,? extends ShortAccess> 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.
  - duplicateTypeOnSameDirectAccessContainer
```
public UnsignedShortType 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
  - mul
```
public void mul(float c)
```
    Specified by:
    
    mul in interface NumericType<UnsignedShortType>
    
    Overrides:
    
    mul in class GenericShortType<UnsignedShortType>
  - mul
```
public void mul(double c)
```
    Specified by:
    
    mul in interface NumericType<UnsignedShortType>
    
    Overrides:
    
    mul in class GenericShortType<UnsignedShortType>
  - get
```
public int get()
```
  - set
```
public void set(int 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()
```
  - div
```
public void div(UnsignedShortType c)
```
    Specified by:
    
    div in interface NumericType<UnsignedShortType>
    
    Overrides:
    
    div in class GenericShortType<UnsignedShortType>
  - compareTo
```
public int compareTo(UnsignedShortType c)
```
    Specified by:
    
    compareTo in interface Comparable<UnsignedShortType>
    
    Overrides:
    
    compareTo in class GenericShortType<UnsignedShortType>
  - createArray1D
```
public UnsignedShortType[] 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 UnsignedShortType[][] 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 UnsignedShortType[][][] 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 UnsignedShortType createVariable()
```
    Description copied from interface: Type
    
    Creates a new Type which can only store one value.
    
    Returns:
    
    - a new Type instance
  - copy
```
public UnsignedShortType 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<UnsignedShortType>
    
    Specified by:
    
    copy in class TypeImpl<UnsignedShortType>
    
    Returns:
    
    - a new Type instance

Class UnsignedShortType

Field Summary

Fields inherited from class mpicbg.imglib.type.TypeImpl

Constructor Summary

Method Summary

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

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

UnsignedShortType

UnsignedShortType

UnsignedShortType

Method Detail

getCodedSignedShortChecked

getCodedSignedShort

getUnsignedShort

createSuitableDirectAccessContainer

duplicateTypeOnSameDirectAccessContainer

mul

mul

get

set

getInteger

getIntegerLong

setInteger

setInteger

getMaxValue

getMinValue

div

compareTo

createArray1D

createArray2D

createArray3D

createVariable

copy