Package net.imglib2.stream

Class CursorSpliterator<T>

java.lang.Object

net.imglib2.stream.CursorSpliterator<T>

Type Parameters:

T - the type of elements returned by this Spliterator, and the pixel type of the underlying cursor.

All Implemented Interfaces:

java.util.Spliterator<T>, EuclideanSpace, Localizable, RealLocalizable, Sampler<T>, LocalizableSpliterator<T>, RealLocalizableSpliterator<T>, Typed<T>

public class CursorSpliterator<T>
extends java.lang.Object
implements LocalizableSpliterator<T>

Spliterator implementation on top of RealCursor.

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

Modifier and Type	Field	Description
private int	characteristics	Characteristics always include SIZED | SUBSIZED.
private Cursor<T>	cursor	The underlying cursor, positioned such that cursor.next() yields the element at index.
private long	fence	One past last index
private long	index	The current index, modified on advance/split.

Fields inherited from interface java.util.Spliterator

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

Constructor Summary

Constructors

Constructor	Description
CursorSpliterator(Cursor<T> cursor, long origin, long fence, int additionalCharacteristics)	Creates a spliterator covering the given range.

Method Summary

Modifier and Type	Method	Description
int	characteristics()
CursorSpliterator<T>	copy()
long	estimateSize()
T	get()	Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
double	getDoublePosition(int d)	Return the current position in a given dimension.
float	getFloatPosition(int d)	Return the current position in a given dimension.
int	getIntPosition(int d)	Return the current position in a given dimension.
long	getLongPosition(int d)	Return the current position in a given dimension.
T	getType()	Get an instance of T.
void	localize(double[] position)	Write the current position into the passed array.
void	localize(float[] position)	Write the current position into the passed array.
void	localize(int[] position)	Write the current position into the passed array.
void	localize(long[] position)	Write the current position into the passed array.
void	localize(Positionable position)	Write the current position into the passed Positionable.
void	localize(RealPositionable position)	Write the current position into the passed Positionable.
int	numDimensions()	Gets the space's number of dimensions.
double[]	positionAsDoubleArray()	Allocate and return a double array with the position.
long[]	positionAsLongArray()	Allocate and return a long array containing the localizable's position.
Point	positionAsPoint()	Allocate and return a Point containing the localizable's position.
RealPoint	positionAsRealPoint()	Allocate and return a RealPoint with the current position.
boolean	tryAdvance(java.util.function.Consumer<? super T> action)
CursorSpliterator<T>	trySplit()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics

Field Detail

cursor

private final Cursor<T> cursor

The underlying cursor, positioned such that cursor.next() yields the element at index.

index

private long index

The current index, modified on advance/split.

fence

private final long fence

One past last index

characteristics

private final int characteristics

Characteristics always include SIZED | SUBSIZED.

Constructor Detail

CursorSpliterator

public CursorSpliterator(Cursor<T> cursor,
                         long origin,
                         long fence,
                         int additionalCharacteristics)

Creates a spliterator covering the given range.

Parameters:

cursor - provides elements, starting with the element at origin, on cursor.next()

origin - the least index (inclusive) to cover

fence - one past the greatest index to cover

additionalCharacteristics - additional characteristics besides SIZED | SUBSIZED

Method Detail

tryAdvance

public boolean tryAdvance(java.util.function.Consumer<? super T> action)

Specified by:

tryAdvance in interface java.util.Spliterator<T>

trySplit

public CursorSpliterator<T> trySplit()

Specified by:

trySplit in interface LocalizableSpliterator<T>

Specified by:

trySplit in interface RealLocalizableSpliterator<T>

Specified by:

trySplit in interface java.util.Spliterator<T>

estimateSize

public long estimateSize()

Specified by:

estimateSize in interface java.util.Spliterator<T>

characteristics

public int characteristics()

Specified by:

characteristics in interface java.util.Spliterator<T>

get

public T get()

Description copied from interface: Sampler

Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.

Specified by:

get in interface Sampler<T>

getType

public T getType()

Description copied from interface: Typed

Get an instance of T.

It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.

Specified by:

getType in interface Sampler<T>

Specified by:

getType in interface Typed<T>

Returns:

an instance of T

copy

public CursorSpliterator<T> copy()

Specified by:

copy in interface LocalizableSpliterator<T>

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)

numDimensions

public int numDimensions()

Description copied from interface: EuclideanSpace

Gets the space's number of dimensions.

Specified by:

numDimensions in interface EuclideanSpace

localize

public void localize(float[] position)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

localize

public void localize(double[] position)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

localize

public void localize(RealPositionable position)

Description copied from interface: RealLocalizable

Write the current position into the passed Positionable. Note for developers: This default implementation forwards to RealPositionable.setPosition(RealLocalizable), so don't do the same there.

Specified by:

localize in interface Localizable

Specified by:

localize in interface RealLocalizable

Parameters:

position - receives current position EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()

positionAsDoubleArray

public double[] positionAsDoubleArray()

Description copied from interface: RealLocalizable

Allocate and return a double array with the position. Please note that his method allocates a new array each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated array first and reuse it with RealLocalizable.localize(double[]).

Specified by:

positionAsDoubleArray in interface RealLocalizable

Returns:

the position

positionAsRealPoint

public RealPoint positionAsRealPoint()

Description copied from interface: RealLocalizable

Allocate and return a RealPoint with the current position. Please note that his method allocates a new RealPoint each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated RealPoint first and reuse it with RealLocalizable.localize(RealPositionable).

Specified by:

positionAsRealPoint in interface RealLocalizable

Returns:

the position

getFloatPosition

public float getFloatPosition(int d)

Description copied from interface: RealLocalizable

Return the current position in a given dimension.

Specified by:

getFloatPosition in interface Localizable

Specified by:

getFloatPosition in interface RealLocalizable

Parameters:

d - dimension

Returns:

dimension of current position

getDoublePosition

public double getDoublePosition(int d)

Description copied from interface: RealLocalizable

Return the current position in a given dimension.

Specified by:

getDoublePosition in interface Localizable

Specified by:

getDoublePosition in interface RealLocalizable

Parameters:

d - dimension

Returns:

dimension of current position

localize

public void localize(int[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

localize

public void localize(long[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

localize

public void localize(Positionable position)

Description copied from interface: Localizable

Write the current position into the passed Positionable. Note for developers: This default implementation forwards to Positionable.setPosition(Localizable), so don't do the same there.

Specified by:

localize in interface Localizable

Parameters:

position - receives current position, EuclideanSpace.numDimensions() must be ≥ EuclideanSpace.numDimensions()

getIntPosition

public int getIntPosition(int d)

Description copied from interface: Localizable

Return the current position in a given dimension.

Specified by:

getIntPosition in interface Localizable

Parameters:

d - dimension

Returns:

dimension of current position

positionAsLongArray

public long[] positionAsLongArray()

Description copied from interface: Localizable

Allocate and return a long array containing the localizable's position. Please note that his method allocates a new array each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated array first and reuse it with Localizable.localize(long[]).

Specified by:

positionAsLongArray in interface Localizable

Returns:

the position

positionAsPoint

public Point positionAsPoint()

Description copied from interface: Localizable

Allocate and return a Point containing the localizable's position. Please note that his method allocates a new Point each time which introduces notable overhead in both compute and memory. If you query it frequently, you should allocate a dedicated Point first and reuse it with Localizable.localize(Positionable).

Specified by:

positionAsPoint in interface Localizable

Returns:

the position

getLongPosition

public long getLongPosition(int d)

Description copied from interface: Localizable

Return the current position in a given dimension.

Specified by:

getLongPosition in interface Localizable

Parameters:

d - dimension

Returns:

dimension of current position