Package net.imglib2.img.array

Class AbstractArrayCursor<T extends NativeType<T>>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractCursorInt<T>

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

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrayCursor, ArraySubIntervalCursor

public abstract class AbstractArrayCursor<T extends NativeType<T>>
extends AbstractCursorInt<T>

Cursor on an ArrayImg.

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayImg<T,?>	img	Source image
protected int	lastIndex	Last index
protected int	offset	Offset of this cursor
protected int	size	Size of this cursor
protected T	type	An instance of T
private Index	typeIndex

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractArrayCursor(AbstractArrayCursor<T> cursor)	TODO Javadoc
	AbstractArrayCursor(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.
int	getIntPosition(int dim)	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(int[] position)	Write the current position into the passed array.
void	reset()	Reset the Iterator, that is put it to where it would be if newly created.
java.lang.String	toString()

Methods inherited from class net.imglib2.AbstractCursorInt

copy, getDoublePosition, getFloatPosition, getLongPosition, localize, 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, 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

positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealCursor

next

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Field Detail

offset

protected final int offset

Offset of this cursor

size

protected final int size

Size 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

Source image

lastIndex

protected final int lastIndex

Last index

Constructor Detail

AbstractArrayCursor

protected AbstractArrayCursor(AbstractArrayCursor<T> cursor)

TODO Javadoc

Parameters:

cursor -

AbstractArrayCursor

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

TODO Javadoc

Parameters:

img -

offset -

size -

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

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

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

fwd

public void fwd()

Description copied from interface: Iterator

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.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractCursorInt<T extends NativeType<T>>

getIntPosition

public int getIntPosition(int dim)

Description copied from interface: Localizable

Return the current position in a given dimension.

Parameters:

dim - dimension

Returns:

dimension of current position

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