Package net.imglib2.stream

Interface LocalizableSpliterator<T>

Type Parameters:
T - pixel type
All Superinterfaces:
EuclideanSpace, Localizable, RealLocalizable, RealLocalizableSpliterator<T>, Sampler<T>, Spliterator<T>, Typed<T>
All Known Implementing Classes:
ArrayLocalizingSpliterator, ArraySpliterator, CellSpliterator, CursorSpliterator, PlanarSpliterator
public interface LocalizableSpliterator<T> extends RealLocalizableSpliterator<T>, Localizable
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 Cursor, LocalizableSpliterator usually comes in two flavors:

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

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

Corresponding to the LocalizableSpliterator flavors,