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

Class StackGenerator

Object

RasterGenerator<Stack>

RasterGeneratorSelectFormat<Stack>

StackGenerator

All Implemented Interfaces:

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

public class StackGenerator
extends RasterGeneratorSelectFormat<Stack>

Writes a stack to the filesystem.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
StackGenerator(boolean always2D)	Creates a generator that performs no padding.
StackGenerator(boolean padIfNecessary, boolean always2D)	Creates the generator from a stack, inferring whether all stacks will be 2D from this stack's dimensions.
StackGenerator(boolean padIfNecessary, StackWriteAttributes writeOptions)	Creates a new StackGenerator instance.

Method Summary

Modifier and Type	Method	Description
StackWriteAttributes	guaranteedImageAttributes()	Guarantees on the attributes of all images created by the generator.
Stack	transform(Stack element)	Applies any necessary preprocessing to create an element suitable for writing to the filesystem.

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

selectFileExtension, writeToFile

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

write, writeWithIndex

Methods inherited from class java.lang.Object

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

Constructor Details

StackGenerator

public StackGenerator(boolean always2D)

Creates a generator that performs no padding.

Parameters:

always2D - when true, this indicates that the stack is guaranteed to be always 2D.

StackGenerator

public StackGenerator(boolean padIfNecessary,
 boolean always2D)

Creates the generator from a stack, inferring whether all stacks will be 2D from this stack's dimensions.

Parameters:

padIfNecessary - iff true, in the specific case of a 2-channel stack, an additional blank channel is added to make it 3-channels.

always2D - when true, this indicates that the stack is guaranteed to be always 2D.

StackGenerator

public StackGenerator(boolean padIfNecessary,
 StackWriteAttributes writeOptions)

Creates a new StackGenerator instance.

Parameters:

padIfNecessary - Iff true, in the specific case of a 2-channel stack, an additional blank channel is added to make it 3-channels.

writeOptions - Properties of the stack that is being written used to guide the outputting.

Method Details

transform

public Stack transform(Stack element)
                throws OutputWriteFailedException

Description copied from interface: TransformingGenerator

Applies any necessary preprocessing to create an element suitable for writing to the filesystem.

Parameters:

element - element to be assigned and then transformed.

Returns:

the transformed element after necessary preprocessing.

Throws:

OutputWriteFailedException - if anything goes wrong.

guaranteedImageAttributes

public StackWriteAttributes guaranteedImageAttributes()

Description copied from class: RasterGenerator

Guarantees on the attributes of all images created by the generator.

Specified by:

guaranteedImageAttributes in class RasterGenerator<Stack>

Returns:

options that are guaranteed to be true of all images by the generator.