net.imglib2.algorithm.blocks

Class AbstractDimensionlessBlockProcessor<I,O>

java.lang.Object

net.imglib2.algorithm.blocks.AbstractDimensionlessBlockProcessor<I,O>

Type Parameters:

I - input primitive array type, e.g., float[]

O - output primitive array type, e.g., float[]

All Implemented Interfaces:

BlockProcessor<I,O>

public abstract class AbstractDimensionlessBlockProcessor<I,O>
extends Object
implements BlockProcessor<I,O>

Boilerplate for BlockProcessor to simplify implementations.

This is intented as a base class for BlockProcessor with an adaptable number of dimensions (such as converters). For BlockProcessor with a fixed number of source dimensions, see AbstractBlockProcessor.

A BlockInterval is exposed through getSourceInterval() (after setTargetInterval(net.imglib2.Interval) has been called). The protected method sourceLength() returns the number of elements in the source interval.

getSourceBuffer() is implemented according to the sourcePrimitiveType specified at construction.

Field Summary

Fields

Modifier and Type	Field and Description
protected net.imglib2.blocks.BlockInterval	sourceInterval

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDimensionlessBlockProcessor(AbstractDimensionlessBlockProcessor<I,O> proc)
protected	AbstractDimensionlessBlockProcessor(net.imglib2.type.PrimitiveType sourcePrimitiveType)

Method Summary

Modifier and Type	Method and Description
I	getSourceBuffer() Get a src array of sufficient size.
net.imglib2.blocks.BlockInterval	getSourceInterval()
void	setTargetInterval(net.imglib2.Interval interval)
protected int	sourceLength()
protected boolean	updateNumSourceDimensions(int n) Re-allocates sourceInterval if it does not already exist and match numDimensions()==n.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imglib2.algorithm.blocks.BlockProcessor

compute, independentCopy

Field Detail

sourceInterval

protected net.imglib2.blocks.BlockInterval sourceInterval

Constructor Detail

AbstractDimensionlessBlockProcessor

protected AbstractDimensionlessBlockProcessor(net.imglib2.type.PrimitiveType sourcePrimitiveType)

AbstractDimensionlessBlockProcessor

protected AbstractDimensionlessBlockProcessor(AbstractDimensionlessBlockProcessor<I,O> proc)

Method Detail

setTargetInterval

public void setTargetInterval(net.imglib2.Interval interval)

Specified by:

setTargetInterval in interface BlockProcessor<I,O>

updateNumSourceDimensions

protected boolean updateNumSourceDimensions(int n)

Re-allocates sourceInterval if it does not already exist and match numDimensions()==n.

Parameters:

n - new number of source dimensions

Returns:

true if sourceInterval was re-allocated

sourceLength

protected int sourceLength()

getSourceInterval

public net.imglib2.blocks.BlockInterval getSourceInterval()

Specified by:

getSourceInterval in interface BlockProcessor<I,O>

getSourceBuffer

public I getSourceBuffer()

Description copied from interface: BlockProcessor

Get a src array of sufficient size.

Consecutive calls may return the same array (but don't have to).

E.g., this is a BUG:

     blockProcessor.setTargetInterval( interval );
     blockSupplier.copy( blockProcessor.getSourceInterval(), blockProcessor.getSourceBuffer() );
     blockProcessor.compute( blockProcessor.getSourceBuffer(), dest );
 

Use this instead:

     blockProcessor.setTargetInterval( interval );
     Object buf = blockProcessor.getSourceBuffer();
     blockSupplier.copy( blockProcessor.getSourceInterval(), buf );
     blockProcessor.compute( buf, dest );
 

Specified by:

getSourceBuffer in interface BlockProcessor<I,O>