Package net.imglib2.view.iteration

Interface SubIntervalIterable<T>

All Superinterfaces:

Dimensions, EuclideanSpace, Interval, Iterable<T>, IterableInterval<T>, IterableRealInterval<T>, RealInterval, Typed<T>

All Known Implementing Classes:

ARGBScreenImage, ArrayImg, ArrayImgAWTScreenImage, ByteAWTScreenImage, DoubleAWTScreenImage, FloatAWTScreenImage, ImgView, IntAWTScreenImage, PlanarImg, ShortAWTScreenImage, UnsignedByteAWTScreenImage, UnsignedIntAWTScreenImage, UnsignedShortAWTScreenImage

public interface SubIntervalIterable<T>
extends IterableInterval<T>

Implementing this interface enables the implementor to return optimized Cursors for certain Intervals

Method Summary

Modifier and Type	Method	Description
Cursor<T>	cursor(Interval interval)	Create a Cursor to iterate over the given Interval.
Cursor<T>	localizingCursor(Interval interval)	Create a Cursor to iterate over the given Interval.
Object	subIntervalIterationOrder(Interval interval)	Returns the iteration order given the interval.
boolean	supportsOptimizedCursor(Interval interval)	Determine whether a Cursor can be created that iterates the given Interval.

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

cursor, localizingCursor, localizingSpliterator, spliterator

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 Details

supportsOptimizedCursor

boolean supportsOptimizedCursor(Interval interval)

Determine whether a Cursor can be created that iterates the given Interval.

Parameters:

interval - to be checked

Returns:

true if a Cursor can be optimized given the Interval

subIntervalIterationOrder

Object subIntervalIterationOrder(Interval interval)

Returns the iteration order given the interval.

Parameters:

interval - Interval over which to iterate

Returns:

the iteration order object @see IterableRealInterval

cursor

Cursor<T> cursor(Interval interval)

Create a Cursor to iterate over the given Interval.

Parameters:

interval - Interval over which to iterate

Returns:

Cursor

localizingCursor

Cursor<T> localizingCursor(Interval interval)

Create a Cursor to iterate over the given Interval.

Parameters:

interval - Interval over which to iterate

Returns:

Cursor