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:
Iterator<T>,Cursor<T>,EuclideanSpace,Iterator,Localizable,RealCursor<T>,RealLocalizable,Sampler<T>
- Author:
- Stephan Preibisch, Stephan Saalfeld, Tobias Pietzsch
-
Field Summary
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n -
Constructor Summary
ConstructorsModifierConstructorDescriptionListCursor(AbstractListImg<T> img) protectedListCursor(ListCursor<T> cursor) -
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.intgetIntPosition(int d) Return the current position in a given dimension.booleanhasNext()Returns true if another step forward is possible.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.voidMethods inherited from class net.imglib2.AbstractCursorInt
getDoublePosition, getFloatPosition, getLongPosition, localize, localize, localize, next, remove, toStringMethods 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
-
Constructor Details
-
ListCursor
-
ListCursor
-
-
Method Details
-
get
Description copied from interface:SamplerAccess the actual T instance providing access to a pixel, sub-pixel or integral region value theSamplerpoints at. -
set
-
copy
- 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)
-
copyCursor
- Specified by:
copyCursorin interfaceCursor<T>- Specified by:
copyCursorin interfaceRealCursor<T>- Specified by:
copyCursorin classAbstractCursorInt<T>
-
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 class:AbstractCursorIntHighly recommended to override this with a more efficient version.- Specified by:
jumpFwdin interfaceIterator- Overrides:
jumpFwdin classAbstractCursorInt<T>- Parameters:
steps-
-
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
-
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
-