ImageType (Mango Plugin API)

java.lang.Object
- edu.uthscsa.ric.volume.ImageType

All Implemented Interfaces:

Cloneable
```
public class ImageType
extends Object
implements Cloneable
```
ImageType stores information related to data type and data mask.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTE_TYPE_BINARY`
`static int`	`BYTE_TYPE_COMPLEX`
`static int`	`BYTE_TYPE_FLOAT`
`static int`	`BYTE_TYPE_INTEGER`
`static int`	`BYTE_TYPE_INTEGER_UNSIGNED`
`static int`	`BYTE_TYPE_RGB`
`static int`	`BYTE_TYPE_UNKNOWN`
`static int`	`COMPRESSION_TYPE_DICOM`
`static int`	`COMPRESSION_TYPE_DICOM_JPEG_BASELINE`
`static int`	`COMPRESSION_TYPE_DICOM_JPEG_LOSSLESS`
`static int`	`COMPRESSION_TYPE_DICOM_JPEG2000`
`static int`	`COMPRESSION_TYPE_DICOM_RLE`
`static int`	`COMPRESSION_TYPE_GZIP`
`static int`	`COMPRESSION_TYPE_NONE`

Constructor Summary

Constructors
Constructor and Description

ImageType(int numBytes, int byteType, int bitsStored, boolean littleEndian)
The only class constructor.

Constructors
Constructor and Description
`ImageType(int numBytes, int byteType, int bitsStored, boolean littleEndian)` The only class constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Returns a copy of this object.
`static ImageType`	`convertToSigned(ImageType it)` Converts datatype from unsigned integer to signed integer.
`long`	`createBitMask()` Returns a bit mask based on the number of bytes and bits stored per voxel.
`boolean`	`equals(Object obj)` Tests equality.
`int`	`getBitsStored()` Returns the number of bits stored.
`int`	`getByteType()` Returns the byte type code.
`String`	`getByteTypeString()` Returns the byte type name.
`static String`	`getByteTypeString(int aByteType)` Returns the byte type name associated with a byte type code.
`int`	`getCompressionType()` Returns the compression type.
`String`	`getCompressionTypeString()`
`ImageType`	`getNativeType()` If image data was loaded as a different type than what is specified in the header, store the native type here.
`int`	`getNumBytesPerVoxel()` Returns the number of bytes per voxel.
`double`	`getTypeMax(boolean forceAsUnsigned)` Get the maximum value of this type.
`double`	`getTypeMin(boolean forceAsUnsigned)` Get the minimum value of this type.
`double`	`getTypeMin(boolean forceAsUnsigned, boolean forceAsSigned)` Get the minimum value of this type.
`static ImageType`	`getWorkBufferImageType()` Returns an ImageType which is a 4-byte float, 32 bits stored, and big endian.
`int`	`hashCode()` Computes hash code.
`boolean`	`isAscii()` Returns true if ascii state flag is set.
`boolean`	`isCompressed()` Returns true if this data was compressed.
`boolean`	`isInteger()` Returns true if the byte type is integer.
`boolean`	`isLittleEndian()` Returns the byte order state.
`boolean`	`isRGB()`
`boolean`	`isRGBBySample()` Returns true if RGB data is stored by sample, rather than location.
`boolean`	`isRGBMode()` Returns true if the RGB data is to interpreted as color rather than intensity.
`boolean`	`isRGBPalette()` Returns true if this data uses a RGB palette.
`boolean`	`isValid()` Use to verify that values are valid.
`boolean`	`isValid(StringBuffer buf)` Returns true if this ImageType is valid, false otherwise.
`void`	`setAscii(boolean bool)` Set the ASCII state flag.
`void`	`setCompressionType(int compression)` Sets the compression type.
`void`	`setNativeType(ImageType nativeType)` Set the native image type.
`void`	`setRGBBySample(boolean isRGBBySample)` Sets whether RGB data is grouped by location or sample.
`void`	`setRGBMode(boolean isRGBMode)` Set to true to interpret this RGB data as color rather than intensity
`void`	`setRGBPalette(boolean isRGBPalette)` Sets to true if this data uses a RGB palette.
`void`	`setValues(ImageType it)` Set the values of this ImageType to that of another.
`String`	`toString()` Returns a string representation of this object.

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

- Field Detail
  - BYTE_TYPE_BINARY
```
public static final int BYTE_TYPE_BINARY
```
    See Also:
    Constant Field Values
  - BYTE_TYPE_COMPLEX
```
public static final int BYTE_TYPE_COMPLEX
```
    See Also:
    Constant Field Values
  - BYTE_TYPE_FLOAT
```
public static final int BYTE_TYPE_FLOAT
```
    See Also:
    Constant Field Values
  - BYTE_TYPE_INTEGER
```
public static final int BYTE_TYPE_INTEGER
```
    See Also:
    Constant Field Values
  - BYTE_TYPE_INTEGER_UNSIGNED
```
public static final int BYTE_TYPE_INTEGER_UNSIGNED
```
    See Also:
    Constant Field Values
  - BYTE_TYPE_RGB
```
public static final int BYTE_TYPE_RGB
```
    See Also:
    Constant Field Values
  - BYTE_TYPE_UNKNOWN
```
public static final int BYTE_TYPE_UNKNOWN
```
    See Also:
    Constant Field Values
  - COMPRESSION_TYPE_NONE
```
public static final int COMPRESSION_TYPE_NONE
```
    See Also:
    Constant Field Values
  - COMPRESSION_TYPE_GZIP
```
public static final int COMPRESSION_TYPE_GZIP
```
    See Also:
    Constant Field Values
  - COMPRESSION_TYPE_DICOM
```
public static final int COMPRESSION_TYPE_DICOM
```
    See Also:
    Constant Field Values
  - COMPRESSION_TYPE_DICOM_JPEG_BASELINE
```
public static final int COMPRESSION_TYPE_DICOM_JPEG_BASELINE
```
    See Also:
    Constant Field Values
  - COMPRESSION_TYPE_DICOM_JPEG_LOSSLESS
```
public static final int COMPRESSION_TYPE_DICOM_JPEG_LOSSLESS
```
    See Also:
    Constant Field Values
  - COMPRESSION_TYPE_DICOM_JPEG2000
```
public static final int COMPRESSION_TYPE_DICOM_JPEG2000
```
    See Also:
    Constant Field Values
  - COMPRESSION_TYPE_DICOM_RLE
```
public static final int COMPRESSION_TYPE_DICOM_RLE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ImageType
```
public ImageType(int numBytes,
         int byteType,
         int bitsStored,
         boolean littleEndian)
```
    The only class constructor.
    
    Parameters:
    numBytes - number of bytes per voxel
    byteType - byte type code
    bitsStored - number of bits stored per voxel
    littleEndian - byte order of the data
- Method Detail
  - convertToSigned
```
public static ImageType convertToSigned(ImageType it)
```
    Converts datatype from unsigned integer to signed integer. If not unsigned integer, nothing is changed.
    
    Parameters:
    it - the ImageType object
    
    Returns:
    the same ImageType object
  - getByteTypeString
```
public static String getByteTypeString(int aByteType)
```
    Returns the byte type name associated with a byte type code.
    
    Parameters:
    aByteType - the byte type code
    
    Returns:
    byte type name
  - getWorkBufferImageType
```
public static ImageType getWorkBufferImageType()
```
    Returns an ImageType which is a 4-byte float, 32 bits stored, and big endian.
    
    Returns:
    an ImageType of a work buffer
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    cloned object
    
    Throws:
    
    CloneNotSupportedException - clone not supported exception
  - createBitMask
```
public long createBitMask()
```
    Returns a bit mask based on the number of bytes and bits stored per voxel.
    
    Returns:
    bit mask
  - equals
```
public boolean equals(Object obj)
```
    Tests equality.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - object to compare
    
    Returns:
    true if the objects are equals, false otherwise
  - getBitsStored
```
public int getBitsStored()
```
    Returns the number of bits stored.
    
    Returns:
    number of bits stored
  - getByteType
```
public int getByteType()
```
    Returns the byte type code.
    
    Returns:
    byte type code
  - getByteTypeString
```
public String getByteTypeString()
```
    Returns the byte type name.
    
    Returns:
    byte type name
  - getCompressionTypeString
```
public String getCompressionTypeString()
```
  - getNativeType
```
public ImageType getNativeType()
```
    If image data was loaded as a different type than what is specified in the header, store the native type here.
    
    Returns:
    the native image type
  - getNumBytesPerVoxel
```
public int getNumBytesPerVoxel()
```
    Returns the number of bytes per voxel.
    
    Returns:
    number of bytes per voxel
  - getTypeMax
```
public double getTypeMax(boolean forceAsUnsigned)
```
    Get the maximum value of this type.
    
    Parameters:
    forceAsUnsigned - force method to consider type as unsigned
    
    Returns:
    max value
  - getTypeMin
```
public double getTypeMin(boolean forceAsUnsigned)
```
    Get the minimum value of this type.
    
    Parameters:
    forceAsUnsigned - force method to consider type as unsigned
    
    Returns:
    min value
  - getTypeMin
```
public double getTypeMin(boolean forceAsUnsigned,
                boolean forceAsSigned)
```
    Get the minimum value of this type.
    
    Parameters:
    forceAsUnsigned - force method to consider type as unsigned
    forceAsSigned - force method to consider type as signed
    
    Returns:
    min value
  - hashCode
```
public int hashCode()
```
    Computes hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash code
  - isAscii
```
public boolean isAscii()
```
    Returns true if ascii state flag is set.
    
    Returns:
    true if ascii state flag is set
  - isInteger
```
public boolean isInteger()
```
    Returns true if the byte type is integer.
    
    Returns:
    true if the byte type is integer
  - isLittleEndian
```
public boolean isLittleEndian()
```
    Returns the byte order state.
    
    Returns:
    true if byte order is little endian; false otherwise
  - isRGB
```
public boolean isRGB()
```
  - isRGBBySample
```
public boolean isRGBBySample()
```
    Returns true if RGB data is stored by sample, rather than location.
    
    Returns:
    true if RGB data is stored by sample
  - isRGBMode
```
public boolean isRGBMode()
```
    Returns true if the RGB data is to interpreted as color rather than intensity.
    
    Returns:
    true if the RGB data is to interpreted as color
  - isRGBPalette
```
public boolean isRGBPalette()
```
    Returns true if this data uses a RGB palette.
    
    Returns:
    true if this data uses a RGB palette
  - isValid
```
public boolean isValid()
```
    Use to verify that values are valid.
    
    Returns:
    true if valid
  - isValid
```
public boolean isValid(StringBuffer buf)
```
    Returns true if this ImageType is valid, false otherwise. Any error messages will be stored in the specified StringBuffer.
    
    Parameters:
    buf - StringBuffer to hold messages
    
    Returns:
    true if the ImageType is valid, false otherwise
  - setAscii
```
public void setAscii(boolean bool)
```
    Set the ASCII state flag.
    
    Parameters:
    bool - true if data is in ASCII form, false otherwise
  - setNativeType
```
public void setNativeType(ImageType nativeType)
```
    Set the native image type.
    
    Parameters:
    nativeType - the native image type
  - setRGBBySample
```
public void setRGBBySample(boolean isRGBBySample)
```
    Sets whether RGB data is grouped by location or sample.
    
    Parameters:
    isRGBBySample - true if RGB data is grouped by sample, false otherwise
  - setRGBMode
```
public void setRGBMode(boolean isRGBMode)
```
    Set to true to interpret this RGB data as color rather than intensity
    
    Parameters:
    isRGBMode - true to interpret RGB data as color
  - setRGBPalette
```
public void setRGBPalette(boolean isRGBPalette)
```
    Sets to true if this data uses a RGB palette.
    
    Parameters:
    isRGBPalette - true if this data uses a RGB palette, false otherwise
  - setValues
```
public void setValues(ImageType it)
```
    Set the values of this ImageType to that of another.
    
    Parameters:
    it - replacement ImageType object
  - toString
```
public String toString()
```
    Returns a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this object
  - isCompressed
```
public boolean isCompressed()
```
    Returns true if this data was compressed.
    
    Returns:
    true if this data was compressed
  - getCompressionType
```
public int getCompressionType()
```
    Returns the compression type.
    
    Returns:
    the compression type
  - setCompressionType
```
public void setCompressionType(int compression)
```
    Sets the compression type.
    
    Parameters:
    compression - the compression type

Class ImageType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BYTE_TYPE_BINARY

BYTE_TYPE_COMPLEX

BYTE_TYPE_FLOAT

BYTE_TYPE_INTEGER

BYTE_TYPE_INTEGER_UNSIGNED

BYTE_TYPE_RGB

BYTE_TYPE_UNKNOWN

COMPRESSION_TYPE_NONE

COMPRESSION_TYPE_GZIP

COMPRESSION_TYPE_DICOM

COMPRESSION_TYPE_DICOM_JPEG_BASELINE

COMPRESSION_TYPE_DICOM_JPEG_LOSSLESS

COMPRESSION_TYPE_DICOM_JPEG2000

COMPRESSION_TYPE_DICOM_RLE

Constructor Detail

ImageType

Method Detail

convertToSigned

getByteTypeString

getWorkBufferImageType

clone

createBitMask

equals

getBitsStored

getByteType

getByteTypeString

getCompressionTypeString

getNativeType

getNumBytesPerVoxel

getTypeMax

getTypeMin

getTypeMin

hashCode

isAscii

isInteger

isLittleEndian

isRGB

isRGBBySample

isRGBMode

isRGBPalette

isValid

isValid

setAscii

setNativeType

setRGBBySample

setRGBMode

setRGBPalette

setValues

toString

isCompressed

getCompressionType

setCompressionType