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

Class ExtractBoundingBoxAreaFromStackGenerator

Object

RasterGenerator<BoundingBox>

RasterGeneratorSelectFormat<BoundingBox>

ExtractBoundingBoxAreaFromStackGenerator

All Implemented Interfaces:

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

public class ExtractBoundingBoxAreaFromStackGenerator
extends RasterGeneratorSelectFormat<BoundingBox>

An iterable-generator that outputs the portion of a stack corresponding to a bounding-box

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
ExtractBoundingBoxAreaFromStackGenerator(ScaleableBackground background)

Method Summary

Modifier and Type	Method	Description
StackWriteAttributes	guaranteedImageAttributes()	Guarantees on the attributes of all images created by the generator.
Stack	transform(BoundingBox 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

ExtractBoundingBoxAreaFromStackGenerator

public ExtractBoundingBoxAreaFromStackGenerator(ScaleableBackground background)

Method Details

transform

public Stack transform(BoundingBox 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<BoundingBox>

Returns:

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