net.imglib2.algorithm.blocks

Interface UnaryBlockOperator<S extends net.imglib2.type.NativeType<S>,T extends net.imglib2.type.NativeType<T>>

Type Parameters:

S - source pixel type

T - target pixel type

All Known Implementing Classes:

AbstractUnaryBlockOperator, DefaultUnaryBlockOperator

public interface UnaryBlockOperator<S extends net.imglib2.type.NativeType<S>,T extends net.imglib2.type.NativeType<T>>

A UnaryBlockOperator computes blocks of NativeType<T> data from blocks of NativeType<S> data.

Use the compute(BlockSupplier, Interval, Object) method to compute a block of data and store it into a flat primitive array (of the appropriate primitive type corresponding to T). The input block (appropriately sized and positioned to produce the desired output Interval) is read from a BlockSupplier<S>.

Typically, UnaryBlockOperator are chained to a particular BlockSupplier<S> using BlockSupplier.andThen(net.imglib2.algorithm.blocks.UnaryBlockOperator<T, U>) (or applyTo(net.imglib2.algorithm.blocks.BlockSupplier<S>), instead of calling compute() explicitly.

Implementations are not thread-safe in general. Use independentCopy() to obtain independent instances.

Method Summary

Modifier and Type	Method and Description
default <U extends net.imglib2.type.NativeType<U>> UnaryBlockOperator<U,T>	adaptSourceType(U newSourceType, ClampType clamp) Returns a UnaryBlockOperator that is equivalent to converting the input values to type U (possibly clamping to the range of U). and then applying this to the result.
default <U extends net.imglib2.type.NativeType<U>> UnaryBlockOperator<S,U>	adaptTargetType(U newTargetType, ClampType clamp) Returns a UnaryBlockOperator that is equivalent to applying this, an then converting the output values to type U (possibly clamping to the range of U).
default <U extends net.imglib2.type.NativeType<U>> UnaryBlockOperator<S,U>	andThen(UnaryBlockOperator<T,U> op) Returns a UnaryBlockOperator that is equivalent to applying this, and then applying op to the result.
default BlockSupplier<T>	applyTo(BlockSupplier<S> blocks) Returns a BlockSupplier<T> that provide blocks by computing on input blocks from the given BlockSupplier<S>.
void	compute(BlockSupplier<S> src, net.imglib2.Interval interval, Object dest) Compute a block (using src to provide input data) and store into the given primitive array (of the appropriate type).
S	getSourceType()
T	getTargetType()
UnaryBlockOperator<S,T>	independentCopy() Returns an instance of this UnaryBlockOperator that can be used independently, e.g., in another thread or in another place in the same pipeline.
int	numSourceDimensions() Number of source dimensions.
int	numTargetDimensions() Number of target dimensions.

Method Detail

compute

void compute(BlockSupplier<S> src,
             net.imglib2.Interval interval,
             Object dest)

Compute a block (using src to provide input data) and store into the given primitive array (of the appropriate type).

Parameters:

src - the BlockSupplier that provides input data

interval - the output interval to compute

dest - primitive array to store computation result. Must correspond to T, for example, if T is UnsignedByteType then dest must be byte[].

getSourceType

S getSourceType()

getTargetType

T getTargetType()

numSourceDimensions

int numSourceDimensions()

Number of source dimensions.

Some operators can be applied to arbitrary dimensions, e.g., converters. In this case, they should return numSourceDimensions() <= 0. It is expected that these operators do not modify the number of dimensions, that is, when such an operator is applied to a 3D block, the result is also a 3D block.

Returns:

the number of source dimensions

numTargetDimensions

int numTargetDimensions()

Number of target dimensions.

Some operators can be applied to arbitrary dimensions, e.g., converters. In this case, they should return numTargetDimensions() <= 0. It is expected that these operators do not modify the number of dimensions, that is, when such an operator is applied to a 3D block, the result is also a 3D block.

Returns:

the number of target dimensions

independentCopy

UnaryBlockOperator<S,T> independentCopy()

Returns an instance of this UnaryBlockOperator that can be used independently, e.g., in another thread or in another place in the same pipeline.

applyTo

default BlockSupplier<T> applyTo(BlockSupplier<S> blocks)

Returns a BlockSupplier<T> that provide blocks by computing on input blocks from the given BlockSupplier<S>.

andThen

default <U extends net.imglib2.type.NativeType<U>> UnaryBlockOperator<S,U> andThen(UnaryBlockOperator<T,U> op)

Returns a UnaryBlockOperator that is equivalent to applying this, and then applying op to the result.

adaptSourceType

default <U extends net.imglib2.type.NativeType<U>> UnaryBlockOperator<U,T> adaptSourceType(U newSourceType,
                                                                                           ClampType clamp)

Returns a UnaryBlockOperator that is equivalent to converting the input values to type U (possibly clamping to the range of U). and then applying this to the result.

adaptTargetType

default <U extends net.imglib2.type.NativeType<U>> UnaryBlockOperator<S,U> adaptTargetType(U newTargetType,
                                                                                           ClampType clamp)

Returns a UnaryBlockOperator that is equivalent to applying this, an then converting the output values to type U (possibly clamping to the range of U).