loci.formats.gui

Class BufferedImageWriter

java.lang.Object

loci.formats.WriterWrapper

loci.formats.gui.BufferedImageWriter

All Implemented Interfaces:

Closeable, AutoCloseable, IFormatHandler, IFormatWriter

public class BufferedImageWriter
extends WriterWrapper

A writer wrapper for writing image planes from BufferedImage objects.

Source code:

Trac, Gitweb

Field Summary

Fields inherited from class loci.formats.WriterWrapper

writer

Constructor Summary

Constructors

Constructor and Description
BufferedImageWriter() Constructs a BufferedImageWriter around a new image writer.
BufferedImageWriter(IFormatWriter r) Constructs a BufferedImageWriter with the given writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
static BufferedImageWriter	makeBufferedImageWriter(IFormatWriter w) Converts the given writer into a BufferedImageWriter, wrapping if needed.
void	saveImage(BufferedImage image, boolean last) Deprecated. Please use saveImage(int, BufferedImage) instead. Saves the given BufferedImage to the current file. Note that this method will append the image plane to the file; it will not overwrite previously saved image planes. If this image plane is the last one in the file, the last flag must be set.
void	saveImage(BufferedImage image, int series, boolean lastInSeries, boolean last) Deprecated. Please use saveImage(int, BufferedImage) instead. Saves the given BufferedImage to the given series in the current file. Note that this method will append the image plane to the file; it will not overwrite previously saved image planes. If this image plane is the last one in the series, the lastInSeries flag must be set. If this image plane is the last one in the file, the last flag must be set.
void	saveImage(int no, BufferedImage image) Saves the given BufferedImage to the current file.
void	saveImage(int no, BufferedImage image, int x, int y, int w, int h) Saves the given BufferedImage to the current file.
static byte[]	toBytes(BufferedImage image, IFormatWriter writer)

Methods inherited from class loci.formats.WriterWrapper

canDoStacks, changeOutputFile, duplicate, getColorModel, getCompression, getCompressionTypes, getFormat, getFramesPerSecond, getMetadataRetrieve, getNativeDataType, getPixelTypes, getPixelTypes, getSeries, getSuffixes, getWriter, isInterleaved, isSupportedType, isThisType, saveBytes, saveBytes, saveBytes, saveBytes, saveBytes, savePlane, savePlane, savePlane, savePlane, savePlane, setCodecOptions, setColorModel, setCompression, setFramesPerSecond, setId, setInterleaved, setMetadataRetrieve, setSeries, setValidBitsPerPixel, setWriteSequentially, unwrap, unwrap, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedImageWriter

public BufferedImageWriter()

Constructs a BufferedImageWriter around a new image writer.

BufferedImageWriter

public BufferedImageWriter(IFormatWriter r)

Constructs a BufferedImageWriter with the given writer.

Method Detail

makeBufferedImageWriter

public static BufferedImageWriter makeBufferedImageWriter(IFormatWriter w)

Converts the given writer into a BufferedImageWriter, wrapping if needed.

saveImage

public void saveImage(int no,
             BufferedImage image)
               throws FormatException,
                      IOException

Saves the given BufferedImage to the current file.

Parameters:

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

image - the BufferedImage to save.

Throws:

FormatException

IOException

saveImage

public void saveImage(int no,
             BufferedImage image,
             int x,
             int y,
             int w,
             int h)
               throws FormatException,
                      IOException

Saves the given BufferedImage to the current file. The BufferedImage may represent a subsection of the full image to be saved.

Parameters:

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

image - the BufferedImage to save.

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

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

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

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

Throws:

FormatException

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class WriterWrapper

Throws:

IOException

saveImage

public void saveImage(BufferedImage image,
             boolean last)
               throws FormatException,
                      IOException

Deprecated. Please use saveImage(int, BufferedImage) instead. Saves the given BufferedImage to the current file. Note that this method will append the image plane to the file; it will not overwrite previously saved image planes. If this image plane is the last one in the file, the last flag must be set.

Throws:

FormatException

IOException

saveImage

public void saveImage(BufferedImage image,
             int series,
             boolean lastInSeries,
             boolean last)
               throws FormatException,
                      IOException

Deprecated. Please use saveImage(int, BufferedImage) instead. Saves the given BufferedImage to the given series in the current file. Note that this method will append the image plane to the file; it will not overwrite previously saved image planes. If this image plane is the last one in the series, the lastInSeries flag must be set. If this image plane is the last one in the file, the last flag must be set.

Throws:

FormatException

IOException

toBytes

public static byte[] toBytes(BufferedImage image,
             IFormatWriter writer)