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:
Iterator<T>
,Cursor<T>
,EuclideanSpace
,PlanarImg.PlanarContainerSampler
,Iterator
,Localizable
,RealCursor<T>
,RealLocalizable
,Sampler<T>
public class PlanarPlaneSubsetLocalizingCursor<T extends NativeType<T>>
extends AbstractLocalizingCursorInt<T>
implements PlanarImg.PlanarContainerSampler
Cursor optimized for one plane in an PlanarImg.
- Author:
- Jonathan Hale, Tobias Pietzsch
-
Field Summary
Fields inherited from class net.imglib2.AbstractLocalizableInt
position
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
Constructor Summary
ConstructorsModifierConstructorDescriptionPlanarPlaneSubsetLocalizingCursor
(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 boolean
hasNext()
Returns true if another step forward is possible.final void
jumpFwd
(long steps) Move steps × forward.final void
reset()
Reset theIterator
, that is put it to where it would be if newly created.toString()
Methods inherited from class net.imglib2.AbstractLocalizingCursorInt
next, remove
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.EuclideanSpace
numDimensions
Methods inherited from interface java.util.Iterator
forEachRemaining
Methods inherited from interface net.imglib2.Localizable
getIntPosition, getLongPosition, localize, localize
Methods inherited from interface net.imglib2.RealLocalizable
getDoublePosition, getFloatPosition, localize, localize
-
Constructor Details
-
PlanarPlaneSubsetLocalizingCursor
Copy Constructor- Parameters:
cursor
- PlanarPlaneSubsetLocalizingCursor to copy from
-
PlanarPlaneSubsetLocalizingCursor
Constructor- Parameters:
container
- PlanarImg this cursor shall work on.interval
- Interval over which shall be iterated.
-
-
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 classAbstractLocalizingCursorInt<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 classAbstractLocalizingCursorInt<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) Move steps × forward.- Specified by:
jumpFwd
in interfaceIterator
- Overrides:
jumpFwd
in classAbstractLocalizingCursorInt<T extends NativeType<T>>
- Parameters:
steps
- number of steps to move forward
-
reset
public final void reset()Reset theIterator
, that is put it to where it would be if newly created. -
toString
-