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:
Iterator<T>
,Cursor<T>
,EuclideanSpace
,PlanarImg.PlanarContainerSampler
,Iterator
,Localizable
,RealCursor<T>
,RealLocalizable
,Sampler<T>
public class PlanarPlaneSubsetCursor<T extends NativeType<T>>
extends AbstractCursorInt<T>
implements PlanarImg.PlanarContainerSampler
Basic Iterator for
PlanarContainers
- Author:
- Christian Dietz, Jonathan Hale
-
Field Summary
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
Constructor Summary
ConstructorsModifierConstructorDescriptionPlanarPlaneSubsetCursor
(PlanarImg<T, ?> container, Interval interval) Constructorprotected
Copy Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
final void
fwd()
Move forward.final T
get()
Access the actual T instance providing access to a pixel, sub-pixel or integral region value theSampler
points at.final int
final int
getIntPosition
(int dim) Return the current position in a given dimension.final boolean
hasNext()
Returns true if another step forward is possible.final void
jumpFwd
(long steps) Highly recommended to override this with a more efficient version.final void
localize
(int[] position) Write the current position into the passed array.final void
reset()
Reset theIterator
, that is put it to where it would be if newly created.toString()
Methods inherited from class net.imglib2.AbstractCursorInt
getDoublePosition, getFloatPosition, getLongPosition, localize, localize, localize, next, remove
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.EuclideanSpace
numDimensions
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Constructor Details
-
PlanarPlaneSubsetCursor
Copy Constructor- Parameters:
cursor
- - the cursor to copy from.
-
PlanarPlaneSubsetCursor
Constructor- Parameters:
container
- - the container this cursor shall work on.interval
- - the interval to iterate over.
-
-
Method Details
-
getCurrentSliceIndex
public final int getCurrentSliceIndex()- Specified by:
getCurrentSliceIndex
in interfacePlanarImg.PlanarContainerSampler
- Returns:
- the index of the slice the sampler is currently accessing.
-
get
Access the actual T instance providing access to a pixel, sub-pixel or integral region value theSampler
points at.- Specified by:
get
in interfaceSampler<T extends NativeType<T>>
-
copy
- Specified by:
copy
in interfaceSampler<T extends NativeType<T>>
- Specified by:
copy
in classAbstractCursorInt<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 theSampler
. 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 anArrayCursor
for example)
-
copyCursor
- Specified by:
copyCursor
in interfaceCursor<T extends NativeType<T>>
- Specified by:
copyCursor
in interfaceRealCursor<T extends NativeType<T>>
- Specified by:
copyCursor
in classAbstractCursorInt<T extends NativeType<T>>
-
hasNext
public final boolean hasNext()Returns true if another step forward is possible. -
fwd
public final void fwd()Move forward. -
jumpFwd
public final void jumpFwd(long steps) Highly recommended to override this with a more efficient version.- Specified by:
jumpFwd
in interfaceIterator
- Overrides:
jumpFwd
in classAbstractCursorInt<T extends NativeType<T>>
- Parameters:
steps
-
-
reset
public final void reset()Reset theIterator
, that is put it to where it would be if newly created. -
toString
- Overrides:
toString
in classAbstractCursorInt<T extends NativeType<T>>
-
localize
public final void localize(int[] position) Write the current position into the passed array.- Specified by:
localize
in interfaceLocalizable
- Parameters:
position
- receives current position
-
getIntPosition
public final int getIntPosition(int dim) Return the current position in a given dimension.- Specified by:
getIntPosition
in interfaceLocalizable
- Parameters:
dim
- dimension- Returns:
- dimension of current position
-