Package net.imglib2.stream

Class LocalizableSamplerWrapper<T>

java.lang.Object

net.imglib2.stream.LocalizableSamplerWrapper<T>

Type Parameters:

T - pixel type

All Implemented Interfaces:

java.util.Spliterator<LocalizableSampler<T>>, EuclideanSpace, Localizable, LocalizableSampler<T>, RealLocalizable, RealLocalizableSampler<T>, Sampler<T>, Typed<T>

class LocalizableSamplerWrapper<T>
extends java.lang.Object
implements java.util.Spliterator<LocalizableSampler<T>>, LocalizableSampler<T>

Wraps LocalizableSpliterator as Spliterator<LocalizableSampler<T>>.

Concretely, it implements LocalizableSampler, forwarding all methods to the wrapped LocalizableSpliterator. And passes itself as a proxy to the Consumer in tryAdvance(java.util.function.Consumer<? super net.imglib2.LocalizableSampler<T>>) and forEachRemaining(java.util.function.Consumer<? super net.imglib2.LocalizableSampler<T>>).

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 LocalizableSpliterator<T>	delegate

Fields inherited from interface java.util.Spliterator

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

Constructor Summary

Constructors

Constructor	Description
LocalizableSamplerWrapper(LocalizableSpliterator<T> delegate)	Wrap the given delegate as Spliterator<LocalizableSampler<T>>.

Method Summary

Modifier and Type	Method	Description
int	characteristics()
LocalizableSamplerWrapper<T>	copy()
long	estimateSize()
void	forEachRemaining(java.util.function.Consumer<? super LocalizableSampler<T>> action)
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.
boolean	tryAdvance(java.util.function.Consumer<? super LocalizableSampler<T>> action)
java.util.Spliterator<LocalizableSampler<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

delegate

private final LocalizableSpliterator<T> delegate

Constructor Detail

LocalizableSamplerWrapper

LocalizableSamplerWrapper(LocalizableSpliterator<T> delegate)

Wrap the given delegate as Spliterator<LocalizableSampler<T>>.

Parameters:

delegate - spliterator to wrap

Method Detail

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 LocalizableSamplerWrapper<T> copy()

Specified by:

copy in interface LocalizableSampler<T>

Specified by:

copy in interface RealLocalizableSampler<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)

forEachRemaining

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

Specified by:

forEachRemaining in interface java.util.Spliterator<T>

tryAdvance

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

Specified by:

tryAdvance in interface java.util.Spliterator<T>

trySplit

public java.util.Spliterator<LocalizableSampler<T>> trySplit()

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>

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

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

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

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

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