Package net.imglib2.img.planar
Class PlanarLocalizingCursor<T extends NativeType<T>>
- java.lang.Object
-
- net.imglib2.AbstractEuclideanSpace
-
- net.imglib2.AbstractLocalizableInt
-
- net.imglib2.AbstractLocalizingCursorInt<T>
-
- net.imglib2.img.planar.PlanarLocalizingCursor<T>
-
- Type Parameters:
T
-
- All Implemented Interfaces:
java.util.Iterator<T>
,Cursor<T>
,EuclideanSpace
,PlanarImg.PlanarContainerSampler
,Iterator
,Localizable
,RealCursor<T>
,RealLocalizable
,Sampler<T>
- Direct Known Subclasses:
PlanarLocalizingCursor1D
,PlanarLocalizingCursor2D
public class PlanarLocalizingCursor<T extends NativeType<T>> extends AbstractLocalizingCursorInt<T> implements PlanarImg.PlanarContainerSampler
Localizing Iterator for aPlanarContainers
- Author:
- Stephan Preibisch, Stephan Saalfeld
-
-
Field Summary
Fields Modifier and Type Field Description protected PlanarImg<T,?>
container
protected int
index
The current index of the type.protected int
lastIndex
protected int
lastSliceIndex
protected int[]
max
Maximum of thePlanarImg
in every dimension.protected int
sliceIndex
protected T
type
-
Fields inherited from class net.imglib2.AbstractLocalizableInt
position
-
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
-
Constructor Summary
Constructors Modifier Constructor Description PlanarLocalizingCursor(PlanarImg<T,?> container)
protected
PlanarLocalizingCursor(PlanarLocalizingCursor<T> cursor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PlanarLocalizingCursor<T>
copy()
PlanarLocalizingCursor<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()
Note: This test is fragile in a sense that it returns true for elements after the last element as well.void
jumpFwd(long steps)
Move steps × forward.void
reset()
Reset theIterator
, that is put it to where it would be if newly created.-
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, toString, 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
-
-
-
-
Field Detail
-
type
protected final T extends NativeType<T> type
-
container
protected final PlanarImg<T extends NativeType<T>,?> container
-
lastIndex
protected final int lastIndex
-
lastSliceIndex
protected final int lastSliceIndex
-
sliceIndex
protected int sliceIndex
-
index
protected int index
The current index of the type. It is faster to duplicate this here than to access it through type.getIndex().
-
max
protected final int[] max
Maximum of thePlanarImg
in every dimension. This is used to check isOutOfBounds().
-
-
Constructor Detail
-
PlanarLocalizingCursor
protected PlanarLocalizingCursor(PlanarLocalizingCursor<T> cursor)
-
-
Method Detail
-
getCurrentSliceIndex
public int getCurrentSliceIndex()
- Specified by:
getCurrentSliceIndex
in interfacePlanarImg.PlanarContainerSampler
- Returns:
- the index of the slice the sampler is currently accessing.
-
get
public T get()
Description copied from interface:Sampler
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 PlanarLocalizingCursor<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 PlanarLocalizingCursor<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 boolean hasNext()
Note: This test is fragile in a sense that it returns true for elements after the last element as well.- Specified by:
hasNext
in interfacejava.util.Iterator<T extends NativeType<T>>
- Specified by:
hasNext
in interfaceIterator
- Returns:
- false for the last element
-
fwd
public void fwd()
Description copied from interface:Iterator
Move forward.
-
jumpFwd
public void jumpFwd(long steps)
Description copied from interface:Iterator
Move steps × forward.- Specified by:
jumpFwd
in interfaceIterator
- Overrides:
jumpFwd
in classAbstractLocalizingCursorInt<T extends NativeType<T>>
- Parameters:
steps
- number of steps to move forward
-
-