Package org.anchoranalysis.image.io.stack.output.generator

Class RasterGeneratorSelectFormat<T>

Object

RasterGenerator<T>

RasterGeneratorSelectFormat<T>

Type Parameters:

T - the type of entity that is transformed to a Stack

All Implemented Interfaces:

Generator<T>, TransformingGenerator<T,Stack>, ElementWriter<T>

Direct Known Subclasses:

AssignmentGenerator, ChannelGenerator, DrawObjectOnStackGenerator, ExtractBoundingBoxAreaFromStackGenerator, ObjectAsMaskGenerator, ObjectsAsGrayscaleGenerator, ObjectsAsRGBGenerator, RasterGeneratorDelegateToDisplayStack, RasterGeneratorDelegateToRaster, StackGenerator

public abstract class RasterGeneratorSelectFormat<T>
extends RasterGenerator<T>

A RasterGenerator that selects an appropriate output-format based upon each generated image.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
RasterGeneratorSelectFormat()

Method Summary

Modifier and Type	Method	Description
protected String	selectFileExtension(Stack stack, StackWriteOptions options, OutputWriteSettings settings, Optional<Logger> logger)	Combines stack-write-options derived for a particular stack with the general write-options associated with the RasterGenerator.
protected void	writeToFile(T element, Stack transformedElement, StackWriteOptions options, OutputWriteSettings settings, Path filePath)	Writes a stack to the file-system.

Methods inherited from class org.anchoranalysis.image.io.stack.output.generator.RasterGenerator

guaranteedImageAttributes, write, writeWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.io.generator.TransformingGenerator

transform

Constructor Details

RasterGeneratorSelectFormat

public RasterGeneratorSelectFormat()

Method Details

selectFileExtension

protected String selectFileExtension(Stack stack,
 StackWriteOptions options,
 OutputWriteSettings settings,
 Optional<Logger> logger)
                              throws OperationFailedException

Combines stack-write-options derived for a particular stack with the general write-options associated with the RasterGenerator.

Specified by:

selectFileExtension in class RasterGenerator<T>

Parameters:

stack - the stack to select a file-extension for

options - options that describe how stack should be written

settings - general settings for writing output

logger - logger for information messages or warnings associated with writing outputs

Returns:

the file extension without any leading period

Throws:

OperationFailedException - if the operation could not be successfully completed.

writeToFile

protected void writeToFile(T element,
 Stack transformedElement,
 StackWriteOptions options,
 OutputWriteSettings settings,
 Path filePath)
                    throws OutputWriteFailedException

Description copied from class: RasterGenerator

Writes a stack to the file-system.

Specified by:

writeToFile in class RasterGenerator<T>

Parameters:

element - the element for the generator before transforming to a Stack

transformedElement - the Stack that element was transformed into

options - options that describe how stack should be written

settings - general settings for writing output.

filePath - the file-path to write too including the extension.

Throws:

OutputWriteFailedException - if the image could not be be successfully written to the file-system.