Package org.anchoranalysis.plugin.io.bean.stack.writer

Class StackWriterDelegateBase

Object

AnchorBean<StackWriter>

StackWriter

StackWriterDelegateBase

Direct Known Subclasses:

BranchChannels, BranchStack, BranchSuggestedFormat

public abstract class StackWriterDelegateBase
extends StackWriter

A base class for a StackWriter delegates to another StackWriter based on values of a StackWriteAttributes.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
StackWriterDelegateBase()

Method Summary

Modifier and Type	Method	Description
ImageFileFormat	fileFormat(StackWriteOptions writeOptions)	The file format that will be written by the generator.
protected abstract StackWriter	selectDelegate(StackWriteOptions writeOptions)	Selects a StackWriter to use as a delegate.
void	writeStack(Stack stack, Path filePath, StackWriteOptions options)	Writes a stack to the filesystem at a particular path.

Methods inherited from class org.anchoranalysis.image.io.bean.stack.writer.StackWriter

fileFormatWarnUnexpected, writeStackWithExtension

Methods inherited from class org.anchoranalysis.bean.AnchorBean

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

Methods inherited from class java.lang.Object

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

Constructor Details

StackWriterDelegateBase

public StackWriterDelegateBase()

Method Details

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.

Returns:

the image file-format.

Throws:

ImageIOException - if unable to successfully determine the file-format to use to write.

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 while writing.

selectDelegate

protected abstract StackWriter selectDelegate(StackWriteOptions writeOptions)
                                       throws ImageIOException

Selects a StackWriter to use as a delegate.

Parameters:

writeOptions - options that specify what kind of rasters will be written.

Returns:

the selected StackWriter

Throws:

ImageIOException