WritableHeader (Mango Plugin API)

All Superinterfaces:

MangoPluginType, ReadableHeader
```
public interface WritableHeader
extends ReadableHeader
```
A class that implements WritableHeader can be registered with Mango to extend the types of image header formats that can be written. WritableHeader extends ReadableHeader, hence any class that implements this interface must be able to both read and write the header.

Field Summary
- Fields inherited from interface edu.uthscsa.ric.volume.ReadableHeader
  ORIENTATION_CERTAINTY_HIGH, ORIENTATION_CERTAINTY_LOW, ORIENTATION_CERTAINTY_MID

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canCompress()` Returns true if the format supports compressed data.
`File`	`formatImageFile(File headerFile)` Returns a formatted image file (string) based on a header file (i.e., a header type might have a convention for naming the image file relative to header file name).
`int[]`	`getSupportedBytesForType(int type)` Returns an array of byte counts that supported for a datatype.
`String[]`	`getSupportedOrientations()` Returns an array of valid data orientations in the format "XYZ+--" where the first character represents the fastest moving dimension and that third character represents the slowest moving dimension.
`int[]`	`getSupportedTypesForBytes(int bytes)` Returns an array of datatypes that are supported for a number of bytes.
`boolean`	`isSupportedBigEndian()` Returns true if this image format supports writing in big endian byte order.
`boolean`	`isSupportedDataScaleIntercept()` Returns true if this image format supports a data scale intercept.
`boolean`	`isSupportedDataScaleSlope()` Returns true if this image format supports a data scale slope.
`boolean`	`isSupportedLittleEndian()` Returns true if this image format supports writing in little endian byte order.
`boolean`	`isSupportedMultipleDataScales()` Returns true if this image format supports multiple data scale values, such as a data scale per slice or per volume.
`boolean`	`willWriteImage()` If for some reason the application should not attempt to write the image (i.e., the image is not stored as contiguous data), then this method should return true.
`byte[]`	`writeHeader(ImageDimensions id, VoxelDimensions vd, ImageType it, ImageRange ir, ImageDescription imdes, boolean compress, Coordinate origin, String orientation, ImageTransform[] transforms, File headerFile, File imageFile, ByteBuffer[] imageBuffers, File tempDir)` Writes the header.
`byte[][]`	`writeSeriesHeaders(ImageDimensions id, VoxelDimensions vd, ImageType it, ImageRange ir, ImageDescription imdes, boolean compress, Coordinate origin, String orientation, ImageTransform[] transforms, File headerFile, File imageFile, ByteBuffer[] imageBuffers, File tempDir)` Writes a series of headers.

Methods inherited from interface edu.uthscsa.ric.volume.ReadableHeader
getImage, getImageBuffers, getImageDescription, getImageDimensions, getImageFile, getImageRange, getImageType, getOrientation, getOrientationCertainty, getOrigin, getPreferredFileExtension, getPreviewImage, getSliceAnnotation, getSliceMetadata, getTransforms, getVoxelDimensions, isThisFormat, readHeader, readHeader, toString

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType
getMinimumVersionSupported, getPluginName, getPluginURL, getVersion, hasNewerVersion

- Method Detail
  - canCompress
```
boolean canCompress()
```
    Returns true if the format supports compressed data.
    
    Returns:
    true if the format supports compressed data
  - formatImageFile
```
File formatImageFile(File headerFile)
```
    Returns a formatted image file (string) based on a header file (i.e., a header type might have a convention for naming the image file relative to header file name). It is possible that the header and image data are stored in the same file and so this method may simply return the file parameter.
    
    Parameters:
    headerFile - the header file
    
    Returns:
    the formatted image file or null if the image file should not be written by the application
  - getSupportedBytesForType
```
int[] getSupportedBytesForType(int type)
```
    Returns an array of byte counts that supported for a datatype.
    
    Parameters:
    type - the datatype (see ImageType for possible values)
    
    Returns:
    an array of supported byte counts or null if none
  - getSupportedOrientations
```
String[] getSupportedOrientations()
```
    Returns an array of valid data orientations in the format "XYZ+--" where the first character represents the fastest moving dimension and that third character represents the slowest moving dimension. The fourth through the sixth characters represent the sense of the dimensions. If this method returns null or an empty array, then it is assumed all orientations are supported.
    
    Returns:
    an array of supported orientation strings or null if all orientations are supported
  - getSupportedTypesForBytes
```
int[] getSupportedTypesForBytes(int bytes)
```
    Returns an array of datatypes that are supported for a number of bytes.
    
    Parameters:
    bytes - the number of bytes (possible values will be 1, 2, or 4)
    
    Returns:
    an array of supported datatypes or null if none
  - isSupportedBigEndian
```
boolean isSupportedBigEndian()
```
    Returns true if this image format supports writing in big endian byte order.
    
    Returns:
    true if this image format supports writing in big endian byte order
  - isSupportedDataScaleIntercept
```
boolean isSupportedDataScaleIntercept()
```
    Returns true if this image format supports a data scale intercept.
    
    Returns:
    true if this image format supports a data scale intercept
  - isSupportedDataScaleSlope
```
boolean isSupportedDataScaleSlope()
```
    Returns true if this image format supports a data scale slope.
    
    Returns:
    true if this image format supports a data scale slope
  - isSupportedLittleEndian
```
boolean isSupportedLittleEndian()
```
    Returns true if this image format supports writing in little endian byte order.
    
    Returns:
    true if this image format supports writing in little endian byte order
  - isSupportedMultipleDataScales
```
boolean isSupportedMultipleDataScales()
```
    Returns true if this image format supports multiple data scale values, such as a data scale per slice or per volume.
    
    Returns:
    true if this image format supports multiple data scale values
  - willWriteImage
```
boolean willWriteImage()
```
    If for some reason the application should not attempt to write the image (i.e., the image is not stored as contiguous data), then this method should return true. Otherwise, it should return false
    
    Returns:
    true if the plugin will write the image file, false if the application should write the image file
  - writeHeader
```
byte[] writeHeader(ImageDimensions id,
                 VoxelDimensions vd,
                 ImageType it,
                 ImageRange ir,
                 ImageDescription imdes,
                 boolean compress,
                 Coordinate origin,
                 String orientation,
                 ImageTransform[] transforms,
                 File headerFile,
                 File imageFile,
                 ByteBuffer[] imageBuffers,
                 File tempDir)
                   throws Exception
```
    Writes the header. Formats that precatenate the header data to the image file should return a byte array containing the header data instead of writing directly to the file.
    
    Parameters:
    id - image dimensions
    vd - voxel dimensions
    it - image type
    ir - image range
    imdes - image description
    compress - user selected compression option (if supported, plugin should write gzip compressed header file to disk)
    origin - the origin voxel location relative to the native orientation of the data
    orientation - the orientation (e.g., XYZ+--)
    transforms - an array of image transforms (image or world) or null if there is none
    headerFile - the file that this header will be written to
    imageFile - image file (if same as header file, data should be returned as byte array)
    imageBuffers - the image buffer (contains float data)
    tempDir - directory to store temporary files, if necessary
    
    Returns:
    data that will be precatenated to the image file (e.g., the header) or null if there is none
    
    Throws:
    
    Exception - exception
  - writeSeriesHeaders
```
byte[][] writeSeriesHeaders(ImageDimensions id,
                          VoxelDimensions vd,
                          ImageType it,
                          ImageRange ir,
                          ImageDescription imdes,
                          boolean compress,
                          Coordinate origin,
                          String orientation,
                          ImageTransform[] transforms,
                          File headerFile,
                          File imageFile,
                          ByteBuffer[] imageBuffers,
                          File tempDir)
                            throws Exception
```
    Writes a series of headers. Formats that precatenate the header data to the image file should return a byte array containing the header data instead of writing directly to the file.
    
    Parameters:
    id - image dimensions
    vd - voxel dimensions
    it - image type
    ir - image range
    imdes - image description
    compress - user selected compression option (if supported, plugin should write gzip compressed header file to disk)
    origin - the origin voxel location relative to the native orientation of the data
    orientation - the orientation (e.g., XYZ+--)
    transforms - an array of image transforms (image or world) or null if there is none
    headerFile - the file that this header will be written to
    imageFile - image file (if same as header file, data should be returned as byte array)
    imageBuffers - the image buffer (contains float data)
    tempDir - directory to store temporary files, if necessary
    
    Returns:
    data that will be precatenated to the image file (e.g., the header) or null if there is none
    
    Throws:
    
    Exception - exception

Interface WritableHeader

Field Summary

Fields inherited from interface edu.uthscsa.ric.volume.ReadableHeader

Method Summary

Methods inherited from interface edu.uthscsa.ric.volume.ReadableHeader

Methods inherited from interface edu.uthscsa.ric.mango.MangoPluginType

Method Detail

canCompress

formatImageFile

getSupportedBytesForType

getSupportedOrientations

getSupportedTypesForBytes

isSupportedBigEndian

isSupportedDataScaleIntercept

isSupportedDataScaleSlope

isSupportedLittleEndian

isSupportedMultipleDataScales

willWriteImage

writeHeader

writeSeriesHeaders