DataType (ImageJ2 Javadocs 0-SNAPSHOT API)

All Superinterfaces:

Contextual, ImageJPlugin, SciJavaPlugin, SingletonPlugin

All Known Implementing Classes:

DataType128BitSignedComplexFloat, DataType12BitUnsignedInteger, DataType16BitSignedInteger, DataType16BitUnsignedInteger, DataType1BitUnsignedInteger, DataType32BitSignedFloat, DataType32BitSignedInteger, DataType32BitUnsignedInteger, DataType64BitSignedComplexFloat, DataType64BitSignedFloat, DataType64BitSignedInteger, DataType8BitSignedInteger, DataType8BitUnsignedInteger, DataTypeBoolean, DataTypeVariableBitSignedComplexFloat, DataTypeVariableBitSignedFloat, DataTypeVariableBitSignedInteger
```
public interface DataType<T extends NumericType<T>>
extends ImageJPlugin, Contextual, SingletonPlugin
```
DataType represents information about pixel types. These types can be discovered at runtime making ImageJ user extensible.

Author:

Barry DeZonia

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`asDouble(T val)` Converts value to a double.
`long`	`asLong(T val)` Converts value to a long.
`int`	`bitCount()` Number of bits of information required to represent data in the type.
`void`	`cast(BigComplex val, T dest)` Sets a given variable of the underlying NumericType to a value that is closest to a given BigComplex number.
`void`	`cast(T val, BigComplex dest)` Sets a BigComplex representation from a given variable of the underlying NumericType.
`T`	`createVariable()` Returns a variable of the underlying NumericType wrapped by this DataType.
`String`	`description()` A fuller description that elaborates on the capabilities of the type.
`T`	`getType()` Provides an example of the underlying NumericType.
`boolean`	`hasDoubleRepresentation()` Returns true if data can be encoded in a double with no precision loss.
`boolean`	`hasLongRepresentation()` Returns true if data can be encoded in a long with no precision loss.
`boolean`	`isBounded()` Returns true if DataType is fully bounded (bounded below and bounded above).
`boolean`	`isComplex()` Returns true if this DataType is a complex number (imaginary component is changeable).
`boolean`	`isFloat()` Returns true if this DataType represents a floating point number.
`boolean`	`isSigned()` Returns true if this DataType represents a signed number.
`String`	`longName()` A long name useful for displaying to user.
`void`	`lowerBound(T dest)` Sets a given variable to the lower bound of the underlying NumericType.
`void`	`setDouble(T val, double v)` Sets a given value to a given double.
`void`	`setLong(T val, long v)` Sets a given value to a given long.
`String`	`shortName()` A short name useful for displaying to user.
`void`	`upperBound(T dest)` Sets a given variable to the upper bound of the underlying NumericType.

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

- Method Detail
  - getType
```
T getType()
```
    Provides an example of the underlying NumericType.
  - shortName
```
String shortName()
```
    A short name useful for displaying to user.
  - longName
```
String longName()
```
    A long name useful for displaying to user.
  - description
```
String description()
```
    A fuller description that elaborates on the capabilities of the type.
  - isComplex
```
boolean isComplex()
```
    Returns true if this DataType is a complex number (imaginary component is changeable).
  - isFloat
```
boolean isFloat()
```
    Returns true if this DataType represents a floating point number.
  - isSigned
```
boolean isSigned()
```
    Returns true if this DataType represents a signed number.
  - isBounded
```
boolean isBounded()
```
    Returns true if DataType is fully bounded (bounded below and bounded above).
  - lowerBound
```
void lowerBound(T dest)
```
    Sets a given variable to the lower bound of the underlying NumericType. If this DataType is not bounded an UnsupportedOperationException is thrown.
  - upperBound
```
void upperBound(T dest)
```
    Sets a given variable to the upper bound of the underlying NumericType. If this DataType is not bounded an UnsupportedOperationException is thrown.
  - bitCount
```
int bitCount()
```
    Number of bits of information required to represent data in the type. If this DataType is of variable size returns -1.
  - createVariable
```
T createVariable()
```
    Returns a variable of the underlying NumericType wrapped by this DataType. Its value is zero.
  - cast
```
void cast(T val,
          BigComplex dest)
```
    Sets a BigComplex representation from a given variable of the underlying NumericType.
  - cast
```
void cast(BigComplex val,
          T dest)
```
    Sets a given variable of the underlying NumericType to a value that is closest to a given BigComplex number.
  - hasDoubleRepresentation
```
boolean hasDoubleRepresentation()
```
    Returns true if data can be encoded in a double with no precision loss.
  - hasLongRepresentation
```
boolean hasLongRepresentation()
```
    Returns true if data can be encoded in a long with no precision loss.
  - asDouble
```
double asDouble(T val)
```
    Converts value to a double. If this DataType has no double representation throws UnsupportedOperationException.
  - asLong
```
long asLong(T val)
```
    Converts value to a long. If this DataType has no long representation throws UnsupportedOperationException.
  - setDouble
```
void setDouble(T val,
               double v)
```
    Sets a given value to a given double. It is best to test appropriateness of such a call by checking if this DataType has a double representation. All DataTypes implement setDouble. No care is taken to avoid precision loss.
  - setLong
```
void setLong(T val,
             long v)
```
    Sets a given value to a given long. It is best to test appropriateness of such a call by checking if this DataType has a long representation. All DataTypes implement setLong. No care is taken to avoid precision loss.

Interface DataType<T extends NumericType<T>>

Method Summary

Methods inherited from interface org.scijava.Contextual

Method Detail

getType

shortName

longName

description

isComplex

isFloat

isSigned

isBounded

lowerBound

upperBound

bitCount

createVariable

cast

cast

hasDoubleRepresentation

hasLongRepresentation

asDouble

asLong

setDouble

setLong