net.imglib2.algorithm.blocks

Class AbstractBlockProcessor<I,O>

java.lang.Object

net.imglib2.algorithm.blocks.AbstractBlockProcessor<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 AbstractBlockProcessor<I,O>
extends Object
implements BlockProcessor<I,O>

Boilerplate for BlockProcessor to simplify implementations.

This is intented as a base class for BlockProcessor that have source dimensionality fixed at construction. For BlockProcessor with adaptable number of dimensions (such as converters), see AbstractDimensionlessBlockProcessor.

A BlockInterval of the desired number of dimensions is exposed through getSourceInterval(). (For convenience, min and dimensions of the interval are also exposed through the protected fields sourcePos and sourceSize.) 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 long[]	sourcePos
protected int[]	sourceSize

Constructor Summary

Constructors

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

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()

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

sourcePos

protected final long[] sourcePos

sourceSize

protected final int[] sourceSize

Constructor Detail

AbstractBlockProcessor

protected AbstractBlockProcessor(net.imglib2.type.PrimitiveType sourcePrimitiveType,
                                 int numSourceDimensions)

AbstractBlockProcessor

protected AbstractBlockProcessor(AbstractBlockProcessor<I,O> proc)

Method Detail

sourceLength

protected int sourceLength()

setTargetInterval

public void setTargetInterval(net.imglib2.Interval interval)

Specified by:

setTargetInterval in interface BlockProcessor<I,O>

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>