net.imglib2

Class AbstractCursor<T>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>, Typed<T>

Direct Known Subclasses:

AbstractLongListImg.LongListCursor, CellCursor

public abstract class AbstractCursor<T>
extends AbstractEuclideanSpace
implements Cursor<T>

Abstract implementation of Cursor. Java's Iterator interface is implemented by mapping to abstract Iterator.fwd() and Sampler.get().

For localization, default implementations are available that all build on the abstract long variant. For particular cursors, this may be implemented more efficiently saving at least one loop over n.

Author:

Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Constructor and Description
AbstractCursor(int n)

Method Summary

Modifier and Type	Method and Description
abstract AbstractCursor<T>	copy()
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.
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.
String	toString()

Methods inherited from class net.imglib2.AbstractEuclideanSpace

numDimensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imglib2.Cursor

copyCursor

Methods inherited from interface net.imglib2.RealCursor

next

Methods inherited from interface net.imglib2.Sampler

get, getType

Methods inherited from interface net.imglib2.Iterator

fwd, hasNext, jumpFwd, reset

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, remove

Methods inherited from interface net.imglib2.Localizable

getLongPosition, localize, localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Constructor Detail

AbstractCursor

public AbstractCursor(int n)

Parameters:

n - number of dimensions in the Img.

Method Detail

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

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

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

toString

public String toString()

Overrides:

toString in class Object

copy

public abstract AbstractCursor<T> copy()

Specified by:

copy in interface Cursor<T>

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)