Package loci.formats.out

Class OMEXMLWriter

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatWriter

loci.formats.out.OMEXMLWriter

All Implemented Interfaces:

Closeable, AutoCloseable, loci.formats.ICompressedTileWriter, loci.formats.IFormatHandler, loci.formats.IFormatWriter, loci.formats.IMetadataConfigurable, loci.formats.IPyramidHandler

public class OMEXMLWriter
extends loci.formats.FormatWriter

OMEXMLWriter is the file format writer for OME-XML files.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREATOR_KEY

Fields inherited from class loci.formats.FormatWriter

cm, compression, compressionTypes, fps, initialized, interleaved, metadataRetrieve, options, out, resolution, resolutionData, sequential, series, validBits

Fields inherited from class loci.formats.FormatHandler

COMPRESSION_SUFFIXES, currentId, format, LOGGER, metadataOptions, suffixes

Constructor Summary

Constructors

Constructor	Description
OMEXMLWriter()

Method Summary

Modifier and Type	Method	Description
boolean	canDoStacks()
void	close()
int[]	getPixelTypes(String codec)
boolean	preserveCreator()	Get the value of the CREATOR_KEY option.
void	saveBytes(int no, byte[] buf, int x, int y, int w, int h)
void	setId(String id)

Methods inherited from class loci.formats.FormatWriter

changeOutputFile, checkParams, createOutputStream, getCodecOptions, getColorModel, getCompression, getCompressionTypes, getFramesPerSecond, getMetadataRetrieve, getPixelTypes, getPlaneCount, getPlaneCount, getResolution, getResolutionCount, getResolutions, getSamplesPerPixel, getSamplesPerPixel, getSeries, getSizeX, getSizeY, getTileSizeX, getTileSizeY, hasResolutions, isFullPlane, isInterleaved, isSupportedType, saveBytes, saveBytes, savePlane, savePlane, savePlane, seekToPlaneOffset, setCodecOptions, setColorModel, setCompression, setFramesPerSecond, setInterleaved, setMetadataRetrieve, setResolution, setResolutions, setSeries, setTileSizeX, setTileSizeY, setValidBitsPerPixel, setWriteSequentially

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, isThisType, setMetadataOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface loci.formats.ICompressedTileWriter

getCodec, saveCompressedBytes

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getNativeDataType, getSuffixes, isThisType

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Details

CREATOR_KEY

public static final String CREATOR_KEY

See Also:

• Constant Field Values

Constructor Details

OMEXMLWriter

public OMEXMLWriter()

Method Details

setId

public void setId(String id)
           throws loci.formats.FormatException,
IOException

Specified by:

setId in interface loci.formats.IFormatHandler

Overrides:

setId in class loci.formats.FormatWriter

Throws:

loci.formats.FormatException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class loci.formats.FormatWriter

Throws:

IOException

saveBytes

public void saveBytes(int no,
 byte[] buf,
 int x,
 int y,
 int w,
 int h)
               throws loci.formats.FormatException,
IOException

Throws:

loci.formats.FormatException

IOException

See Also:

• IFormatWriter.saveBytes(int, byte[], int, int, int, int)

canDoStacks

public boolean canDoStacks()

Specified by:

canDoStacks in interface loci.formats.IFormatWriter

Overrides:

canDoStacks in class loci.formats.FormatWriter

getPixelTypes

public int[] getPixelTypes(String codec)

Specified by:

getPixelTypes in interface loci.formats.IFormatWriter

Overrides:

getPixelTypes in class loci.formats.FormatWriter

preserveCreator

public boolean preserveCreator()

Get the value of the CREATOR_KEY option. This toggles whether or not the OME Creator attribute will be overwritten with the current Bio-Formats version. For input data that does not have a Creator attribute defined, this makes no difference. By default, returns false, i.e. the Creator will be overwritten if it exists.

Returns:

true if the Creator attribute should be preserved (if it exists)