Package net.imglib2.img.list

Class ListLocalizingCursor<T>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractLocalizableInt

net.imglib2.AbstractLocalizingCursorInt<T>

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

Type Parameters:

T - the pixel type

All Implemented Interfaces:

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

public final class ListLocalizingCursor<T>
extends AbstractLocalizingCursorInt<T>

Localizing Cursor on a ListImg.

Field Summary

Fields

Modifier and Type	Field	Description
private int	i
private AbstractListImg<T>	img
private long[]	max
private int	maxNumPixels

Fields inherited from class net.imglib2.AbstractLocalizableInt

position

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Constructor	Description
ListLocalizingCursor(AbstractListImg<T> img)
ListLocalizingCursor(ListLocalizingCursor<T> cursor)

Method Summary

Modifier and Type	Method	Description
ListLocalizingCursor<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.
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	reset()	Reset the Iterator, that is put it to where it would be if newly created.
void	set(T t)

Methods inherited from class net.imglib2.AbstractLocalizableInt

getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize

Methods inherited from class net.imglib2.AbstractEuclideanSpace

numDimensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imglib2.Cursor

copyCursor

Methods inherited from interface net.imglib2.EuclideanSpace

numDimensions

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface net.imglib2.Localizable

getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealCursor

next

Methods inherited from interface net.imglib2.RealLocalizable

localize, localize, positionAsDoubleArray, positionAsRealPoint

Field Detail

i

private int i

maxNumPixels

private final int maxNumPixels

max

private final long[] max

img

private final AbstractListImg<T> img

Constructor Detail

ListLocalizingCursor

public ListLocalizingCursor(ListLocalizingCursor<T> cursor)

ListLocalizingCursor

public ListLocalizingCursor(AbstractListImg<T> img)

Method Detail

fwd

public void fwd()

Description copied from interface: Iterator

Move forward.

jumpFwd

public void jumpFwd(long steps)

Description copied from interface: Iterator

Move steps × forward.

Highly recommended to override this with a more efficient version.

Parameters:

steps - number of steps to move forward

hasNext

public boolean hasNext()

Description copied from interface: Iterator

Returns true if another step forward is possible.

Returns:

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

reset

public void reset()

Description copied from interface: Iterator

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

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 ListLocalizingCursor<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 AbstractLocalizingCursorInt<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)