Package net.imglib2.img.planar

Class PlanarPlaneSubsetCursor<T extends NativeType<T>>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractCursorInt<T>

net.imglib2.img.planar.PlanarPlaneSubsetCursor<T>

Type Parameters:

T -

All Implemented Interfaces:

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

public class PlanarPlaneSubsetCursor<T extends NativeType<T>>
extends AbstractCursorInt<T>
implements PlanarImg.PlanarContainerSampler

Basic Iterator for PlanarContainers

Field Summary

Fields

Modifier and Type	Field	Description
private PlanarImg<T,?>	container	Container
private int	lastPlaneIndex	Last index on plane
private int	planeSize	Size of one plane
private int	sliceIndex	Current slice index
private T	type	Access to the type
private Index	typeIndex

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

Modifier	Constructor	Description
	PlanarPlaneSubsetCursor(PlanarImg<T,?> container, Interval interval)	Constructor
protected	PlanarPlaneSubsetCursor(PlanarPlaneSubsetCursor<T> cursor)	Copy Constructor

Method Summary

Modifier and Type	Method	Description
PlanarPlaneSubsetCursor<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.
int	getCurrentSliceIndex()
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.
private long	offset(Interval interval)
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

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

type

private final T extends NativeType<T> type

Access to the type

typeIndex

private final Index typeIndex

container

private final PlanarImg<T extends NativeType<T>,?> container

Container

sliceIndex

private final int sliceIndex

Current slice index

planeSize

private final int planeSize

Size of one plane

lastPlaneIndex

private final int lastPlaneIndex

Last index on plane

Constructor Detail

PlanarPlaneSubsetCursor

protected PlanarPlaneSubsetCursor(PlanarPlaneSubsetCursor<T> cursor)

Copy Constructor

Parameters:

cursor - - the cursor to copy from.

PlanarPlaneSubsetCursor

public PlanarPlaneSubsetCursor(PlanarImg<T,?> container,
                               Interval interval)

Constructor

Parameters:

container - - the container this cursor shall work on.

interval - - the interval to iterate over.

Method Detail

getCurrentSliceIndex

public final int getCurrentSliceIndex()

Specified by:

getCurrentSliceIndex in interface PlanarImg.PlanarContainerSampler

Returns:

the index of the slice the sampler is currently accessing.

get

public final T get()

Access the actual T instance providing access to a pixel, sub-pixel or integral region value the Sampler points at.

Specified by:

get in interface Sampler<T extends NativeType<T>>

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.

Specified by:

getType in interface Sampler<T extends NativeType<T>>

Specified by:

getType in interface Typed<T extends NativeType<T>>

Returns:

an instance of T

copy

public PlanarPlaneSubsetCursor<T> copy()

Specified by:

copy in interface Cursor<T extends NativeType<T>>

Specified by:

copy in interface RealCursor<T extends NativeType<T>>

Specified by:

copy in interface Sampler<T extends NativeType<T>>

Specified by:

copy in class AbstractCursorInt<T extends NativeType<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)

hasNext

public final boolean hasNext()

Returns true if another step forward is possible.

Specified by:

hasNext in interface java.util.Iterator<T extends NativeType<T>>

Specified by:

hasNext in interface Iterator

Returns:

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

fwd

public final void fwd()

Move forward.

Specified by:

fwd in interface Iterator

jumpFwd

public final void jumpFwd(long steps)

Move steps × forward.

Highly recommended to override this with a more efficient version.

Specified by:

jumpFwd in interface Iterator

Parameters:

steps - number of steps to move forward

reset

public final void reset()

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

Specified by:

reset in interface Iterator

toString

public java.lang.String toString()

Overrides:

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

localize

public final void localize(int[] position)

Write the current position into the passed array.

Specified by:

localize in interface Localizable

Parameters:

position - receives current position, length must be ≥ EuclideanSpace.numDimensions()

getIntPosition

public final int getIntPosition(int dim)

Return the current position in a given dimension.

Specified by:

getIntPosition in interface Localizable

Parameters:

dim - dimension

Returns:

dimension of current position

offset

private long offset(Interval interval)