loci.formats.out

Class ImageIOWriter

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatWriter

loci.formats.out.ImageIOWriter

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatWriter, IMetadataConfigurable

Direct Known Subclasses:

JPEGWriter

public abstract class ImageIOWriter
extends FormatWriter

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

Author:

Curtis Rueden ctrueden at wisc.edu

Field Summary

Fields

Modifier and Type	Field and Description
protected String	kind

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, metadataOptions, 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
Class<?>	getNativeDataType() Returns the native data type of image planes for this reader, as returned by IFormatReader.openPlane(int, int, int, int, int) or IFormatWriter.savePlane(int, java.lang.Object).
int[]	getPixelTypes(String codec) Gets the supported pixel types for the given codec.
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	savePlane(int no, Object plane, int x, int y, int w, int h) Saves the given image plane to the current series in the current file.

Methods inherited from class loci.formats.FormatWriter

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

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getMetadataOptions, 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.IFormatHandler

getFormat, getSuffixes, isThisType

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Detail

kind

protected String kind

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

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.

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)

savePlane

public void savePlane(int no,
             Object plane,
             int x,
             int y,
             int w,
             int h)
               throws FormatException,
                      IOException

Description copied from interface: IFormatWriter

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

Specified by:

savePlane in interface IFormatWriter

Overrides:

savePlane in class FormatWriter

Parameters:

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

plane - the image plane.

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.savePlane(int, Object, int, int, int, int)

getPixelTypes

public int[] getPixelTypes(String codec)

Description copied from interface: IFormatWriter

Gets the supported pixel types for the given codec.

Specified by:

getPixelTypes in interface IFormatWriter

Overrides:

getPixelTypes in class FormatWriter

getNativeDataType

public Class<?> getNativeDataType()

Description copied from interface: IFormatHandler

Returns the native data type of image planes for this reader, as returned by IFormatReader.openPlane(int, int, int, int, int) or IFormatWriter.savePlane(int, java.lang.Object). For most readers this type will be a byte array; however, some readers call external APIs that work with other types such as BufferedImage.

Specified by:

getNativeDataType in interface IFormatHandler

Overrides:

getNativeDataType in class FormatHandler