Package net.imglib2.img.cell
Class CellLocalizingCursor<T extends NativeType<T>,C extends Cell<?>>
- java.lang.Object
-
- net.imglib2.AbstractEuclideanSpace
-
- net.imglib2.AbstractLocalizable
-
- net.imglib2.AbstractLocalizingCursor<T>
-
- net.imglib2.img.cell.CellLocalizingCursor<T,C>
-
- All Implemented Interfaces:
java.util.Iterator<T>
,Cursor<T>
,EuclideanSpace
,AbstractCellImg.CellImgSampler<C>
,Iterator
,Localizable
,RealCursor<T>
,RealLocalizable
,Sampler<T>
public class CellLocalizingCursor<T extends NativeType<T>,C extends Cell<?>> extends AbstractLocalizingCursor<T> implements AbstractCellImg.CellImgSampler<C>
LocalizingCursor
on aAbstractCellImg
.- Author:
- Tobias Pietzsch
-
-
Field Summary
Fields Modifier and Type Field Description protected long[]
currentCellMax
protected long[]
currentCellMin
protected Cursor<C>
cursorOnCells
protected int
index
The current index of the type.protected boolean
isNotLastCell
Caches cursorOnCells.hasNext().protected int
lastIndexInCell
protected T
type
-
Fields inherited from class net.imglib2.AbstractLocalizable
position
-
Fields inherited from class net.imglib2.AbstractEuclideanSpace
n
-
-
Constructor Summary
Constructors Modifier Constructor Description CellLocalizingCursor(AbstractCellImg<T,?,C,?> img)
protected
CellLocalizingCursor(CellLocalizingCursor<T,C> cursor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CellLocalizingCursor<T,C>
copy()
CellLocalizingCursor<T,C>
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.C
getCell()
boolean
hasNext()
Returns true if another step forward is possible.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.AbstractLocalizingCursor
next, remove
-
Methods inherited from class net.imglib2.AbstractLocalizable
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
-
lastIndexInCell
protected int lastIndexInCell
-
currentCellMin
protected long[] currentCellMin
-
currentCellMax
protected long[] currentCellMax
-
index
protected int index
The current index of the type. It is faster to duplicate this here than to access it through type.getIndex().
-
isNotLastCell
protected boolean isNotLastCell
Caches cursorOnCells.hasNext().
-
-
Constructor Detail
-
CellLocalizingCursor
protected CellLocalizingCursor(CellLocalizingCursor<T,C> cursor)
-
CellLocalizingCursor
public CellLocalizingCursor(AbstractCellImg<T,?,C,?> img)
-
-
Method Detail
-
getCell
public C getCell()
- Specified by:
getCell
in interfaceAbstractCellImg.CellImgSampler<T extends NativeType<T>>
- Returns:
- the cell the sampler is currently in.
-
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 CellLocalizingCursor<T,C> copy()
- Specified by:
copy
in interfaceSampler<T extends NativeType<T>>
- Specified by:
copy
in classAbstractLocalizingCursor<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 CellLocalizingCursor<T,C> copyCursor()
- Specified by:
copyCursor
in interfaceCursor<T extends NativeType<T>>
- Specified by:
copyCursor
in interfaceRealCursor<T extends NativeType<T>>
- Specified by:
copyCursor
in classAbstractLocalizingCursor<T extends NativeType<T>>
-
hasNext
public boolean hasNext()
Description copied from interface:Iterator
Returns true if another step forward is possible.- Specified by:
hasNext
in interfacejava.util.Iterator<T extends NativeType<T>>
- Specified by:
hasNext
in interfaceIterator
- Returns:
- true, if there is another step forward is possible, otherwise false
-
jumpFwd
public void jumpFwd(long steps)
Description copied from interface:Iterator
Move steps × forward.- Specified by:
jumpFwd
in interfaceIterator
- Overrides:
jumpFwd
in classAbstractLocalizingCursor<T extends NativeType<T>>
- Parameters:
steps
- number of steps to move forward
-
fwd
public void fwd()
Description copied from interface:Iterator
Move forward.
-
-