loci.formats.out

Class ImageIOWriter

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatWriter

loci.formats.out.ImageIOWriter

All Implemented Interfaces:

loci.formats.IFormatHandler, loci.formats.IFormatWriter, loci.formats.StatusReporter

Direct Known Subclasses:

JPEGWriter, PNGWriter

public abstract class ImageIOWriter
extends loci.formats.FormatWriter

ImageIOWriter is the superclass for file format writers that use the javax.imageio library.

Source code:

Trac, SVN

Author:

Curtis Rueden ctrueden at wisc.edu

Field Summary

Fields

Modifier and Type	Field and Description
protected String	kind
protected DataOutputStream	out

Fields inherited from class loci.formats.FormatWriter

cm, compression, compressionTypes, fps, initialized, metadataRetrieve

Fields inherited from class loci.formats.FormatHandler

currentId, debug, debugLevel, format, statusListeners, suffixes

Constructor Summary

Constructors

Constructor and Description
ImageIOWriter(String format, String[] suffixes, String kind) Constructs an ImageIO-based writer with the given name, default suffixes and output type (e.g., png, jpeg).
ImageIOWriter(String format, String suffix, String kind) Constructs an ImageIO-based writer with the given name, default suffix and output type (e.g., png, jpeg).

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes currently open file(s) and frees allocated memory.
int[]	getPixelTypes() Gets the supported pixel types.
void	saveImage(Image image, boolean last) Saves the given image to the current file.

Methods inherited from class loci.formats.FormatWriter

canDoStacks, canDoStacks, getColorModel, getCompressionTypes, getFramesPerSecond, getMetadataRetrieve, getPixelTypes, isSupportedType, isSupportedType, save, saveBytes, saveBytes, saveImage, setColorModel, setCompression, setFramesPerSecond, setId, setMetadataRetrieve

Methods inherited from class loci.formats.FormatHandler

addStatusListener, debug, getFormat, getStatusListeners, getSuffixes, isThisType, isThisType, removeStatusListener, setDebug, setDebugLevel, setId, status, status, status, trace, trace

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, getSuffixes, isThisType, isThisType, setId

Methods inherited from interface loci.formats.StatusReporter

addStatusListener, getStatusListeners, removeStatusListener

Field Detail

kind

protected String kind

out

protected DataOutputStream out

Constructor Detail

ImageIOWriter

public ImageIOWriter(String format,
             String suffix,
             String kind)

Constructs an ImageIO-based writer with the given name, default suffix and output type (e.g., png, jpeg).

ImageIOWriter

public ImageIOWriter(String format,
             String[] suffixes,
             String kind)

Constructs an ImageIO-based writer with the given name, default suffixes and output type (e.g., png, jpeg).

Method Detail

saveImage

public void saveImage(Image image,
             boolean last)
               throws loci.formats.FormatException,
                      IOException

Description copied from interface: loci.formats.IFormatWriter

Saves the given image to the current file. If this image is the last one in the file, the last flag must be set.

Throws:

loci.formats.FormatException

IOException

getPixelTypes

public int[] getPixelTypes()

Description copied from interface: loci.formats.IFormatWriter

Gets the supported pixel types.

Specified by:

getPixelTypes in interface loci.formats.IFormatWriter

Overrides:

getPixelTypes in class loci.formats.FormatWriter

close

public void close()
           throws IOException

Description copied from interface: loci.formats.IFormatHandler

Closes currently open file(s) and frees allocated memory.

Throws:

IOException