KDTree.KDTreeCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.KDTree.KDTreeCursor

All Implemented Interfaces:

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

Enclosing class:

KDTree<T>
```
public final class KDTree.KDTreeCursor
extends Object
implements RealCursor<T>
```

Constructor Summary

Constructors
Constructor and Description

KDTreeCursor(KDTree.KDTreeCursor c)

KDTreeCursor(KDTree<T> kdtree)

Constructors
Constructor and Description
`KDTreeCursor(KDTree.KDTreeCursor c)`
`KDTreeCursor(KDTree<T> kdtree)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KDTree.KDTreeCursor`	`copy()`
`KDTree.KDTreeCursor`	`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[] position)` Write the current position into the passed array.
`void`	`localize(float[] position)` 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

- Constructor Detail
  - KDTreeCursor
```
public KDTreeCursor(KDTree<T> kdtree)
```
  - KDTreeCursor
```
public KDTreeCursor(KDTree.KDTreeCursor c)
```
- Method Detail
  - localize
```
public void localize(float[] position)
```
    Description copied from interface: RealLocalizable
    
    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)
```
    Description copied from interface: RealLocalizable
    
    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)
```
    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
  - 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
  - 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>
  - copy
```
public KDTree.KDTreeCursor 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)
  - 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>
    
    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>
  - copyCursor
```
public KDTree.KDTreeCursor copyCursor()
```
    Specified by:
    
    copyCursor in interface RealCursor<T>

Class KDTree.KDTreeCursor

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

Constructor Detail

KDTreeCursor

KDTreeCursor

Method Detail

localize

localize

getFloatPosition

getDoublePosition

numDimensions

get

copy

jumpFwd

fwd

reset

hasNext

next

remove

copyCursor