Package net.imglib2.img.planar

Class PlanarPlaneSubsetLocalizingCursor<T extends NativeType<T>>

java.lang.Object

net.imglib2.AbstractEuclideanSpace

net.imglib2.AbstractLocalizableInt

net.imglib2.AbstractLocalizingCursorInt<T>

net.imglib2.img.planar.PlanarPlaneSubsetLocalizingCursor<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 PlanarPlaneSubsetLocalizingCursor<T extends NativeType<T>>
extends AbstractLocalizingCursorInt<T>
implements PlanarImg.PlanarContainerSampler

Cursor optimized for one plane in an PlanarImg.

Field Summary

Fields

Modifier and Type	Field	Description
private PlanarImg<T,?>	container	Container
private int	dimX
private int	lastIndexPlane	Last index on the plane
private int	maxX
private int	sliceIndex	Current slice index
private T	type	Access to the type
private Index	typeIndex

Fields inherited from class net.imglib2.AbstractLocalizableInt

position

Fields inherited from class net.imglib2.AbstractEuclideanSpace

n

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PlanarPlaneSubsetLocalizingCursor<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()
T	getType()	Get an instance of T.
boolean	hasNext()	Returns true if another step forward is possible.
void	jumpFwd(long steps)	Move steps × forward.
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()
private void	updatePositionFromIndex(int index)

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, 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 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

lastIndexPlane

private final int lastIndexPlane

Last index on the plane

maxX

private final int maxX

dimX

private final int dimX

Constructor Detail

PlanarPlaneSubsetLocalizingCursor

protected PlanarPlaneSubsetLocalizingCursor(PlanarPlaneSubsetLocalizingCursor<T> cursor)

Copy Constructor

Parameters:

cursor - PlanarPlaneSubsetLocalizingCursor to copy from

PlanarPlaneSubsetLocalizingCursor

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

Constructor

Parameters:

container - PlanarImg this cursor shall work on.

interval - Interval over which shall be iterated.

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 PlanarPlaneSubsetLocalizingCursor<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 AbstractLocalizingCursorInt<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

updatePositionFromIndex

private void updatePositionFromIndex(int index)

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 java.lang.Object

offset

private long offset(Interval interval)