Package net.imglib2

Interface RandomAccessibleInterval<T>

All Superinterfaces:

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

All Known Subinterfaces:

Img<T>, NativeImg<T,A>

All Known Implementing Classes:

AbstractCellImg, AbstractConvertedIterableRandomAccessibleInterval, AbstractConvertedRandomAccessibleInterval, AbstractImg, AbstractListImg, AbstractLongListImg, AbstractNativeImg, ARGBScreenImage, ArrayImg, ArrayImgAWTScreenImage, BiConvertedRandomAccessibleInterval, ByteAWTScreenImage, CellGrid.CellIntervals, CellImg, CompositeIntervalView, ConvertedRandomAccessibleInterval, DiscreteFrequencyDistribution, DoubleAWTScreenImage, FloatAWTScreenImage, Grid.CellIntervals, Histogram1d, HistogramNd, ImgView, IntAWTScreenImage, IntervalView, IterableRandomAccessibleInterval, LazyCellImg, LazyCellImg.LazyCells, ListImg, NtreeImg, PlanarImg, ShortAWTScreenImage, StackView, SubsampleIntervalView, UnsignedByteAWTScreenImage, UnsignedIntAWTScreenImage, UnsignedShortAWTScreenImage, WriteConvertedIterableRandomAccessibleInterval, WriteConvertedRandomAccessibleInterval

public interface RandomAccessibleInterval<T>
extends RandomAccessible<T>, IterableInterval<T>

f:{x∈Zⁿ|[min,max]→T}

A function over an n-dimensional integer interval that can create a random access Sampler.

By convention, a RandomAccessibleInterval represents a function that is defined at all coordinates of the interval.

There is no guarantee regarding whether the function is defined outside the bounds of its interval. If the function is known to be defined for out-of-bounds values in a particular interval, the RandomAccessible.randomAccess(Interval) method should be used to access those values—whereas the RandomAccessible.randomAccess() (no arguments) method is not intended to access out-of-bounds values. See RandomAccessible.randomAccess() for related discussion.

Method Summary

Modifier and Type	Method	Description
default Cursor<T>	cursor()	Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step.
default java.lang.Object	iterationOrder()	Returns the iteration order of this IterableRealInterval.
default Cursor<T>	localizingCursor()	Returns a RealLocalizable Iterator that calculates its location at each iteration step.
default long	size()	Returns the number of elements in this Function.

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, getType, iterator, parallelStream, stream

Methods inherited from interface net.imglib2.RandomAccessible

getAt, getAt, getAt, randomAccess, randomAccess

Methods inherited from interface net.imglib2.RealInterval

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

Method Detail

cursor

default 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>

Returns:

fast iterating iterator

localizingCursor

default 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>

Returns:

fast localizing iterator

size

default long size()

Description copied from interface: IterableRealInterval

Returns the number of elements in this Function.

Specified by:

size in interface IterableRealInterval<T>

Returns:

number of elements

iterationOrder

default java.lang.Object 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>

Returns:

the iteration order of this IterableRealInterval.

See Also:

FlatIterationOrder