java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.AbstractCursor<T>
  - - net.imglib2.img.cell.CellCursor<T,C>

All Implemented Interfaces:

java.util.Iterator<T>, Cursor<T>, EuclideanSpace, AbstractCellImg.CellImgSampler<C>, Iterator, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>, Typed<T>
```
public class CellCursor<T extends NativeType<T>,C extends Cell<?>>
extends AbstractCursor<T>
implements AbstractCellImg.CellImgSampler<C>
```
Cursor on a AbstractCellImg.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Cursor<C>`	`cursorOnCells`
`private CellGrid`	`grid`
`protected Index`	`i`
`protected boolean`	`isNotLastCell`	Caches cursorOnCells.hasNext().
`protected int`	`lastIndexInCell`
`private long[]`	`tmpIndices`
`protected T`	`type`
`protected int`	`typeIndex`	The current index of the type.

Fields inherited from class net.imglib2.AbstractEuclideanSpace
n

Constructor Summary

Constructors
Modifier Constructor Description

CellCursor(AbstractCellImg<T,?,C,?> img)

protected CellCursor(CellCursor<T,C> cursor)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CellCursor<T,C>`	`copy()`
`void`	`fwd()`	Move forward.
`T`	`get()`	Access the actual T instance providing access to a pixel, sub-pixel or integral region value the `Sampler` points at.
`C`	`getCell()`
`long`	`getLongPosition(int dim)`	Return the current position in a given dimension.
`T`	`getType()`	Get an instance of `T`.
`boolean`	`hasNext()`	Returns true if another step forward is possible.
`void`	`jumpFwd(long steps)`	Move steps × forward.
`void`	`localize(long[] position)`	Write the current position into the passed array.
`private void`	`moveToNextCell()`	Move cursor right before the first element of the next cell.
`void`	`reset()`	Reset the `Iterator`, that is put it to where it would be if newly created.
`java.lang.String`	`toString()`

Methods inherited from class net.imglib2.AbstractCursor
getDoublePosition, getFloatPosition, getIntPosition, 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, wait, wait, wait

Methods inherited from interface net.imglib2.Cursor
copyCursor

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

Methods inherited from interface java.util.Iterator
forEachRemaining, remove

Methods inherited from interface net.imglib2.Localizable
localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealCursor
next

Methods inherited from interface net.imglib2.RealLocalizable
positionAsDoubleArray, positionAsRealPoint

- Field Detail
  - type
```
protected final T extends NativeType<T> type
```
  - i
```
protected final Index i
```
  - cursorOnCells
```
protected final Cursor<C extends Cell<?>> cursorOnCells
```
  - grid
```
private final CellGrid grid
```
  - lastIndexInCell
```
protected int lastIndexInCell
```
  - typeIndex
```
protected int typeIndex
```
    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().
  - tmpIndices
```
private final long[] tmpIndices
```
- Constructor Detail
  - CellCursor
```
protected CellCursor(CellCursor<T,C> cursor)
```
  - CellCursor
```
public CellCursor(AbstractCellImg<T,?,C,?> img)
```
- Method Detail
  - getCell
```
public C getCell()
```
    Specified by:
    
    getCell in interface AbstractCellImg.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 the Sampler points at.
    
    Specified by:
    
    get in interface Sampler<T extends NativeType<T>>
  - getType
```
public T getType()
```
    Description copied from interface: Typed
    
    Get an instance of T.
    It should not be assumed that the returned T instance is an independent copy. In particular, repeated calls to getType() may return the same instance.
    
    Specified by:
    
    getType in interface Sampler<T extends NativeType<T>>
    
    Specified by:
    
    getType in interface Typed<T extends NativeType<T>>
    
    Returns:
    
    an instance of T
  - copy
```
public CellCursor<T,C> copy()
```
    Specified by:
    
    copy in interface Cursor<T extends NativeType<T>>
    
    Specified by:
    
    copy in interface RealCursor<T extends NativeType<T>>
    
    Specified by:
    
    copy in interface Sampler<T extends NativeType<T>>
    
    Specified by:
    
    copy in class AbstractCursor<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 the Sampler. 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 an ArrayCursor for example)
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: Iterator
    
    Returns true if another step forward is possible.
    
    Specified by:
    
    hasNext in interface java.util.Iterator<T extends NativeType<T>>
    
    Specified by:
    
    hasNext in interface Iterator
    
    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.
    Highly recommended to override this with a more efficient version.
    
    Specified by:
    
    jumpFwd in interface Iterator
    
    Parameters:
    
    steps - number of steps to move forward
  - fwd
```
public void fwd()
```
    Description copied from interface: Iterator
    
    Move forward.
    
    Specified by:
    
    fwd in interface Iterator
  - reset
```
public void reset()
```
    Description copied from interface: Iterator
    
    Reset the Iterator, that is put it to where it would be if newly created.
    
    Specified by:
    
    reset in interface Iterator
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class AbstractCursor<T extends NativeType<T>>
  - getLongPosition
```
public long getLongPosition(int dim)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getLongPosition in interface Localizable
    
    Parameters:
    
    dim - dimension
    
    Returns:
    
    dimension of current position
  - localize
```
public void localize(long[] position)
```
    Description copied from interface: Localizable
    
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Parameters:
    
    position - receives current position, length must be ≥ EuclideanSpace.numDimensions()
  - moveToNextCell
```
private void moveToNextCell()
```
    Move cursor right before the first element of the next cell. Update type and index variables.

Modifier	Constructor	Description
	`CellCursor(AbstractCellImg<T,?,C,?> img)`
`protected`	`CellCursor(CellCursor<T,C> cursor)`

Class CellCursor<T extends NativeType<T>,​C extends Cell<?>>

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractCursor

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.Cursor

Methods inherited from interface net.imglib2.EuclideanSpace

Methods inherited from interface java.util.Iterator

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealCursor

Methods inherited from interface net.imglib2.RealLocalizable

Field Detail

type

i

cursorOnCells

grid

lastIndexInCell

typeIndex

isNotLastCell

tmpIndices

Constructor Detail

CellCursor

CellCursor

Method Detail

getCell

get

getType

copy

hasNext

jumpFwd

fwd

reset

toString

getLongPosition

localize

moveToNextCell

Class CellCursor<T extends NativeType<T>,C extends Cell<?>>