CircleCursor (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.algorithm.region.CircleCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, EuclideanSpace, Localizable, RealCursor<T>, RealLocalizable, Sampler<T>
```
public class CircleCursor<T>
extends Object
implements Cursor<T>
```
Iterates over a Bresenham 2D circle using the mid-point algorithm.
Each point of the circle is iterated exactly once, and there is no "hole" in the circle. Contrary to the algorithm linked below, the circles generated by this cursor are "slim": each pixel of the circle is connected with 8-connectivity. For instance, a bitmap excerpt from such a circle looks like this:
```
 ..........
 OOO.......
 ...OO.....
 .....O....
 .....O....
 
```
Author:

Jean-Yves Tinevez

See Also:

Midpoint circle algorithm on Wikipedia.

Constructor Summary

Constructors
Constructor and Description
`CircleCursor(RandomAccessible<T> rai, Localizable center, long radius)` Iterates over a Bresenham circle in the target `RandomAccessible`.
`CircleCursor(RandomAccessible<T> rai, Localizable center, long radius, int dimX, int dimY)` Iterates over a Bresenham circle in the target `RandomAccessible`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Sampler<T>`	`copy()`
`Cursor<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()`
`int`	`numDimensions()` Gets the space's number of dimensions.
`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, remove

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

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

- Constructor Detail
  - CircleCursor
```
public CircleCursor(RandomAccessible<T> rai,
                    Localizable center,
                    long radius)
```
    Iterates over a Bresenham circle in the target RandomAccessible. Each point of the circle is iterated exactly once, and there is no "hole" in the circle.
    
    Parameters:
    
    rai - the random accessible. It is the caller responsibility to ensure it can be accessed everywhere the circle will be iterated.
    
    center - the circle center. Must be at least of dimension 2. Dimensions 0 and 1 are used to specify the circle center.
    
    radius - the circle radius. The circle is written in a plane in dimensions 0 and 1.
  - CircleCursor
```
public CircleCursor(RandomAccessible<T> rai,
                    Localizable center,
                    long radius,
                    int dimX,
                    int dimY)
```
    Iterates over a Bresenham circle in the target RandomAccessible. Each point of the circle is iterated exactly once, and there is no "hole" in the circle.
    
    Parameters:
    
    rai - the random accessible. It is the caller responsibility to ensure it can be accessed everywhere the circle will be iterated.
    
    center - the circle center. Must at least contain dimensions specified dimX and dimY.
    
    radius - the circle radius.
    
    dimX - the first dimension of the plane in which to draw the circle.
    
    dimY - the second dimension of the plane in which to draw the circle.
- Method Detail
  - reset
```
public void reset()
```
    Description copied from interface: Iterator
    
    Reset the Iterator, that is put it to where it would be if newly created.
  - 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
  - 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 Localizable
    
    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 Localizable
    
    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 Sampler<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)
  - jumpFwd
```
public void jumpFwd(long steps)
```
    Description copied from interface: Iterator
    
    Move steps × forward.
    
    Parameters:
    
    steps - number of steps to move forward
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - localize
```
public void localize(int[] 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
  - 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
  - getIntPosition
```
public int getIntPosition(int d)
```
    Description copied from interface: Localizable
    
    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)
```
    Description copied from interface: Localizable
    
    Return the current position in a given dimension.
    
    Specified by:
    
    getLongPosition in interface Localizable
    
    Parameters:
    
    d - dimension
    
    Returns:
    
    dimension of current position
  - copyCursor
```
public Cursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface Cursor<T>
    
    Specified by:
    
    copyCursor in interface RealCursor<T>

Class CircleCursor<T>

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

CircleCursor

CircleCursor

Method Detail

reset

fwd

hasNext

localize

localize

getFloatPosition

getDoublePosition

numDimensions

get

copy

jumpFwd

next

localize

localize

getIntPosition

getLongPosition

copyCursor