CircleCursor3D (SNT Javadocs 0-SNAPSHOT API)

java.lang.Object
- sc.fiji.snt.util.CircleCursor3D<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

DiskCursor3D
```
public class CircleCursor3D<T>
extends Object
implements Cursor<T>
```
Iterate the pixels of an oriented circle in 3-space using Bresenham's algorithm, where the circle is constructed from the unit normal to the circle plane, the center point, and radius. Alternatively, x and y basis vectors may be used in place of the circle normal.

Author:

Cameron Arshadi

See Also:

CircleCursor, Midpoint circle algorithm on Wikipedia.

Field Summary

Fields
Modifier and Type	Field and Description
`protected double[]`	`center`
`protected Localizable`	`centerPoint`
`protected double[]`	`doublePos`
`protected boolean`	`hasNext`
`protected long[]`	`longPos`
`protected RandomAccess<T>`	`ra`
`protected long`	`radius`
`protected RandomAccessible<T>`	`rai`
`protected long`	`x`
`protected double[]`	`xBasis`
`protected double[]`	`xVec`
`protected long`	`y`
`protected double[]`	`yBasis`
`protected double[]`	`yVec`

Constructor Summary

Constructors
Constructor and Description
`CircleCursor3D(RandomAccessible<T> rai, Localizable center, long radius, double[] circleNorm)` Iterates over a Bresenham circle in the target `RandomAccessible`.
`CircleCursor3D(RandomAccessible<T> rai, Localizable center, long radius, double[] xBasis, double[] yBasis)` 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()`
`T`	`get()`
`double`	`getDoublePosition(int d)`
`float`	`getFloatPosition(int d)`
`int`	`getIntPosition(int d)`
`long`	`getLongPosition(int d)`
`boolean`	`hasNext()`
`void`	`jumpFwd(long steps)`
`void`	`localize(double[] position)`
`void`	`localize(float[] position)`
`void`	`localize(int[] position)`
`void`	`localize(long[] position)`
`T`	`next()`
`int`	`numDimensions()`
`void`	`reset()`
`protected void`	`roundPos(double[] doublePos, long[] longPos)`
`protected void`	`setPos(long xScale, long yScale)`

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

- Field Detail
  - rai
```
protected final RandomAccessible<T> rai
```
  - ra
```
protected final RandomAccess<T> ra
```
  - centerPoint
```
protected final Localizable centerPoint
```
  - center
```
protected final double[] center
```
  - xBasis
```
protected final double[] xBasis
```
  - yBasis
```
protected final double[] yBasis
```
  - radius
```
protected final long radius
```
  - xVec
```
protected double[] xVec
```
  - yVec
```
protected double[] yVec
```
  - longPos
```
protected long[] longPos
```
  - doublePos
```
protected double[] doublePos
```
  - x
```
protected long x
```
  - y
```
protected long y
```
  - hasNext
```
protected boolean hasNext
```
- Constructor Detail
  - CircleCursor3D
```
public CircleCursor3D(RandomAccessible<T> rai,
                      Localizable center,
                      long radius,
                      double[] circleNorm)
```
    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's responsibility to ensure it can be accessed everywhere the circle will be iterated.
    
    center - the circle center. Must be at least of dimension 3. Dimensions 0, 1 and 2 are used to specify the circle center.
    
    radius - the circle radius.
    
    circleNorm - the unit normal to the circle plane, must be 3-dimensional. The "new" x and y basis vectors will be constructed from this vector.
  - CircleCursor3D
```
public CircleCursor3D(RandomAccessible<T> rai,
                      Localizable center,
                      long radius,
                      double[] xBasis,
                      double[] yBasis)
```
    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.
    
    radius - the circle radius.
    
    xBasis - the vector representing the "new" x-axis of the circle plane. Should be orthogonal to both the circle normal and the yBasis
    
    yBasis - the vector representing the "new" y-axis of the circle plane. Should be orthogonal to both the circle normal and the xBasis
- Method Detail
  - copyCursor
```
public Cursor<T> copyCursor()
```
    Specified by:
    
    copyCursor in interface Cursor<T>
    
    Specified by:
    
    copyCursor in interface RealCursor<T>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - jumpFwd
```
public void jumpFwd(long steps)
```
  - fwd
```
public void fwd()
```
  - setPos
```
protected void setPos(long xScale,
                      long yScale)
```
  - roundPos
```
protected void roundPos(double[] doublePos,
                        long[] longPos)
```
  - reset
```
public void reset()
```
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T>
  - localize
```
public void localize(float[] position)
```
    Specified by:
    
    localize in interface RealLocalizable
  - localize
```
public void localize(double[] position)
```
    Specified by:
    
    localize in interface RealLocalizable
  - localize
```
public void localize(int[] position)
```
    Specified by:
    
    localize in interface Localizable
  - localize
```
public void localize(long[] position)
```
    Specified by:
    
    localize in interface Localizable
  - getIntPosition
```
public int getIntPosition(int d)
```
    Specified by:
    
    getIntPosition in interface Localizable
  - getLongPosition
```
public long getLongPosition(int d)
```
    Specified by:
    
    getLongPosition in interface Localizable
  - getFloatPosition
```
public float getFloatPosition(int d)
```
    Specified by:
    
    getFloatPosition in interface Localizable
    
    Specified by:
    
    getFloatPosition in interface RealLocalizable
  - getDoublePosition
```
public double getDoublePosition(int d)
```
    Specified by:
    
    getDoublePosition in interface Localizable
    
    Specified by:
    
    getDoublePosition in interface RealLocalizable
  - numDimensions
```
public int numDimensions()
```
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - get
```
public T get()
```
    Specified by:
    
    get in interface Sampler<T>
  - copy
```
public Sampler<T> copy()
```
    Specified by:
    
    copy in interface Sampler<T>

Class CircleCursor3D<T>

Field Summary

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

Field Detail

rai

ra

centerPoint

center

xBasis

yBasis

radius

xVec

yVec

longPos

doublePos

x

y

hasNext

Constructor Detail

CircleCursor3D

CircleCursor3D

Method Detail

copyCursor

next

jumpFwd

fwd

setPos

roundPos

reset

hasNext

localize

localize

localize

localize

getIntPosition

getLongPosition

getFloatPosition

getDoublePosition

numDimensions

get

copy