net.imglib2.img.list

Class ListCursor<T>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractCursorInt<T>

net.imglib2.img.list.ListCursor<T>

Type Parameters:

T - the pixel type

All Implemented Interfaces:

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

public final class ListCursor<T>
extends AbstractCursorInt<T>

Cursor on a ListImg.

Author:

Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Modifier	Constructor and Description
	ListCursor(AbstractListImg<T> img)
protected	ListCursor(ListCursor<T> cursor)

Method Summary

Modifier and Type	Method and Description
ListCursor<T>	copy()
void	fwd()
T	get() Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.
int	getIntPosition(int d) Return the current position in a given dimension.
T	getType() Get an instance of T.
boolean	hasNext()
void	jumpFwd(long steps)
void	localize(int[] position) Write the current position into the passed array.
void	reset()
void	set(T t)

Methods inherited from class net.imglib2.AbstractCursorInt

getDoublePosition, getFloatPosition, getLongPosition, localize, localize, localize, localize, localize, 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 java.util.Iterator

forEachRemaining, remove

Methods inherited from interface net.imglib2.Localizable

positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Constructor Detail

ListCursor

protected ListCursor(ListCursor<T> cursor)

ListCursor

public ListCursor(AbstractListImg<T> img)

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.

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.

Returns:

an instance of T

set

public void set(T t)

copy

public ListCursor<T> copy()

Specified by:

copy in interface Cursor<T>

Specified by:

copy in interface RealCursor<T>

Specified by:

copy in interface Sampler<T>

Specified by:

copy in class AbstractCursorInt<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)

hasNext

public boolean hasNext()

jumpFwd

public void jumpFwd(long steps)

fwd

public void fwd()

reset

public void reset()

localize

public void localize(int[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Parameters:

position - 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.

Parameters:

d - dimension

Returns:

dimension of current position