mpicbg.imglib.cursor.planar

Class PlanarLocalizableCursor<T extends Type<T>>

java.lang.Object

mpicbg.imglib.cursor.CursorImpl<T>

mpicbg.imglib.cursor.planar.PlanarCursor<T>

mpicbg.imglib.cursor.planar.PlanarLocalizableCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Localizable, LocalizableCursor<T>, Dimensionality

Direct Known Subclasses:

ImagePlusLocalizableCursor, PlanarLocalizableByDimCursor, PlanarLocalizablePlaneCursor

public class PlanarLocalizableCursor<T extends Type<T>>
extends PlanarCursor<T>
implements LocalizableCursor<T>

Localizing Iterator for a PlanarContainers

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	dimensions
protected int	numDimensions
protected int[]	position

Fields inherited from class mpicbg.imglib.cursor.planar.PlanarCursor

container, hasNext, lastIndex, lastSliceIndex, sliceIndex, type

Fields inherited from class mpicbg.imglib.cursor.CursorImpl

debug, image, isClosed

Constructor Summary

Constructors

Constructor and Description
PlanarLocalizableCursor(PlanarContainer<T,?> container, Image<T> image, T type)

Method Summary

Modifier and Type	Method and Description
void	fwd()
int[]	getPosition() Return a copy of the current position.
int	getPosition(int dim) Return the current position in a given dimension.
void	getPosition(int[] pos) Write the current position into the passed array.
String	getPositionAsString() Create a human-readable String representation of the current position.
void	reset()
String	toString()

Methods inherited from class mpicbg.imglib.cursor.planar.PlanarCursor

close, getStorageContainer, getStorageIndex, getType, hasNext

Methods inherited from class mpicbg.imglib.cursor.CursorImpl

createPositionArray, fwd, getArrayIndex, getDimensions, getDimensions, getImage, getNumDimensions, isActive, iterator, next, remove, setDebug

Methods inherited from class java.lang.Object

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

Methods inherited from interface mpicbg.imglib.cursor.Cursor

close, createPositionArray, getArrayIndex, getImage, getStorageContainer, getStorageIndex, getType, isActive, setDebug

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface mpicbg.imglib.cursor.vector.Dimensionality

getDimensions, getDimensions, getNumDimensions

Methods inherited from interface mpicbg.imglib.cursor.Iterable

fwd

Field Detail

numDimensions

protected final int numDimensions

position

protected final int[] position

dimensions

protected final int[] dimensions

Constructor Detail

PlanarLocalizableCursor

public PlanarLocalizableCursor(PlanarContainer<T,?> container,
                               Image<T> image,
                               T type)

Method Detail

fwd

public void fwd()

Specified by:

fwd in interface Iterable

Overrides:

fwd in class PlanarCursor<T extends Type<T>>

reset

public void reset()

Specified by:

reset in interface Cursor<T extends Type<T>>

Overrides:

reset in class PlanarCursor<T extends Type<T>>

getPosition

public void getPosition(int[] pos)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

getPosition in interface Localizable

getPosition

public int[] getPosition()

Description copied from interface: Localizable

Return a copy of the current position.

Specified by:

getPosition in interface Localizable

Returns:

getPosition

public int getPosition(int dim)

Description copied from interface: Localizable

Return the current position in a given dimension.

Specified by:

getPosition in interface Localizable

Returns:

getPositionAsString

public String getPositionAsString()

Description copied from interface: Localizable

Create a human-readable String representation of the current position.

Specified by:

getPositionAsString in interface Localizable

Returns:

toString

public String toString()

Overrides:

toString in class PlanarCursor<T extends Type<T>>