Package net.imglib2.stream

Interface RealLocalizableSpliterator<T>

Type Parameters:
T - pixel type
All Superinterfaces:
EuclideanSpace, RealLocalizable, Sampler<T>, Spliterator<T>, Typed<T>
All Known Subinterfaces:
LocalizableSpliterator<T>
All Known Implementing Classes:
ArrayLocalizingSpliterator, ArraySpliterator, CellSpliterator, CursorSpliterator, PlanarSpliterator, RealCursorSpliterator
public interface RealLocalizableSpliterator<T> extends Spliterator<T>, RealLocalizable, Sampler<T>
A Spliterator<T> which is Localizable similar to a Cursor.

The location of the Spliterator reflects the location of the element passed to the Consumer in Spliterator.tryAdvance(java.util.function.Consumer<? super T>) or Spliterator.forEachRemaining(java.util.function.Consumer<? super T>) (at the time the element is passed, and until the next element is passed).

Similar to RealCursor, RealLocalizableSpliterator usually comes in two flavors:

(Which one is more efficient depends on how often location is actually needed.)

To make the RealLocalizable property available in a Stream, use the Streams utility class to create Stream<RealLocalizableSampler<T>> (which internally wraps RealLocalizableSpliterator).

Corresponding to the RealLocalizableSpliterator flavors,