Class FunctionRandomAccessible<T>

java.lang.Object

net.imglib2.position.AbstractFunctionEuclideanSpace<Localizable, T>

net.imglib2.position.FunctionRandomAccessible<T>

All Implemented Interfaces:

EuclideanSpace, RandomAccessible<T>, Typed<T>

public class FunctionRandomAccessible<T>
extends AbstractFunctionEuclideanSpace<Localizable, T>
implements RandomAccessible<T>

A RandomAccessible that generates a function value for each position in discrete coordinate space by side-effect using a BiConsumer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	FunctionRandomAccessible.FunctionRandomAccess

Field Summary

Fields inherited from class AbstractFunctionEuclideanSpace

functionSupplier, n, typeSupplier

Constructor Summary

Constructors

Constructor	Description
FunctionRandomAccessible(int n, BiConsumer<Localizable, ? super T> function, Supplier<T> typeSupplier)
FunctionRandomAccessible(int n, Supplier<BiConsumer<Localizable, ? super T>> functionSupplier, Supplier<T> typeSupplier)

Method Summary

Modifier and Type	Method	Description
T	getType()	Get an instance of T.
FunctionRandomAccessible<T>.FunctionRandomAccess	randomAccess()	Create a random access sampler for integer coordinates.
FunctionRandomAccessible<T>.FunctionRandomAccess	randomAccess(Interval interval)	Create a random access sampler for integer coordinates.

Methods inherited from class AbstractFunctionEuclideanSpace

numDimensions

Methods inherited from class Object

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

Methods inherited from interface EuclideanSpace

numDimensions

Methods inherited from interface RandomAccessible

getAt, getAt, getAt

Constructor Details

FunctionRandomAccessible

public FunctionRandomAccessible(int n,
 BiConsumer<Localizable, ? super T> function,
 Supplier<T> typeSupplier)

FunctionRandomAccessible

public FunctionRandomAccessible(int n,
 Supplier<BiConsumer<Localizable, ? super T>> functionSupplier,
 Supplier<T> typeSupplier)

Method Details

randomAccess

public FunctionRandomAccessible<T>.FunctionRandomAccess randomAccess()

Description copied from interface: RandomAccessible

Create a random access sampler for integer coordinates.

The returned random access covers as much of the domain as possible.

Please note: RandomAccessibleIntervals have a finite domain (their Interval), so RandomAccessible.randomAccess() is only guaranteed to cover this finite domain. This may lead to unexpected results when using Views. In the following code

RandomAccessible<T> extended = Views.extendBorder( img )
RandomAccessibleInterval<T> cropped = Views.interval( extended, img );
RandomAccess<T> a1 = extended.randomAccess();
RandomAccess<T> a2 = cropped.randomAccess();

The access a1 on the extended image is valid everywhere. However, somewhat counter-intuitively, the access a2 on the extended and cropped image is only valid on the interval img to which the extended image was cropped. The access is only required to cover this interval, because it is the domain of the cropped image. Views attempts to provide the fastest possible access that meets this requirement, and will therefore strip the extension. To deal with this, if you know that you need to access pixels outside the domain of the RandomAccessibleInterval, and you know that the RandomAccessibleInterval is actually defined beyond its interval boundaries, then use the RandomAccessible.randomAccess(Interval) variant and specify which interval you actually want to access. In the above example,

RandomAccess<T> a2 = cropped.randomAccess( Intervals.expand( img, 10 ) );

will provide the extended access as expected.

Specified by:

randomAccess in interface RandomAccessible<T>

Returns:

random access sampler

randomAccess

public FunctionRandomAccessible<T>.FunctionRandomAccess randomAccess(Interval interval)

Description copied from interface: RandomAccessible

Create a random access sampler for integer coordinates.

The returned random access is intended to be used in the specified interval only. Thus, the RandomAccessible may provide optimized versions. If the interval is completely contained in the domain, the random access is guaranteed to provide the same values as that obtained by RandomAccessible.randomAccess() within the interval.

Specified by:

randomAccess in interface RandomAccessible<T>

Parameters:

interval - in which interval you intend to use the random access.

Returns:

random access sampler

getType

public T getType()

Description copied from interface: Typed

Get an instance of T.

It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

Specified by:

getType in interface Typed<T>

Returns:

an instance of T