Package net.imglib2.img.cell
Class CellCursor<T extends NativeType<T>,C extends Cell<?>>
java.lang.Object
net.imglib2.AbstractEuclideanSpace
net.imglib2.AbstractCursor<T>
net.imglib2.img.cell.CellCursor<T,C>
- All Implemented Interfaces:
Iterator<T>,Cursor<T>,EuclideanSpace,AbstractCellImg.CellImgSampler<C>,Iterator,Localizable,RealCursor<T>,RealLocalizable,Sampler<T>
public class CellCursor<T extends NativeType<T>,C extends Cell<?>>
extends AbstractCursor<T>
implements AbstractCellImg.CellImgSampler<C>
Cursor on a AbstractCellImg.- Author:
- Tobias Pietzsch
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected intThe current index of the type.protected booleanCaches cursorOnCells.hasNext().protected intprotected final TFields inherited from class net.imglib2.AbstractEuclideanSpace
n -
Constructor Summary
ConstructorsModifierConstructorDescriptionCellCursor(AbstractCellImg<T, ?, C, ?> img) protectedCellCursor(CellCursor<T, C> cursor) -
Method Summary
Modifier and TypeMethodDescriptionCellCursor<T, C> copy()CellCursor<T, C> voidfwd()Move forward.get()Access the actual T instance providing access to a pixel, sub-pixel or integral region value theSamplerpoints at.getCell()longgetLongPosition(int dim) 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(long[] 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.AbstractCursor
getDoublePosition, getFloatPosition, getIntPosition, 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
-
cursorOnCells
-
lastIndexInCell
protected int lastIndexInCell -
index
protected int indexThe current index of the type. It is faster to duplicate this here than to access it through type.getIndex(). -
isNotLastCell
protected boolean isNotLastCellCaches cursorOnCells.hasNext().
-
-
Constructor Details
-
CellCursor
-
CellCursor
-
-
Method Details
-
getCell
- Specified by:
getCellin interfaceAbstractCellImg.CellImgSampler<T extends NativeType<T>>- Returns:
- the cell the sampler is currently in.
-
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 classAbstractCursor<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 classAbstractCursor<T extends NativeType<T>>
-
hasNext
public boolean hasNext()Description copied from interface:IteratorReturns true if another step forward is possible. -
jumpFwd
public void jumpFwd(long steps) Description copied from class:AbstractCursorHighly recommended to override this with a more efficient version.- Specified by:
jumpFwdin interfaceIterator- Overrides:
jumpFwdin classAbstractCursor<T extends NativeType<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. -
toString
- Overrides:
toStringin classAbstractCursor<T extends NativeType<T>>
-
getLongPosition
public long getLongPosition(int dim) Description copied from interface:LocalizableReturn the current position in a given dimension.- Specified by:
getLongPositionin interfaceLocalizable- Parameters:
dim- dimension- Returns:
- dimension of current position
-
localize
public void localize(long[] position) Description copied from interface:LocalizableWrite the current position into the passed array.- Specified by:
localizein interfaceLocalizable- Parameters:
position- receives current position
-