DataType1BitUnsignedInteger (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - net.imagej.types.DataType1BitUnsignedInteger

All Implemented Interfaces:

ImageJPlugin, DataType<BitType>, Contextual, SciJavaPlugin, SingletonPlugin
```
public class DataType1BitUnsignedInteger
extends AbstractContextual
implements DataType<BitType>
```
DataType definition for 1-bit unsigned integers.

Author:

Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

DataType1BitUnsignedInteger()

Constructors
Constructor and Description
`DataType1BitUnsignedInteger()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`asDouble(BitType val)` Converts value to a double.
`long`	`asLong(BitType val)` Converts value to a long.
`int`	`bitCount()` Number of bits of information required to represent data in the type.
`void`	`cast(BigComplex val, BitType dest)` Sets a given variable of the underlying NumericType to a value that is closest to a given BigComplex number.
`void`	`cast(BitType val, BigComplex dest)` Sets a BigComplex representation from a given variable of the underlying NumericType.
`BitType`	`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.
`BitType`	`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(BitType dest)` Sets a given variable to the lower bound of the underlying NumericType.
`void`	`setDouble(BitType val, double v)` Sets a given value to a given double.
`void`	`setLong(BitType val, long v)` Sets a given value to a given long.
`String`	`shortName()` A short name useful for displaying to user.
`void`	`upperBound(BitType dest)` Sets a given variable to the upper bound of the underlying NumericType.

Methods inherited from class org.scijava.AbstractContextual
context, getContext

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

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

- Constructor Detail
  - DataType1BitUnsignedInteger
```
public DataType1BitUnsignedInteger()
```
- Method Detail
  - getType
```
public BitType getType()
```
    Description copied from interface: DataType
    
    Provides an example of the underlying NumericType.
    
    Specified by:
    
    getType in interface DataType<BitType>
  - shortName
```
public String shortName()
```
    Description copied from interface: DataType
    
    A short name useful for displaying to user.
    
    Specified by:
    
    shortName in interface DataType<BitType>
  - longName
```
public String longName()
```
    Description copied from interface: DataType
    
    A long name useful for displaying to user.
    
    Specified by:
    
    longName in interface DataType<BitType>
  - description
```
public String description()
```
    Description copied from interface: DataType
    
    A fuller description that elaborates on the capabilities of the type.
    
    Specified by:
    
    description in interface DataType<BitType>
  - isComplex
```
public boolean isComplex()
```
    Description copied from interface: DataType
    
    Returns true if this DataType is a complex number (imaginary component is changeable).
    
    Specified by:
    
    isComplex in interface DataType<BitType>
  - isFloat
```
public boolean isFloat()
```
    Description copied from interface: DataType
    
    Returns true if this DataType represents a floating point number.
    
    Specified by:
    
    isFloat in interface DataType<BitType>
  - isSigned
```
public boolean isSigned()
```
    Description copied from interface: DataType
    
    Returns true if this DataType represents a signed number.
    
    Specified by:
    
    isSigned in interface DataType<BitType>
  - isBounded
```
public boolean isBounded()
```
    Description copied from interface: DataType
    
    Returns true if DataType is fully bounded (bounded below and bounded above).
    
    Specified by:
    
    isBounded in interface DataType<BitType>
  - lowerBound
```
public void lowerBound(BitType dest)
```
    Description copied from interface: DataType
    
    Sets a given variable to the lower bound of the underlying NumericType. If this DataType is not bounded an UnsupportedOperationException is thrown.
    
    Specified by:
    
    lowerBound in interface DataType<BitType>
  - upperBound
```
public void upperBound(BitType dest)
```
    Description copied from interface: DataType
    
    Sets a given variable to the upper bound of the underlying NumericType. If this DataType is not bounded an UnsupportedOperationException is thrown.
    
    Specified by:
    
    upperBound in interface DataType<BitType>
  - bitCount
```
public int bitCount()
```
    Description copied from interface: DataType
    
    Number of bits of information required to represent data in the type. If this DataType is of variable size returns -1.
    
    Specified by:
    
    bitCount in interface DataType<BitType>
  - createVariable
```
public BitType createVariable()
```
    Description copied from interface: DataType
    
    Returns a variable of the underlying NumericType wrapped by this DataType. Its value is zero.
    
    Specified by:
    
    createVariable in interface DataType<BitType>
  - cast
```
public void cast(BitType val,
                 BigComplex dest)
```
    Description copied from interface: DataType
    
    Sets a BigComplex representation from a given variable of the underlying NumericType.
    
    Specified by:
    
    cast in interface DataType<BitType>
  - cast
```
public void cast(BigComplex val,
                 BitType dest)
```
    Description copied from interface: DataType
    
    Sets a given variable of the underlying NumericType to a value that is closest to a given BigComplex number.
    
    Specified by:
    
    cast in interface DataType<BitType>
  - hasDoubleRepresentation
```
public boolean hasDoubleRepresentation()
```
    Description copied from interface: DataType
    
    Returns true if data can be encoded in a double with no precision loss.
    
    Specified by:
    
    hasDoubleRepresentation in interface DataType<BitType>
  - hasLongRepresentation
```
public boolean hasLongRepresentation()
```
    Description copied from interface: DataType
    
    Returns true if data can be encoded in a long with no precision loss.
    
    Specified by:
    
    hasLongRepresentation in interface DataType<BitType>
  - asDouble
```
public double asDouble(BitType val)
```
    Description copied from interface: DataType
    
    Converts value to a double. If this DataType has no double representation throws UnsupportedOperationException.
    
    Specified by:
    
    asDouble in interface DataType<BitType>
  - asLong
```
public long asLong(BitType val)
```
    Description copied from interface: DataType
    
    Converts value to a long. If this DataType has no long representation throws UnsupportedOperationException.
    
    Specified by:
    
    asLong in interface DataType<BitType>
  - setDouble
```
public void setDouble(BitType val,
                      double v)
```
    Description copied from interface: DataType
    
    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.
    
    Specified by:
    
    setDouble in interface DataType<BitType>
  - setLong
```
public void setLong(BitType val,
                    long v)
```
    Description copied from interface: DataType
    
    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.
    
    Specified by:
    
    setLong in interface DataType<BitType>

Class DataType1BitUnsignedInteger

Constructor Summary

Method Summary

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.Contextual

Constructor Detail

DataType1BitUnsignedInteger

Method Detail

getType

shortName

longName

description

isComplex

isFloat

isSigned

isBounded

lowerBound

upperBound

bitCount

createVariable

cast

cast

hasDoubleRepresentation

hasLongRepresentation

asDouble

asLong

setDouble

setLong