Package net.imglib2.img.planar

Class PlanarSpliterator<T extends NativeType<T>>

java.lang.Object

net.imglib2.img.planar.PlanarSpliterator<T>

Type Parameters:

T - pixel type

All Implemented Interfaces:

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

class PlanarSpliterator<T extends NativeType<T>>
extends java.lang.Object
implements LocalizableSpliterator<T>, PlanarImg.PlanarContainerSampler

LocalizableSpliterator for PlanarImg. Localizes on demand.

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 long	elementsPerSlice
private PlanarImg<T,?>	img
private Index	index
private int	lastIndexInLastSlice
private int	lastIndexInSlice
private int	lastSlice
private int	slice
private int[]	tmp	used internally to forward all localize() versions to the (abstract) int[] version.
private T	type

Fields inherited from interface java.util.Spliterator

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

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	PlanarSpliterator(PlanarImg<T,?> img, long origin, long fence)
private	PlanarSpliterator(PlanarSpliterator<T> o)

Method Summary

Modifier and Type	Method	Description
int	characteristics()
PlanarSpliterator<T>	copy()
long	estimateSize()
void	forEachRemaining(java.util.function.Consumer<? super T> action)
private void	forEachRemainingInSlice(java.util.function.Consumer<? super T> action)
T	get()	Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
int	getCurrentSliceIndex()
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.
private long	globalIndex(int slice, int index)
void	localize(double[] pos)	Write the current position into the passed array.
void	localize(float[] pos)	Write the current position into the passed array.
void	localize(int[] pos)	Write the current position into the passed array.
void	localize(long[] pos)	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.
boolean	tryAdvance(java.util.function.Consumer<? super T> action)
PlanarSpliterator<T>	trySplit()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imglib2.Localizable

positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface java.util.Spliterator

getComparator, getExactSizeIfKnown, hasCharacteristics

Field Detail

img

private final PlanarImg<T extends NativeType<T>,?> img

type

private final T extends NativeType<T> type

elementsPerSlice

private final long elementsPerSlice

lastSlice

private final int lastSlice

lastIndexInSlice

private final int lastIndexInSlice

lastIndexInLastSlice

private final int lastIndexInLastSlice

slice

private int slice

index

private final Index index

tmp

private final int[] tmp

used internally to forward all localize() versions to the (abstract) int[] version.

Constructor Detail

PlanarSpliterator

PlanarSpliterator(PlanarImg<T,?> img,
                  long origin,
                  long fence)

PlanarSpliterator

private PlanarSpliterator(PlanarSpliterator<T> o)

Method Detail

getCurrentSliceIndex

public int getCurrentSliceIndex()

Specified by:

getCurrentSliceIndex in interface PlanarImg.PlanarContainerSampler

Returns:

the index of the slice the sampler is currently accessing.

numDimensions

public int numDimensions()

Description copied from interface: EuclideanSpace

Gets the space's number of dimensions.

Specified by:

numDimensions in interface EuclideanSpace

tryAdvance

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

Specified by:

tryAdvance in interface java.util.Spliterator<T extends NativeType<T>>

forEachRemaining

public void forEachRemaining(java.util.function.Consumer<? super T> action)

Specified by:

forEachRemaining in interface java.util.Spliterator<T extends NativeType<T>>

forEachRemainingInSlice

private void forEachRemainingInSlice(java.util.function.Consumer<? super T> action)

globalIndex

private long globalIndex(int slice,
                         int index)

trySplit

public PlanarSpliterator<T> trySplit()

Specified by:

trySplit in interface LocalizableSpliterator<T extends NativeType<T>>

Specified by:

trySplit in interface RealLocalizableSpliterator<T extends NativeType<T>>

Specified by:

trySplit in interface java.util.Spliterator<T extends NativeType<T>>

estimateSize

public long estimateSize()

Specified by:

estimateSize in interface java.util.Spliterator<T extends NativeType<T>>

characteristics

public int characteristics()

Specified by:

characteristics in interface java.util.Spliterator<T extends NativeType<T>>

copy

public PlanarSpliterator<T> copy()

Specified by:

copy in interface LocalizableSpliterator<T extends NativeType<T>>

Specified by:

copy in interface RealLocalizableSpliterator<T extends NativeType<T>>

Specified by:

copy in interface Sampler<T extends NativeType<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)

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 extends NativeType<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 extends NativeType<T>>

Specified by:

getType in interface Typed<T extends NativeType<T>>

Returns:

an instance of T

localize

public void localize(int[] pos)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

pos - receives current position, length 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

localize

public void localize(float[] pos)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

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

localize

public void localize(double[] pos)

Description copied from interface: RealLocalizable

Write the current position into the passed array.

Specified by:

localize in interface RealLocalizable

Parameters:

pos - 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()

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

localize

public void localize(long[] pos)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

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

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

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