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>
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
Constructors Modifier Constructor Description PlanarPlaneSubsetLocalizingCursor(PlanarImg<T,?> container, Interval interval)
Constructorprotected
PlanarPlaneSubsetLocalizingCursor(PlanarPlaneSubsetLocalizingCursor<T> cursor)
Copy Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PlanarPlaneSubsetLocalizingCursor<T>
copy()
PlanarPlaneSubsetLocalizingCursor<T>
copyCursor()
void
fwd()
Move forward.T
get()
Access the actual T instance providing access to a pixel, sub-pixel or integral region value theSampler
points at.int
getCurrentSliceIndex()
boolean
hasNext()
Returns true if another step forward is possible.void
jumpFwd(long steps)
Move steps × forward.void
reset()
Reset theIterator
, that is put it to where it would be if newly created.java.lang.String
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 net.imglib2.Localizable
getIntPosition, getLongPosition, localize, localize
-
Methods inherited from interface net.imglib2.RealLocalizable
getDoublePosition, getFloatPosition, localize, localize
-
-
-
-
Constructor Detail
-
PlanarPlaneSubsetLocalizingCursor
protected PlanarPlaneSubsetLocalizingCursor(PlanarPlaneSubsetLocalizingCursor<T> cursor)
Copy Constructor- Parameters:
cursor
- PlanarPlaneSubsetLocalizingCursor to copy from
-
-
Method Detail
-
getCurrentSliceIndex
public final int getCurrentSliceIndex()
- Specified by:
getCurrentSliceIndex
in interfacePlanarImg.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 theSampler
points at.- Specified by:
get
in interfaceSampler<T extends NativeType<T>>
-
copy
public PlanarPlaneSubsetLocalizingCursor<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
public PlanarPlaneSubsetLocalizingCursor<T> 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.- Specified by:
hasNext
in interfacejava.util.Iterator<T extends NativeType<T>>
- Specified by:
hasNext
in interfaceIterator
- Returns:
- true, if there is another step forward is possible, otherwise false
-
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
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-