SlicingCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.AbstractEuclideanSpace
- - net.imglib2.view.iteration.SlicingCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>
```
public class SlicingCursor<T>
extends AbstractEuclideanSpace
implements Cursor<T>
```
Wrap a cursor that runs on a hyperslice and apply coordinate transform on localize calls.

Author:

Tobias Pietzsch

Field Summary
- Fields inherited from class net.imglib2.AbstractEuclideanSpace
  n

Constructor Summary

Constructors
Modifier Constructor and Description

protected SlicingCursor(SlicingCursor<T> cursor)

Constructors
Modifier	Constructor and Description
`protected`	`SlicingCursor(SlicingCursor<T> cursor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SlicingCursor<T>`	`copy()`
`SlicingCursor<T>`	`copyCursor()`
`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.
`double`	`getDoublePosition(int d)` Return the current position in a given dimension.
`float`	`getFloatPosition(int d)` Return the current position in a given dimension.
`int`	`getIntPosition(int d)` Return the current position in a given dimension.
`long`	`getLongPosition(int d)` Return the current position in a given dimension.
`boolean`	`hasNext()` Returns true if another step forward is possible.
`void`	`jumpFwd(long steps)` Move steps × forward.
`void`	`localize(double[] position)` Write the current position into the passed array.
`void`	`localize(float[] position)` Write the current position into the passed array.
`void`	`localize(int[] position)` Write the current position into the passed array.
`void`	`localize(long[] position)` Write the current position into the passed array.
`T`	`next()`
`void`	`remove()`
`void`	`reset()` Reset the `Iterator`, that is put it to where it would be if newly created.

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 java.util.Iterator
forEachRemaining

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

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

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Constructor Detail
  - SlicingCursor
```
protected SlicingCursor(SlicingCursor<T> cursor)
```
- Method Detail
  - localize
```
public void localize(int[] position)
```
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Parameters:
    
    position - receives current position
  - localize
```
public void localize(long[] position)
```
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface Localizable
    
    Parameters:
    
    position - receives current position
  - getIntPosition
```
public int getIntPosition(int d)
```
    Return the current position in a given dimension.
    
    Specified by:
    
    getIntPosition in interface Localizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getLongPosition
```
public long getLongPosition(int d)
```
    Return the current position in a given dimension.
    
    Specified by:
    
    getLongPosition in interface Localizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - localize
```
public void localize(float[] position)
```
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    position - receives current position
  - localize
```
public void localize(double[] position)
```
    Write the current position into the passed array.
    
    Specified by:
    
    localize in interface RealLocalizable
    
    Parameters:
    
    position - receives current position
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - get
```
public T get()
```
    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>
  - copy
```
public SlicingCursor<T> copy()
```
    Specified by:
    
    copy in interface Sampler<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)
  - copyCursor
```
public SlicingCursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface Cursor<T>
    
    Specified by:
    
    copyCursor in interface RealCursor<T>
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Move steps × forward.
    
    Parameters:
    
    steps - number of steps to move forward
  - fwd
```
public void fwd()
```
    Move forward.
  - reset
```
public void reset()
```
    Reset the Iterator, that is put it to where it would be if newly created.
  - hasNext
```
public boolean hasNext()
```
    Returns true if another step forward is possible.
    
    Specified by:
    
    hasNext in interface Iterator<T>
    
    Returns:
    
    true, if there is another step forward is possible, otherwise false
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T>

Class SlicingCursor<T>

Field Summary

Fields inherited from class net.imglib2.AbstractEuclideanSpace

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.AbstractEuclideanSpace

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Methods inherited from interface net.imglib2.Localizable

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface net.imglib2.EuclideanSpace

Constructor Detail

SlicingCursor

Method Detail

localize

localize

getIntPosition

getLongPosition

localize

localize

getFloatPosition

getDoublePosition

get

copy

copyCursor

jumpFwd

fwd

reset

hasNext

next

remove