net.imglib2.algorithm.region

Class EllipseCursor<T>

java.lang.Object

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

All Implemented Interfaces:

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

public class EllipseCursor<T>
extends Object
implements Cursor<T>

Iterates over a Bresenham 2D ellipse using the mid-point algorithm.

Each point of the ellipse is iterated exactly once, and there is no "hole" in the ellipse. A bitmap excerpt from such a ellipse looks like this:

 ..........
 OOO.......
 ...OO.....
 .....O....
 .....O....
 

The circle generated with equal X and Y radii is not strictly equivalent to the circle generated by the CircleCursor.

Author:

Jean-Yves Tinevez

Constructor Summary

Constructors

Constructor and Description
EllipseCursor(RandomAccessible<T> rai, Localizable center, long radiusX, long radiusY) Iterates over a Bresenham ellipse in the target RandomAccessible.
EllipseCursor(RandomAccessible<T> rai, Localizable center, long radiusX, long radiusY, int dimX, int dimY) Iterates over a Bresenham ellipse in the target RandomAccessible.

Method Summary

Modifier and Type	Method and Description
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()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

EllipseCursor

public EllipseCursor(RandomAccessible<T> rai,
                     Localizable center,
                     long radiusX,
                     long radiusY)

Iterates over a Bresenham ellipse in the target RandomAccessible. Each point of the ellipse is iterated exactly once, and there is no "hole" in the ellipse. The ellipse is written in a plane in dimensions 0 and 1.

Parameters:

rai - the random accessible. It is the caller responsibility to ensure it can be accessed everywhere the ellipse will be iterated.

center - the ellipse center. Must be at least of dimension 2. Dimensions 0 and 1 are used to specify the ellipse center.

radiusX - the ellipse radius in the dimension 0.

radiusY - the ellipse radius in the dimension 1.

EllipseCursor

public EllipseCursor(RandomAccessible<T> rai,
                     Localizable center,
                     long radiusX,
                     long radiusY,
                     int dimX,
                     int dimY)

Iterates over a Bresenham ellipse in the target RandomAccessible. Each point of the ellipse is iterated exactly once, and there is no "hole" in the ellipse.

Parameters:

rai - the random accessible. It is the caller responsibility to ensure it can be accessed everywhere the ellipse will be iterated.

center - the ellipse center. Must be at least of dimension 2. Dimensions 0 and 1 are used to specify the ellipse center.

radiusX - the ellipse radius in dimension X.

radiusY - the ellipse radius in dimension Y.

dimX - the first dimension of the plane in which to draw the ellipse.

dimY - the second dimension of the plane in which to draw the ellipse.

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 RealLocalizable

localize

public void localize(double[] position)

Specified by:

localize in interface RealLocalizable

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>

getType

public T getType()

Specified by:

getType in interface Sampler<T>

Specified by:

getType in interface Typed<T>

copy

public Cursor<T> copy()

Specified by:

copy in interface Cursor<T>

Specified by:

copy in interface RealCursor<T>

Specified by:

copy in interface Sampler<T>

jumpFwd

public void jumpFwd(long steps)

next

public T next()

Specified by:

next in interface Iterator<T>

Specified by:

next in interface RealCursor<T>

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

toString

public String toString()

Overrides:

toString in class Object