RealPointSampleList.RealPointSampleListCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.RealPointSampleList.RealPointSampleListCursor

All Implemented Interfaces:

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

Enclosing class:

RealPointSampleList<T>
```
public class RealPointSampleList.RealPointSampleListCursor
extends Object
implements RealCursor<T>
```

Field Summary

Fields
Modifier and Type Field and Description

protected int index

protected RealPoint position

protected T sample

Fields
Modifier and Type	Field and Description
`protected int`	`index`
`protected RealPoint`	`position`
`protected T`	`sample`

Constructor Summary

Constructors
Constructor and Description

RealPointSampleListCursor()

Constructors
Constructor and Description
`RealPointSampleListCursor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RealCursor<T>`	`copy()`
`RealCursor<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.
`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.
`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 net.imglib2.RealLocalizable
localize, positionAsDoubleArray, positionAsRealPoint

Methods inherited from interface java.util.Iterator
forEachRemaining

- Field Detail
  - index
```
protected int index
```
  - position
```
protected RealPoint position
```
  - sample
```
protected T sample
```
- Constructor Detail
  - RealPointSampleListCursor
```
public RealPointSampleListCursor()
```
- Method Detail
  - copy
```
public RealCursor<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 final RealCursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface RealCursor<T>
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Description copied from interface: RealLocalizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - 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
  - 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>
  - fwd
```
public void fwd()
```
    Description copied from interface: Iterator
    
    Move forward.
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: Iterator
    
    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
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Description copied from interface: Iterator
    
    Move steps × forward.
    
    Parameters:
    
    steps - number of steps to 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.
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T>

Class RealPointSampleList.RealPointSampleListCursor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RealLocalizable

Methods inherited from interface java.util.Iterator

Field Detail

index

position

sample

Constructor Detail

RealPointSampleListCursor

Method Detail

copy

copyCursor

getDoublePosition

getFloatPosition

localize

localize

numDimensions

get

fwd

hasNext

jumpFwd

reset

next

remove