Package net.imglib2.img.list
Class ListCursor<T>
- java.lang.Object
-
- net.imglib2.AbstractEuclideanSpace
-
- net.imglib2.AbstractCursorInt<T>
-
- net.imglib2.img.list.ListCursor<T>
-
- Type Parameters:
T- the pixel type
- All Implemented Interfaces:
java.util.Iterator<T>,Cursor<T>,EuclideanSpace,Iterator,Localizable,RealCursor<T>,RealLocalizable,Sampler<T>,Typed<T>
public final class ListCursor<T> extends AbstractCursorInt<T>
-
-
Field Summary
Fields Modifier and Type Field Description private intiprivate AbstractListImg<T>imgprivate intmaxNumPixels-
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
-
Constructor Summary
Constructors Modifier Constructor Description ListCursor(AbstractListImg<T> img)protectedListCursor(ListCursor<T> cursor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListCursor<T>copy()voidfwd()Move forward.Tget()Access the actual T instance providing access to a pixel, sub-pixel or integral region value theSamplerpoints at.intgetIntPosition(int d)Return the current position in a given dimension.TgetType()Get an instance ofT.booleanhasNext()Returns true if another step forward is possible.voidjumpFwd(long steps)Move steps × forward.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.voidset(T t)-
Methods inherited from class net.imglib2.AbstractCursorInt
getDoublePosition, getFloatPosition, getLongPosition, localize, localize, localize, localize, localize, toString
-
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.Cursor
copyCursor
-
Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions
-
Methods inherited from interface net.imglib2.Localizable
positionAsLongArray, positionAsPoint
-
Methods inherited from interface net.imglib2.RealCursor
next
-
Methods inherited from interface net.imglib2.RealLocalizable
positionAsDoubleArray, positionAsRealPoint
-
-
-
-
Field Detail
-
i
private int i
-
maxNumPixels
private final int maxNumPixels
-
img
private final AbstractListImg<T> img
-
-
Constructor Detail
-
ListCursor
protected ListCursor(ListCursor<T> cursor)
-
ListCursor
public ListCursor(AbstractListImg<T> img)
-
-
Method Detail
-
get
public T get()
Description copied from interface:SamplerAccess the actual T instance providing access to a pixel, sub-pixel or integral region value theSamplerpoints at.
-
getType
public T getType()
Description copied from interface:TypedGet an instance ofT.It should not be assumed that the returned
Tinstance is an independent copy. In particular, repeated calls togetType()may return the same instance.- Returns:
- an instance of
T
-
set
public void set(T t)
-
copy
public ListCursor<T> copy()
- Specified by:
copyin interfaceCursor<T>- Specified by:
copyin interfaceRealCursor<T>- Specified by:
copyin interfaceSampler<T>- Specified by:
copyin classAbstractCursorInt<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)
-
hasNext
public boolean hasNext()
Description copied from interface:IteratorReturns true if another step forward is possible.- Returns:
- true, if there is another step forward is possible, otherwise false
-
jumpFwd
public void jumpFwd(long steps)
Description copied from interface:IteratorMove steps × forward.Highly recommended to override this with a more efficient version.
- Parameters:
steps- number of steps to move forward
-
fwd
public void fwd()
Description copied from interface:IteratorMove forward.
-
reset
public void reset()
Description copied from interface:IteratorReset theIterator, that is put it to where it would be if newly created.
-
localize
public void localize(int[] position)
Description copied from interface:LocalizableWrite the current position into the passed array.- Parameters:
position- receives current position, length must be ≥EuclideanSpace.numDimensions()
-
getIntPosition
public int getIntPosition(int d)
Description copied from interface:LocalizableReturn the current position in a given dimension.- Parameters:
d- dimension- Returns:
- dimension of current position
-
-