Package org.anchoranalysis.plugin.image.bean.channel.aggregator

Class ProjectableBufferAggregator<T>

Object

AnchorBean<ChannelAggregator>

ChannelAggregator

ProjectableBufferAggregator<T>

Type Parameters:

T - buffer type used for aggregation UnsignedByteBuffer etc.

Direct Known Subclasses:

MaxProjection, MeanProjection, MinProjection, StandardDeviationProjection

public abstract class ProjectableBufferAggregator<T>
extends ChannelAggregator

An aggregator that calculates the aggregation of every voxel across successive channels via a ProjectableBuffer.

This is achieved by maintaining a running sum for each voxel, and a total count of how many images were added.

Constructor Summary

Constructors

Constructor	Description
ProjectableBufferAggregator()

Method Summary

Modifier and Type	Method	Description
protected void	addChannelAfterCheck(Channel channel)	Adds a Channel to the aggregation - after checking channel has acceptable dimensions.
protected abstract ProjectableBuffer<T>	create(VoxelDataType dataType, Extent extent)	Creates the ProjectableBuffer used for aggregation.
protected Optional<Dimensions>	existingDimensions()	The Dimensions to use for the aggregation.
protected Channel	retrieveCreateAggregatedChannel()	Retrieve or create an aggregated-channel of type outputType.

Methods inherited from class org.anchoranalysis.image.bean.channel.ChannelAggregator

addChannel, aggregatedChannel, maybeDropResolution

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

ProjectableBufferAggregator

public ProjectableBufferAggregator()

Method Details

existingDimensions

protected Optional<Dimensions> existingDimensions()

Description copied from class: ChannelAggregator

The Dimensions to use for the aggregation.

Specified by:

existingDimensions in class ChannelAggregator

Returns:

the dimensions, if at least one call to ChannelAggregator.addChannel(Channel, Logger) has occurred, otherwise Optional.empty().

addChannelAfterCheck

protected void addChannelAfterCheck(Channel channel)
                             throws OperationFailedException

Description copied from class: ChannelAggregator

Adds a Channel to the aggregation - after checking channel has acceptable dimensions.

Specified by:

addChannelAfterCheck in class ChannelAggregator

Parameters:

channel - the channel to add, guaranteed to have identical dimensions to any previous call to ChannelAggregator.addChannel(Channel, Logger).

Throws:

OperationFailedException - if the dimensions do not match existing channels that were previously added.

retrieveCreateAggregatedChannel

protected Channel retrieveCreateAggregatedChannel()

Description copied from class: ChannelAggregator

Retrieve or create an aggregated-channel of type outputType.

This channel is the result of the aggregation operation.

Specified by:

retrieveCreateAggregatedChannel in class ChannelAggregator

Returns:

a Channel, either as already exists internally, or newly created.

create

protected abstract ProjectableBuffer<T> create(VoxelDataType dataType,
 Extent extent)
                                        throws OperationFailedException

Creates the ProjectableBuffer used for aggregation.

Parameters:

dataType - the data-type to use for the aggregated channel.

extent - the size of the aggregated channel.

Returns:

a newly created ProjectableBuffer of specified type and size.

Throws:

OperationFailedException - if a buffer-type is unsupported.