net.imglib2.algorithm.region

Class CircleCursor<T>

java.lang.Object

net.imglib2.algorithm.region.CircleCursor<T>

All Implemented Interfaces:

Iterator<T>, net.imglib2.Cursor<T>, net.imglib2.EuclideanSpace, net.imglib2.Localizable, net.imglib2.RealCursor<T>, net.imglib2.RealLocalizable, net.imglib2.Sampler<T>, net.imglib2.Typed<T>

public class CircleCursor<T>
extends Object
implements net.imglib2.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(net.imglib2.RandomAccessible<T> rai, net.imglib2.Localizable center, long radius) Iterates over a Bresenham circle in the target RandomAccessible.
CircleCursor(net.imglib2.RandomAccessible<T> rai, net.imglib2.Localizable center, long radius, int dimX, int dimY) Iterates over a Bresenham circle in the target RandomAccessible.

Method Summary

Modifier and Type	Method and Description
net.imglib2.Cursor<T>	copy()
void	fwd()
T	get()
double	getDoublePosition(int d)
float	getFloatPosition(int d)
int	getIntPosition(int d)
long	getLongPosition(int d)
T	getType()
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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.Cursor

copyCursor

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface net.imglib2.Localizable

localize, localize, positionAsLongArray, positionAsPoint

Methods inherited from interface net.imglib2.RealLocalizable

positionAsDoubleArray, positionAsRealPoint

Constructor Detail

CircleCursor

public CircleCursor(net.imglib2.RandomAccessible<T> rai,
                    net.imglib2.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(net.imglib2.RandomAccessible<T> rai,
                    net.imglib2.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()

fwd

public void fwd()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

localize

public void localize(float[] position)

Specified by:

localize in interface net.imglib2.RealLocalizable

localize

public void localize(double[] position)

Specified by:

localize in interface net.imglib2.RealLocalizable

getFloatPosition

public float getFloatPosition(int d)

Specified by:

getFloatPosition in interface net.imglib2.Localizable

Specified by:

getFloatPosition in interface net.imglib2.RealLocalizable

getDoublePosition

public double getDoublePosition(int d)

Specified by:

getDoublePosition in interface net.imglib2.Localizable

Specified by:

getDoublePosition in interface net.imglib2.RealLocalizable

numDimensions

public int numDimensions()

Specified by:

numDimensions in interface net.imglib2.EuclideanSpace

get

public T get()

Specified by:

get in interface net.imglib2.Sampler<T>

getType

public T getType()

Specified by:

getType in interface net.imglib2.Sampler<T>

Specified by:

getType in interface net.imglib2.Typed<T>

jumpFwd

public void jumpFwd(long steps)

next

public T next()

Specified by:

next in interface Iterator<T>

Specified by:

next in interface net.imglib2.RealCursor<T>

localize

public void localize(int[] position)

Specified by:

localize in interface net.imglib2.Localizable

localize

public void localize(long[] position)

Specified by:

localize in interface net.imglib2.Localizable

getIntPosition

public int getIntPosition(int d)

Specified by:

getIntPosition in interface net.imglib2.Localizable

getLongPosition

public long getLongPosition(int d)

Specified by:

getLongPosition in interface net.imglib2.Localizable

copy

public net.imglib2.Cursor<T> copy()

Specified by:

copy in interface net.imglib2.Cursor<T>

Specified by:

copy in interface net.imglib2.RealCursor<T>

Specified by:

copy in interface net.imglib2.Sampler<T>