Package net.imglib2.img.array

Class AbstractArrayLocalizingCursor<T extends NativeType<T>>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractLocalizableInt

net.imglib2.AbstractLocalizingCursorInt<T>

net.imglib2.img.array.AbstractArrayLocalizingCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrayLocalizingCursor, ArrayLocalizingSubIntervalCursor

public abstract class AbstractArrayLocalizingCursor<T extends NativeType<T>>
extends AbstractLocalizingCursorInt<T>

Localizing Cursor on an ArrayImg.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ArrayImg<T,?>	img	The underlying source ArrayImg.
protected final int	lastIndex	Last index.
protected final int[]	max	Maximum of the ArrayImg in every dimension.
protected final int	offset	Offset of this cursor.
protected final int	size	Size of this cursor.
protected final T	type	An instance of T.
private final Index	typeIndex

Fields inherited from class net.imglib2.AbstractLocalizableInt

position

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractArrayLocalizingCursor(AbstractArrayLocalizingCursor<T> cursor)	TODO Javadoc
	AbstractArrayLocalizingCursor(ArrayImg<T,?> img, int offset, int size)	TODO Javadoc

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class net.imglib2.AbstractLocalizingCursorInt

copy

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 Details

size

protected final int size

Size of this cursor.

offset

protected final int offset

Offset of this cursor.

type

protected final T extends NativeType<T> type

An instance of T.

typeIndex

private final Index typeIndex

img

protected final ArrayImg<T extends NativeType<T>,?> img

The underlying source ArrayImg.

lastIndex

protected final int lastIndex

Last index.

max

protected final int[] max

Maximum of the ArrayImg in every dimension. This is used to check isOutOfBounds().

Constructor Details

AbstractArrayLocalizingCursor

protected AbstractArrayLocalizingCursor(AbstractArrayLocalizingCursor<T> cursor)

TODO Javadoc

Parameters:

cursor -

AbstractArrayLocalizingCursor

public AbstractArrayLocalizingCursor(ArrayImg<T,?> img,
 int offset,
 int size)

TODO Javadoc

Parameters:

img -

offset -

size -

Method Details

get

public T get()

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

hasNext

public boolean hasNext()

Returns true if another step forward is possible.

Returns:

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

fwd

public void fwd()

Move forward.

jumpFwd

public void jumpFwd(long steps)

Move steps × forward.

Highly recommended to override this with a more efficient version.

Parameters:

steps - number of steps to move forward

reset

public void reset()

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