Package net.imglib2.stream

Interface LocalizableSpliterator<T>

Type Parameters:

T - pixel type

All Superinterfaces:

EuclideanSpace, Localizable, RealLocalizable, RealLocalizableSpliterator<T>, Sampler<T>, java.util.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:

• IterableInterval.spliterator() computes location only on demand, and
• IterableInterval.localizingSpliterator() preemptively tracks location on every step.

(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,

• Streams.localizable(IterableInterval) computes element location only on demand, and
• Streams.localizing(IterableInterval) tracks location on every step.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

java.util.Spliterator.OfDouble, java.util.Spliterator.OfInt, java.util.Spliterator.OfLong, java.util.Spliterator.OfPrimitive<T extends java.lang.Object,T_CONS extends java.lang.Object,T_SPLITR extends java.util.Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Method Summary

Modifier and Type	Method	Description
LocalizableSpliterator<T>	copy()
LocalizableSpliterator<T>	trySplit()

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface net.imglib2.Localizable

getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable

localize, localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface net.imglib2.Sampler

get, getType

Methods inherited from interface java.util.Spliterator

characteristics, estimateSize, forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics, tryAdvance

Method Detail

trySplit

LocalizableSpliterator<T> trySplit()

Specified by:

trySplit in interface RealLocalizableSpliterator<T>

Specified by:

trySplit in interface java.util.Spliterator<T>

copy

LocalizableSpliterator<T> copy()

Specified by:

copy in interface RealLocalizableSpliterator<T>

Specified by:

copy in interface Sampler<T>

Returns:

- A new Sampler in the same state accessing the same values. It does NOT copy T, just the state of the Sampler. Otherwise use T.copy() if available. Sampler.copy().get() == Sampler.get(), i.e. both hold the same value, not necessarily the same instance (this is the case for an ArrayCursor for example)