mpicbg.imglib.cursor.array

Class Array3DLocalizableByDimOutOfBoundsCursor<T extends Type<T>>

java.lang.Object

mpicbg.imglib.cursor.CursorImpl<T>

mpicbg.imglib.cursor.array.ArrayCursor<T>

mpicbg.imglib.cursor.array.ArrayLocalizableCursor<T>

mpicbg.imglib.cursor.array.ArrayLocalizableByDimCursor<T>

mpicbg.imglib.cursor.array.ArrayLocalizableByDimOutOfBoundsCursor<T>

mpicbg.imglib.cursor.array.Array3DLocalizableByDimOutOfBoundsCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Localizable, Localizable3D, LocalizableByDim, LocalizableByDim3D, LocalizableByDimCursor<T>, LocalizableByDimCursor3D<T>, LocalizableCursor<T>, Dimensionality

public class Array3DLocalizableByDimOutOfBoundsCursor<T extends Type<T>>
extends ArrayLocalizableByDimOutOfBoundsCursor<T>
implements LocalizableByDimCursor3D<T>

TODO

Author:

Stephan Preibisch, Stephan Saalfeld

Field Summary

Fields

Modifier and Type	Field and Description
protected int	x
protected int	y
protected int	z

Fields inherited from class mpicbg.imglib.cursor.array.ArrayLocalizableByDimCursor

step

Fields inherited from class mpicbg.imglib.cursor.array.ArrayLocalizableCursor

dimensions, numDimensions, position

Fields inherited from class mpicbg.imglib.cursor.array.ArrayCursor

maxIndex, type

Fields inherited from class mpicbg.imglib.cursor.CursorImpl

debug, image, isClosed

Constructor Summary

Constructors

Constructor and Description
Array3DLocalizableByDimOutOfBoundsCursor(Array3D<T,?> container, Image<T> image, T type, OutOfBoundsStrategyFactory<T> outOfBoundsStrategyFactory)

Method Summary

Modifier and Type	Method and Description
void	bck(int dim)
void	bckX()
void	bckY()
void	bckZ()
void	fwd()
void	fwd(int dim)
void	fwdX()
void	fwdY()
void	fwdZ()
int[]	getPosition() Return a copy of the current position.
int	getPosition(int dim) Return the current position in a given dimension.
void	getPosition(int[] position) Write the current position into the passed array.
String	getPositionAsString() Create a human-readable String representation of the current position.
Array3D<T,?>	getStorageContainer()
int	getX()
int	getY()
int	getZ()
void	move(int steps, int dim)
void	moveRel(int x, int y, int z)
void	moveTo(int x, int y, int z)
void	moveX(int steps)
void	moveY(int steps)
void	moveZ(int steps)
void	reset()
void	setPosition(int[] position)
void	setPosition(int position, int dim)
void	setPosition(int posX, int posY, int posZ)
void	setPositionX(int pos)
void	setPositionY(int pos)
void	setPositionZ(int pos)

Methods inherited from class mpicbg.imglib.cursor.array.ArrayLocalizableByDimOutOfBoundsCursor

getType, hasNext

Methods inherited from class mpicbg.imglib.cursor.array.ArrayLocalizableByDimCursor

createLinearByDimCursor, createLocalNeighborhoodCursor, createRegionOfInterestCursor, moveRel, moveTo, moveTo, setPosition

Methods inherited from class mpicbg.imglib.cursor.array.ArrayLocalizableCursor

createLinearCursor, fwd, toString

Methods inherited from class mpicbg.imglib.cursor.array.ArrayCursor

close, getStorageIndex

Methods inherited from class mpicbg.imglib.cursor.CursorImpl

createPositionArray, 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.LocalizableByDimCursor

createLocalNeighborhoodCursor, createRegionOfInterestCursor

Methods inherited from interface mpicbg.imglib.cursor.Cursor

close, createPositionArray, getArrayIndex, getImage, 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.LocalizableByDim

moveRel, moveTo, moveTo, setPosition

Methods inherited from interface mpicbg.imglib.cursor.Iterable

fwd

Field Detail

x

protected int x

y

protected int y

z

protected int z

Constructor Detail

Array3DLocalizableByDimOutOfBoundsCursor

public Array3DLocalizableByDimOutOfBoundsCursor(Array3D<T,?> container,
                                                Image<T> image,
                                                T type,
                                                OutOfBoundsStrategyFactory<T> outOfBoundsStrategyFactory)

Method Detail

fwd

public void fwd()

Specified by:

fwd in interface Iterable

Overrides:

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

getX

public int getX()

Specified by:

getX in interface Localizable3D

getY

public int getY()

Specified by:

getY in interface Localizable3D

getZ

public int getZ()

Specified by:

getZ in interface Localizable3D

reset

public void reset()

Specified by:

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

Overrides:

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

getPosition

public void getPosition(int[] position)

Description copied from interface: Localizable

Write the current position into the passed array.

Specified by:

getPosition in interface Localizable

Overrides:

getPosition in class ArrayLocalizableCursor<T extends Type<T>>

getStorageContainer

public Array3D<T,?> getStorageContainer()

Specified by:

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

Overrides:

getStorageContainer in class ArrayCursor<T extends Type<T>>

getPosition

public int[] getPosition()

Description copied from interface: Localizable

Return a copy of the current position.

Specified by:

getPosition in interface Localizable

Overrides:

getPosition in class ArrayLocalizableCursor<T extends Type<T>>

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

Overrides:

getPosition in class ArrayLocalizableCursor<T extends Type<T>>

Returns:

fwd

public void fwd(int dim)

Specified by:

fwd in interface LocalizableByDim

Overrides:

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

fwdX

public void fwdX()

Specified by:

fwdX in interface LocalizableByDim3D

fwdY

public void fwdY()

Specified by:

fwdY in interface LocalizableByDim3D

fwdZ

public void fwdZ()

Specified by:

fwdZ in interface LocalizableByDim3D

move

public void move(int steps,
                 int dim)

Specified by:

move in interface LocalizableByDim

Overrides:

move in class ArrayLocalizableByDimOutOfBoundsCursor<T extends Type<T>>

moveRel

public void moveRel(int x,
                    int y,
                    int z)

Specified by:

moveRel in interface LocalizableByDim3D

moveTo

public void moveTo(int x,
                   int y,
                   int z)

Specified by:

moveTo in interface LocalizableByDim3D

moveX

public void moveX(int steps)

Specified by:

moveX in interface LocalizableByDim3D

moveY

public void moveY(int steps)

Specified by:

moveY in interface LocalizableByDim3D

moveZ

public void moveZ(int steps)

Specified by:

moveZ in interface LocalizableByDim3D

bck

public void bck(int dim)

Specified by:

bck in interface LocalizableByDim

Overrides:

bck in class ArrayLocalizableByDimOutOfBoundsCursor<T extends Type<T>>

bckX

public void bckX()

Specified by:

bckX in interface LocalizableByDim3D

bckY

public void bckY()

Specified by:

bckY in interface LocalizableByDim3D

bckZ

public void bckZ()

Specified by:

bckZ in interface LocalizableByDim3D

setPosition

public void setPosition(int[] position)

Specified by:

setPosition in interface LocalizableByDim

Overrides:

setPosition in class ArrayLocalizableByDimOutOfBoundsCursor<T extends Type<T>>

setPosition

public void setPosition(int posX,
                        int posY,
                        int posZ)

Specified by:

setPosition in interface LocalizableByDim3D

setPositionX

public void setPositionX(int pos)

Specified by:

setPositionX in interface LocalizableByDim3D

setPositionY

public void setPositionY(int pos)

Specified by:

setPositionY in interface LocalizableByDim3D

setPositionZ

public void setPositionZ(int pos)

Specified by:

setPositionZ in interface LocalizableByDim3D

setPosition

public void setPosition(int position,
                        int dim)

Specified by:

setPosition in interface LocalizableByDim

Overrides:

setPosition in class ArrayLocalizableByDimOutOfBoundsCursor<T extends Type<T>>

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

Overrides:

getPositionAsString in class ArrayLocalizableCursor<T extends Type<T>>

Returns: