Package net.imglib2.img.planar
Class PlanarCursor<T extends NativeType<T>>
java.lang.Object
net.imglib2.AbstractEuclideanSpace
net.imglib2.AbstractCursorInt<T>
net.imglib2.img.planar.PlanarCursor<T>
- Type Parameters:
T-
- All Implemented Interfaces:
Iterator<T>,Cursor<T>,EuclideanSpace,PlanarImg.PlanarContainerSampler,Iterator,Localizable,RealCursor<T>,RealLocalizable,Sampler<T>
- Direct Known Subclasses:
PlanarCursor1D,PlanarCursor2D
public class PlanarCursor<T extends NativeType<T>>
extends AbstractCursorInt<T>
implements PlanarImg.PlanarContainerSampler
Basic Iterator for
PlanarContainers- Author:
- Stephan Preibisch, Stephan Saalfeld
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected intThe current index of the type.protected final intprotected final intprotected intprotected final TFields inherited from class net.imglib2.AbstractEuclideanSpace
n -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPlanarCursor(PlanarCursor<T> cursor) PlanarCursor(PlanarImg<T, ?> container) -
Method Summary
Modifier and TypeMethodDescriptioncopy()voidfwd()Move forward.get()Access the actual T instance providing access to a pixel, sub-pixel or integral region value theSamplerpoints at.intintgetIntPosition(int dim) Return the current position in a given dimension.booleanhasNext()Note: This test is fragile in a sense that it returns true for elements after the last element as well.voidjumpFwd(long steps) Highly recommended to override this with a more efficient version.voidlocalize(int[] position) Write the current position into the passed array.voidreset()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, removeMethods 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
forEachRemaining
-
Field Details
-
type
-
container
-
lastIndex
protected final int lastIndex -
lastSliceIndex
protected final int lastSliceIndex -
sliceIndex
protected int sliceIndex -
index
protected int indexThe current index of the type. It is faster to duplicate this here than to access it through type.getIndex().
-
-
Constructor Details
-
PlanarCursor
-
PlanarCursor
-
-
Method Details
-
getCurrentSliceIndex
public int getCurrentSliceIndex()- Specified by:
getCurrentSliceIndexin interfacePlanarImg.PlanarContainerSampler- Returns:
- the index of the slice the sampler is currently accessing.
-
get
Description copied from interface:SamplerAccess 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 classAbstractCursorInt<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 classAbstractCursorInt<T extends NativeType<T>>
-
hasNext
public boolean hasNext()Note: This test is fragile in a sense that it returns true for elements after the last element as well. -
fwd
public void fwd()Description copied from interface:IteratorMove forward. -
jumpFwd
public void jumpFwd(long steps) Description copied from class:AbstractCursorIntHighly recommended to override this with a more efficient version.- Specified by:
jumpFwdin interfaceIterator- Overrides:
jumpFwdin classAbstractCursorInt<T extends NativeType<T>>- Parameters:
steps-
-
reset
public void reset()Description copied from interface:IteratorReset theIterator, that is put it to where it would be if newly created. -
toString
- Overrides:
toStringin classAbstractCursorInt<T extends NativeType<T>>
-
localize
public void localize(int[] position) Description copied from interface:LocalizableWrite the current position into the passed array.- Specified by:
localizein interfaceLocalizable- Parameters:
position- receives current position
-
getIntPosition
public int getIntPosition(int dim) Description copied from interface:LocalizableReturn the current position in a given dimension.- Specified by:
getIntPositionin interfaceLocalizable- Parameters:
dim- dimension- Returns:
- dimension of current position
-