Package loci.formats.out

Class ImageIOWriter

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatWriter

loci.formats.out.ImageIOWriter

All Implemented Interfaces:

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

Direct Known Subclasses:

JPEGWriter

public abstract class ImageIOWriter
extends loci.formats.FormatWriter

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	kind

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
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

Modifier and Type	Method	Description
Class<?>	getNativeDataType()
int[]	getPixelTypes(String codec)
void	saveBytes(int no, byte[] buf, int x, int y, int w, int h)
void	savePlane(int no, Object plane, int x, int y, int w, int h)

Methods inherited from class loci.formats.FormatWriter

canDoStacks, changeOutputFile, checkParams, close, 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, seekToPlaneOffset, setCodecOptions, setColorModel, setCompression, setFramesPerSecond, setId, setInterleaved, setMetadataRetrieve, setResolution, setResolutions, setSeries, setTileSizeX, setTileSizeY, 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.ICompressedTileWriter

getCodec, saveCompressedBytes

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getSuffixes, isThisType

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Details

kind

protected String kind

Constructor Details

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 Details

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)

savePlane

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

Specified by:

savePlane in interface loci.formats.IFormatWriter

Overrides:

savePlane in class loci.formats.FormatWriter

Throws:

loci.formats.FormatException

IOException

See Also:

• IFormatWriter.savePlane(int, Object, int, int, int, int)

getPixelTypes

public int[] getPixelTypes(String codec)

Specified by:

getPixelTypes in interface loci.formats.IFormatWriter

Overrides:

getPixelTypes in class loci.formats.FormatWriter

getNativeDataType

public Class<?> getNativeDataType()

Specified by:

getNativeDataType in interface loci.formats.IFormatHandler

Overrides:

getNativeDataType in class loci.formats.FormatHandler