loci.formats.out

Class OMETiffWriter

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatWriter

loci.formats.out.TiffWriter

loci.formats.out.OMETiffWriter

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatWriter

public class OMETiffWriter
extends TiffWriter

OMETiffWriter is the file format writer for OME-TIFF files.

Source code:

Trac, Gitweb

Field Summary

Fields inherited from class loci.formats.out.TiffWriter

COMPRESSION_J2K, COMPRESSION_J2K_LOSSY, COMPRESSION_JPEG, COMPRESSION_LZW, COMPRESSION_UNCOMPRESSED, in, isBigTiff, tiffSaver

Fields inherited from class loci.formats.FormatWriter

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

Fields inherited from class loci.formats.FormatHandler

COMPRESSION_SUFFIXES, currentId, format, LOGGER, suffixes

Constructor Summary

Constructors

Constructor and Description
OMETiffWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	saveBytes(int no, byte[] buf, IFD ifd, int x, int y, int w, int h) Saves the given image to the specified series in the current file.
void	saveBytes(int no, byte[] buf, int x, int y, int w, int h) Saves the given image tile to the current series in the current file.
void	setId(String id) Sets the current file name.

Methods inherited from class loci.formats.out.TiffWriter

canDoStacks, getPixelTypes, getPlaneCount, saveBytes, setBigTiff

Methods inherited from class loci.formats.FormatWriter

changeOutputFile, checkParams, getColorModel, getCompression, getCompressionTypes, getFramesPerSecond, getMetadataRetrieve, getPixelTypes, getSamplesPerPixel, getSeries, isFullPlane, isInterleaved, isSupportedType, saveBytes, saveBytes, savePlane, savePlane, savePlane, seekToPlaneOffset, setCodecOptions, setColorModel, setCompression, setFramesPerSecond, setInterleaved, setMetadataRetrieve, setSeries, setValidBitsPerPixel, setWriteSequentially

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getNativeDataType, getSuffixes, isThisType

Methods inherited from class java.lang.Object

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

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getNativeDataType, getSuffixes, isThisType

Constructor Detail

OMETiffWriter

public OMETiffWriter()

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class TiffWriter

Throws:

IOException

saveBytes

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

Description copied from interface: IFormatWriter

Saves the given image tile to the current series in the current file.

Specified by:

saveBytes in interface IFormatWriter

Overrides:

saveBytes in class TiffWriter

Parameters:

no - the image index within the current file, starting from 0.

buf - the byte array that represents the image tile.

x - the X coordinate of the upper-left corner of the image tile.

y - the Y coordinate of the upper-left corner of the image tile.

w - the width (in pixels) of the image tile.

h - the height (in pixels) of the image tile.

Throws:

FormatException - if one of the parameters is invalid.

IOException - if there was a problem writing to the file.

See Also:

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

saveBytes

public void saveBytes(int no,
             byte[] buf,
             IFD ifd,
             int x,
             int y,
             int w,
             int h)
               throws FormatException,
                      IOException

Description copied from class: TiffWriter

Saves the given image to the specified series in the current file. The IFD hashtable allows specification of TIFF parameters such as bit depth, compression and units.

Overrides:

saveBytes in class TiffWriter

Throws:

FormatException

IOException

See Also:

loci.formats.IFormatWriter#saveBytes(int, byte[], IFD, int, int, int, int)

setId

public void setId(String id)
           throws FormatException,
                  IOException

Description copied from interface: IFormatHandler

Sets the current file name.

Specified by:

setId in interface IFormatHandler

Overrides:

setId in class TiffWriter

Throws:

FormatException

IOException