org.anchoranalysis.image.io.bean.stack.writer

Class OneOrThreeChannelsWriter

Object

AnchorBean<StackWriter>

StackWriter

OneOrThreeChannelsWriter

Direct Known Subclasses:

ImageIOWriter, OpenCVWriter

public abstract class OneOrThreeChannelsWriter
extends StackWriter

A base-class for a raster-writer that writes only one or three channeled images, and a flexible extension.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor and Description
OneOrThreeChannelsWriter()

Method Summary

Modifier and Type	Method and Description
ImageFileFormat	fileFormat(StackWriteOptions writeOptions) The file format that will be written by the generator.
String	getExtension()
void	setExtension(String extension)
void	writeStack(Stack stack, Path filePath, StackWriteOptions options) Writes a stack to the filesystem at a particular path.
protected abstract void	writeStackAfterCheck(Stack stack, Path filePath)
void	writeStackSeries(StackSeries stackSeries, Path filePath, StackWriteOptions options) Writes a series of stacks to the filesystem at a particular path.

Methods inherited from class StackWriter

fileFormatWarnUnexpected, writeStackWithExtension

Methods inherited from class AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class Object

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

Constructor Detail

OneOrThreeChannelsWriter

public OneOrThreeChannelsWriter()

Method Detail

fileFormat

public ImageFileFormat fileFormat(StackWriteOptions writeOptions)
                           throws ImageIOException

Description copied from class: StackWriter

The file format that will be written by the generator.

Specified by:

fileFormat in class StackWriter

Parameters:

writeOptions - options which may influence how a raster is written.

Throws:

ImageIOException

writeStackSeries

public void writeStackSeries(StackSeries stackSeries,
                             Path filePath,
                             StackWriteOptions options)
                      throws ImageIOException

Description copied from class: StackWriter

Writes a series of stacks to the filesystem at a particular path.

Specified by:

writeStackSeries in class StackWriter

Parameters:

stackSeries - the series of stacks

filePath - the path to write the file to

options - options which may influence how a raster is written.

Throws:

ImageIOException

writeStack

public void writeStack(Stack stack,
                       Path filePath,
                       StackWriteOptions options)
                throws ImageIOException

Description copied from class: StackWriter

Writes a stack to the filesystem at a particular path.

Specified by:

writeStack in class StackWriter

Parameters:

stack - the stack to write

filePath - the path to write the file to

options - options which may influence how a raster is written.

Throws:

ImageIOException - if anything goes wrong whle writing.

writeStackAfterCheck

protected abstract void writeStackAfterCheck(Stack stack,
                                             Path filePath)
                                      throws ImageIOException

Throws:

ImageIOException

getExtension

public String getExtension()

setExtension

public void setExtension(String extension)