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
positionFields inherited from class net.imglib2.AbstractEuclideanSpace
n -
Constructor Summary
ConstructorsModifierConstructorDescriptionPlanarPlaneSubsetLocalizingCursor(PlanarImg<T, ?> container, Interval interval) ConstructorprotectedCopy Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()final voidfwd()Move forward.final Tget()Access the actual T instance providing access to a pixel, sub-pixel or integral region value theSamplerpoints at.final intfinal booleanhasNext()Returns true if another step forward is possible.final voidjumpFwd(long steps) Move steps × forward.final voidreset()Reset theIterator, that is put it to where it would be if newly created.toString()Methods inherited from class net.imglib2.AbstractLocalizingCursorInt
next, removeMethods inherited from class net.imglib2.AbstractLocalizableInt
getDoublePosition, getFloatPosition, getIntPosition, getLongPosition, localize, localize, localize, localizeMethods inherited from class net.imglib2.AbstractEuclideanSpace
numDimensionsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface net.imglib2.EuclideanSpace
numDimensionsMethods inherited from interface java.util.Iterator
forEachRemainingMethods inherited from interface net.imglib2.Localizable
getIntPosition, getLongPosition, localize, localizeMethods 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:
getCurrentSliceIndexin 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 theSamplerpoints at.- Specified by:
getin interfaceSampler<T extends NativeType<T>>
-
copy
- Specified by:
copyin interfaceSampler<T extends NativeType<T>>- Specified by:
copyin classAbstractLocalizingCursorInt<T extends NativeType<T>>- Returns:
- - A new
Samplerin 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 anArrayCursorfor example)
-
copyCursor
- Specified by:
copyCursorin interfaceCursor<T extends NativeType<T>>- Specified by:
copyCursorin interfaceRealCursor<T extends NativeType<T>>- Specified by:
copyCursorin 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:
jumpFwdin interfaceIterator- Overrides:
jumpFwdin 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
-