Package net.imglib2.view

Class IterableRandomAccessibleInterval<T>

java.lang.Object

net.imglib2.AbstractWrappedRealInterval<I>

net.imglib2.AbstractWrappedInterval<RandomAccessibleInterval<T>>

net.imglib2.view.IterableRandomAccessibleInterval<T>

All Implemented Interfaces:

java.lang.Iterable<T>, Dimensions, EuclideanSpace, Interval, IterableInterval<T>, IterableRealInterval<T>, RandomAccessible<T>, RandomAccessibleInterval<T>, RealInterval, Typed<T>, View

Direct Known Subclasses:

ImgView

public class IterableRandomAccessibleInterval<T>
extends AbstractWrappedInterval<RandomAccessibleInterval<T>>
implements RandomAccessibleInterval<T>, View

Generates Cursors that iterate a RandomAccessibleInterval in FlatIterationOrder, that is: row by row, plane by plane, cube by cube, ...

Field Summary

Fields inherited from class net.imglib2.AbstractWrappedRealInterval

sourceInterval

Constructor Summary

Constructors

Constructor	Description
IterableRandomAccessibleInterval(RandomAccessibleInterval<T> interval)

Method Summary

Modifier and Type	Method	Description
static <T> IterableRandomAccessibleInterval<T>	create(RandomAccessibleInterval<T> interval)
Cursor<T>	cursor()	Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step.
T	getType()	Get an instance of T.
FlatIterationOrder	iterationOrder()	Returns the iteration order of this IterableRealInterval.
Cursor<T>	localizingCursor()	Returns a RealLocalizable Iterator that calculates its location at each iteration step.
RandomAccess<T>	randomAccess()	Create a random access sampler for integer coordinates.
RandomAccess<T>	randomAccess(Interval i)	Create a random access sampler for integer coordinates.
long	size()	Returns the number of elements in this Function.

Methods inherited from class net.imglib2.AbstractWrappedInterval

dimension, dimensions, max, max, max, min, min, min

Methods inherited from class net.imglib2.AbstractWrappedRealInterval

getSource, numDimensions, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imglib2.Dimensions

dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface net.imglib2.Interval

dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.imglib2.IterableInterval

localizingSpliterator, spliterator

Methods inherited from interface net.imglib2.IterableRealInterval

firstElement, iterator, parallelStream, stream

Methods inherited from interface net.imglib2.RandomAccessible

getAt, getAt, getAt

Methods inherited from interface net.imglib2.RealInterval

maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin

Constructor Detail

IterableRandomAccessibleInterval

public IterableRandomAccessibleInterval(RandomAccessibleInterval<T> interval)

Method Detail

create

public static <T> IterableRandomAccessibleInterval<T> create(RandomAccessibleInterval<T> interval)

size

public long size()

Description copied from interface: IterableRealInterval

Returns the number of elements in this Function.

Specified by:

size in interface IterableRealInterval<T>

Specified by:

size in interface RandomAccessibleInterval<T>

Returns:

number of elements

iterationOrder

public FlatIterationOrder iterationOrder()

Description copied from interface: IterableRealInterval

Returns the iteration order of this IterableRealInterval. If the returned object equals (Object.equals(Object)) the iteration order of another IterableRealInterval f then they can be copied by synchronous iteration. That is, having an Iterator on this and another Iterator on f, moving both in synchrony will point both of them to corresponding locations in their source domain. In other words, this and f have the same iteration order and means and the same number of elements.

Specified by:

iterationOrder in interface IterableRealInterval<T>

Specified by:

iterationOrder in interface RandomAccessibleInterval<T>

Returns:

the iteration order of this IterableRealInterval.

See Also:

FlatIterationOrder

cursor

public Cursor<T> cursor()

Description copied from interface: IterableRealInterval

Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

Use this where localization is required rarely/ not for each iteration.

Specified by:

cursor in interface IterableInterval<T>

Specified by:

cursor in interface IterableRealInterval<T>

Specified by:

cursor in interface RandomAccessibleInterval<T>

Returns:

fast iterating iterator

localizingCursor

public Cursor<T> localizingCursor()

Description copied from interface: IterableRealInterval

Returns a RealLocalizable Iterator that calculates its location at each iteration step. That is, localization is performed with optimal speed.

Use this where localization is required often/ for each iteration.

Specified by:

localizingCursor in interface IterableInterval<T>

Specified by:

localizingCursor in interface IterableRealInterval<T>

Specified by:

localizingCursor in interface RandomAccessibleInterval<T>

Returns:

fast localizing iterator

randomAccess

public RandomAccess<T> 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 RandomAccess<T> randomAccess(Interval i)

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:

i - 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 IterableRealInterval<T>

Specified by:

getType in interface Typed<T>

Returns:

an instance of T