Package net.imglib2

Interface IterableInterval<T>

All Superinterfaces:

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

All Known Subinterfaces:

Img<T>, NativeImg<T,A>, RandomAccessibleInterval<T>, SubIntervalIterable<T>

All Known Implementing Classes:

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

public interface IterableInterval<T>
extends IterableRealInterval<T>, Interval

An IterableRealInterval whose elements are located at integer coordinates.

An IterableInterval is not guaranteed to iterate over all coordinates of its containing Interval. In the typical case of a hyperrectangular image, it will do so; however, there are some IterableIntervals which visit only a subset of the Interval coordinates. For example, the imglib2-roi library provides means to model regions of interest (ROIs), along with the ability to iterate over coordinates within a particular ROI; see e.g. net.imglib2.roi.labeling.LabelRegion.

Method Summary

Modifier and Type	Method	Description
Cursor<T>	cursor()	Returns a RealCursor that iterates with optimal speed without calculating the location at each iteration step.
Cursor<T>	localizingCursor()	Returns a RealLocalizable Iterator that calculates its location at each iteration step.
default LocalizableSpliterator<T>	localizingSpliterator()	Creates a LocalizableSpliterator over the elements of this IterableInterval.
default LocalizableSpliterator<T>	spliterator()	Creates a LocalizableSpliterator over the elements of this IterableInterval.

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.IterableRealInterval

firstElement, getType, iterationOrder, iterator, parallelStream, size, stream

Methods inherited from interface net.imglib2.RealInterval

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

Method Detail

cursor

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

Returns:

fast iterating iterator

localizingCursor

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

Returns:

fast localizing iterator

spliterator

default LocalizableSpliterator<T> spliterator()

Creates a LocalizableSpliterator over the elements of this IterableInterval. The returned Spliterator iterates with optimal speed without calculating the location at each iteration step. Localization is performed on demand.

The default implementation wraps a Cursor on the interval. The created Spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED and Spliterator.NONNULL.

Specified by:

spliterator in interface java.lang.Iterable<T>

Specified by:

spliterator in interface IterableRealInterval<T>

localizingSpliterator

default LocalizableSpliterator<T> localizingSpliterator()

Creates a LocalizableSpliterator over the elements of this IterableInterval. The returned Spliterator calculates its location at each iteration step. That is, localization is performed with optimal speed.

The default implementation wraps a localizing Cursor on the interval. The created Spliterator reports Spliterator.SIZED, Spliterator.SUBSIZED, Spliterator.ORDERED and Spliterator.NONNULL.

Specified by:

localizingSpliterator in interface IterableRealInterval<T>