Package net.imglib2

Class RealPointSampleList.RealPointSampleListCursor

java.lang.Object

net.imglib2.RealPointSampleList.RealPointSampleListCursor

All Implemented Interfaces:

java.util.Iterator<T>, EuclideanSpace, Iterator, RealCursor<T>, RealLocalizable, Sampler<T>, Typed<T>

Enclosing class:

RealPointSampleList<T>

public class RealPointSampleList.RealPointSampleListCursor
extends java.lang.Object
implements RealCursor<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	index
protected RealPoint	position
protected T	sample

Constructor Summary

Constructors

Constructor	Description
RealPointSampleListCursor()

Method Summary

Modifier and Type	Method	Description
RealCursor<T>	copy()
void	fwd()	Move forward.
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.
T	getType()	Get an instance of T.
boolean	hasNext()	Returns true if another step forward is possible.
void	jumpFwd(long steps)	Move steps × forward.
void	localize(double[] pos)	Write the current position into the passed array.
void	localize(float[] pos)	Write the current position into the passed array.
T	next()	Default implementation, calls Iterator.fwd() then Sampler.get().
int	numDimensions()	Gets the space's number of dimensions.
void	reset()	Reset the Iterator, that is put it to where it would be if newly created.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface net.imglib2.RealCursor

copyCursor

Methods inherited from interface net.imglib2.RealLocalizable

localize, positionAsDoubleArray, positionAsRealPoint

Field Detail

index

protected int index

position

protected RealPoint position

sample

protected T sample

Constructor Detail

RealPointSampleListCursor

public RealPointSampleListCursor()

Method Detail

copy

public RealCursor<T> copy()

Specified by:

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

getDoublePosition

public double getDoublePosition(int d)

Description copied from interface: RealLocalizable

Return the current position in a given dimension.

Specified by:

getDoublePosition in interface RealLocalizable

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 RealLocalizable

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

numDimensions

public int numDimensions()

Description copied from interface: EuclideanSpace

Gets the space's number of dimensions.

Specified by:

numDimensions in interface EuclideanSpace

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

fwd

public void fwd()

Description copied from interface: Iterator

Move forward.

Specified by:

fwd in interface Iterator

hasNext

public boolean hasNext()

Description copied from interface: Iterator

Returns true if another step forward is possible.

Specified by:

hasNext in interface java.util.Iterator<T>

Specified by:

hasNext in interface Iterator

Returns:

true, if there is another step forward is possible, otherwise false

jumpFwd

public void jumpFwd(long steps)

Description copied from interface: Iterator

Move steps × forward.

Highly recommended to override this with a more efficient version.

Specified by:

jumpFwd in interface Iterator

Parameters:

steps - number of steps to move forward

reset

public void reset()

Description copied from interface: Iterator

Reset the Iterator, that is put it to where it would be if newly created.

Specified by:

reset in interface Iterator

next

public T next()

Description copied from interface: RealCursor

Default implementation, calls Iterator.fwd() then Sampler.get().

Note, that hasNext() is not checked before fwd(). If such a check is desired it should be implemented in fwd() (throwing NoSuchElementException).

Specified by:

next in interface java.util.Iterator<T>

Specified by:

next in interface RealCursor<T>