AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.roi.AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>

Enclosing class:

AbstractIterableRegionOfInterest.AROIIterableInterval<T extends Type<T>>
```
protected class AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor
extends Object
implements Cursor<T>
```

Constructor Summary

Constructors
Modifier Constructor and Description

AROICursor()

protected AROICursor(AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor cursor)

Constructors
Modifier	Constructor and Description
	`AROICursor()`
`protected`	`AROICursor(AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor cursor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor`	`copy()`
`AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor`	`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 dim)` Return the current position in a given dimension.
`float`	`getFloatPosition(int dim)` Return the current position in a given dimension.
`int`	`getIntPosition(int dim)` Return the current position in a given dimension.
`long`	`getLongPosition(int dim)` 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[] pos)` Write the current position into the passed array.
`void`	`localize(float[] pos)` Write the current position into the passed array.
`void`	`localize(int[] pos)` Write the current position into the passed array.
`void`	`localize(long[] pos)` Write the current position into the passed array.
`T`	`next()`
`int`	`numDimensions()` Gets the space's number of dimensions.
`void`	`remove()`
`void`	`reset()` Reset the `Iterator`, that is put it to where it would be if newly created.

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

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

Class AbstractIterableRegionOfInterest.AROIIterableInterval.AROICursor

Constructor Summary

Method Summary

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

Constructor Detail

AROICursor

AROICursor

Method Detail

localize

localize

localize

localize

getFloatPosition

getDoublePosition

getIntPosition

getLongPosition

numDimensions

get

jumpFwd

fwd

reset

hasNext

next

remove

copy

copyCursor