public abstract class StackWriter extends AnchorBean<StackWriter>
Constructor and Description |
---|
StackWriter() |
Modifier and Type | Method and Description |
---|---|
abstract ImageFileFormat |
fileFormat(StackWriteOptions writeOptions)
The file format that will be written by the generator.
|
ImageFileFormat |
fileFormatWarnUnexpected(StackWriteOptions writeOptions,
Optional<Logger> logger)
The file format that will be written by the generator, warning with a log message if
different to suggestion.
|
abstract void |
writeStack(Stack stack,
Path filePath,
StackWriteOptions options)
Writes a stack to the filesystem at a particular path.
|
Path |
writeStackWithExtension(Stack stack,
Path filePath,
StackWriteOptions options)
Writes a stack to the filesystem at a particular path with an extension appended to the path.
|
checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString
public Path writeStackWithExtension(Stack stack, Path filePath, StackWriteOptions options) throws ImageIOException
stack
- the stack to write.filePath
- the path to write the file to, apart from an extension.options
- options which may influence how a raster is written.ImageIOException
- if anything goes wrong while writing.public ImageFileFormat fileFormatWarnUnexpected(StackWriteOptions writeOptions, Optional<Logger> logger) throws ImageIOException
writeOptions
- options which may influence how a raster is written.logger
- the logger to use for the warning message.ImageIOException
- if unable to successfully determine the file-format to use to write.public abstract ImageFileFormat fileFormat(StackWriteOptions writeOptions) throws ImageIOException
writeOptions
- options which may influence how a raster is written.ImageIOException
- if unable to successfully determine the file-format to use to write.public abstract void writeStack(Stack stack, Path filePath, StackWriteOptions options) throws ImageIOException
stack
- the stack to write.filePath
- the path to write the file to.options
- options which may influence how a raster is written.ImageIOException
- if anything goes wrong while writing.Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.