at.mug.iqm.commons.io

Class ImageFileWriter

java.lang.Object

at.mug.iqm.commons.io.ImageFileWriter

All Implemented Interfaces:

Runnable

public class ImageFileWriter
extends Object
implements Runnable

This class stores one or more images with a given encoding to the file system.

Since:

3.1

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
private List<IqmDataBox>	boxes
private File	destination
private String	encoding
private String	extension
private RenderedImage	image
private static org.apache.log4j.Logger	logger
private int	mode
static int	MODE_SEQUENCE
static int	MODE_SINGLE
static int	MODE_STACK
private boolean	withROIs

Constructor Summary

Constructors

Constructor and Description
ImageFileWriter(File destination, IqmDataBox box, String encoding) Create a new image file writer.
ImageFileWriter(File destination, List<?> itemList, String encoding, String extension, int mode) Create a new image file writer.
ImageFileWriter(File destination, RenderedImage image, String encoding) Create a new image file writer.
ImageFileWriter(int mode) Create an empty file writer.

Method Summary

Modifier and Type	Method and Description
File	getDestination() Get the destination of the image file.
String	getEncoding() Get the encoding of the image(s) to be saved.
String	getExtension() Get the file name extension.
boolean	isWithROIs() Gets a flag whether or not ROIs should be drawn on export.
void	run() Run the file writer in a separate thread.
void	setDestination(File destination) Set the destination of the image file(s).
void	setEncoding(String encoding) Set the encoding for the image(s) to be saved.
void	setExtension(String extension) Set the extension of the file.
void	setWithROIs(boolean withROIs) Set a flag whether or not ROIs should be drawn on export.
void	write() Perform the file writing action.
void	writeSequence() Saves an image sequence to multiple files.
void	writeStack() Write a list of images to a stack.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

MODE_SINGLE

public static final int MODE_SINGLE

See Also:

Constant Field Values

MODE_SEQUENCE

public static final int MODE_SEQUENCE

See Also:

Constant Field Values

MODE_STACK

public static final int MODE_STACK

See Also:

Constant Field Values

destination

private File destination

image

private RenderedImage image

boxes

private List<IqmDataBox> boxes

encoding

private String encoding

extension

private String extension

withROIs

private boolean withROIs

mode

private int mode

Constructor Detail

ImageFileWriter

public ImageFileWriter(int mode)

Create an empty file writer.

ImageFileWriter

public ImageFileWriter(File destination,
                       RenderedImage image,
                       String encoding)

Create a new image file writer.

Parameters:

destination - the target file

image - the image

encoding - a JAI-specific string

ImageFileWriter

public ImageFileWriter(File destination,
                       IqmDataBox box,
                       String encoding)

Create a new image file writer.

Parameters:

destination - the target file

box - the IqmDataBox containing the image

encoding - a JAI-specific string

ImageFileWriter

public ImageFileWriter(File destination,
                       List<?> itemList,
                       String encoding,
                       String extension,
                       int mode)

Create a new image file writer.

Parameters:

destination - the target file

itemList - the list of items (IqmDataBox containing the images, or rendered images)

encoding - a JAI-specific string

extension - the file extension

mode - determine the writing mode, either MODE_SEQUENCE or MODE_STACK

Method Detail

setDestination

public void setDestination(File destination)

Set the destination of the image file(s).

Parameters:

destination - the target file name

getDestination

public File getDestination()

Get the destination of the image file.

Returns:

the target file name

setEncoding

public void setEncoding(String encoding)

Set the encoding for the image(s) to be saved.

Parameters:

encoding - a JAI specific string

getEncoding

public String getEncoding()

Get the encoding of the image(s) to be saved.

Returns:

the encoding, a JAI specific string

getExtension

public String getExtension()

Get the file name extension.

Returns:

the extension

setExtension

public void setExtension(String extension)

Set the extension of the file.

Parameters:

extension -

run

public void run()

Run the file writer in a separate thread.

Specified by:

run in interface Runnable

write

public void write()
           throws IOException

Perform the file writing action.

Throws:

IOException - if the file could not be written.

writeSequence

public void writeSequence()

Saves an image sequence to multiple files. This method will automatically append proper sequence numbers.

writeStack

public void writeStack()

Write a list of images to a stack.

isWithROIs

public boolean isWithROIs()

Gets a flag whether or not ROIs should be drawn on export.

Returns:

draw ROIs

setWithROIs

public void setWithROIs(boolean withROIs)

Set a flag whether or not ROIs should be drawn on export.

Parameters:

withROIs - true or false