mpicbg.imglib.cursor.special

Class DiscCursor<T extends RealType<T>>

java.lang.Object

mpicbg.imglib.cursor.special.AbstractSpecialCursor<T>

mpicbg.imglib.cursor.special.CoordsCursor<T>

mpicbg.imglib.cursor.special.DomainCursor<T>

mpicbg.imglib.cursor.special.DiscCursor<T>

All Implemented Interfaces:

Iterator<T>, Cursor<T>, Iterable, Localizable, LocalizableCursor<T>, Dimensionality

public final class DiscCursor<T extends RealType<T>>
extends DomainCursor<T>

TODO

Field Summary

Fields inherited from class mpicbg.imglib.cursor.special.DomainCursor

size

Fields inherited from class mpicbg.imglib.cursor.special.CoordsCursor

calibration, origin, position

Fields inherited from class mpicbg.imglib.cursor.special.AbstractSpecialCursor

cursor, hasNext, img

Constructor Summary

Constructors

Constructor and Description
DiscCursor(Image<T> img, float[] center, float radius) Construct a DiscCursor on an image, using the spatial calibration stored in the image and a default OutOfBoundsStrategyValueFactory to handle off-bounds locations.
DiscCursor(Image<T> img, float[] center, float radius, float[] calibration) Construct a DiscCursor on an image with a given spatial calibration, using a default OutOfBoundsStrategyValueFactory to handle off-bounds locations.
DiscCursor(Image<T> img, float[] center, float radius, float[] calibration, OutOfBoundsStrategyFactory<T> outOfBoundsFactory) Construct a DiscCursor on an image with a given spatial calibration.
DiscCursor(Image<T> img, Localizable centerCursor, float radius) Construct a DiscCursor on an, using the spatial calibration stored in the image and a default OutOfBoundsStrategyValueFactory to handle off-bounds locations.
DiscCursor(Image<T> img, Localizable centerCursor, float radius, float[] calibration) Construct a DiscCursor on an image, using the given spatial calibration and a default OutOfBoundsStrategyValueFactory to handle off-bounds locations.
DiscCursor(Image<T> img, Localizable centerCursor, float radius, float[] calibration, OutOfBoundsStrategyFactory<T> outOfBoundsFactory) Construct a DiscCursor on an image with a given spatial calibration and a given OutOfBoundsStrategyFactory to handle off-bounds locations.

Method Summary

Modifier and Type	Method and Description
void	fwd()
int	getNPixels() Return the number of pixels this cursor will iterate on (or, the number of iterations it will do before exhausting).
double	getPhi() Return the azimuth of the spherical coordinates of this cursor, with respect to its center.
void	reset()
void	setSize(float size) Change the radius of the disc this cursor iterates on.

Methods inherited from class mpicbg.imglib.cursor.special.CoordsCursor

getDistanceSquared, getPhysicalRelativeCoordinates, getRelativePosition, moveCenterTo, moveCenterToCoordinates, moveCenterToPosition

Methods inherited from class mpicbg.imglib.cursor.special.AbstractSpecialCursor

close, createPositionArray, fwd, getArrayIndex, getDimensions, getDimensions, getImage, getNumDimensions, getPosition, getPosition, getPosition, getPositionAsString, getStorageContainer, getStorageIndex, getType, hasNext, isActive, iterator, next, remove, setDebug

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DiscCursor

public DiscCursor(Image<T> img,
                  float[] center,
                  float radius,
                  float[] calibration,
                  OutOfBoundsStrategyFactory<T> outOfBoundsFactory)

Construct a DiscCursor on an image with a given spatial calibration.

Parameters:

img - the image

center - the disc center, in physical units

radius - the disc radius, in physical units

calibration - the spatial calibration (pixel size); if null, a calibration of 1 in all directions will be used

outOfBoundsFactory - the OutOfBoundsStrategyFactory that will be used to handle off-bound locations

DiscCursor

public DiscCursor(Image<T> img,
                  float[] center,
                  float radius,
                  float[] calibration)

Construct a DiscCursor on an image with a given spatial calibration, using a default OutOfBoundsStrategyValueFactory to handle off-bounds locations.

Parameters:

img - the image

center - the disc center, in physical units

radius - the disc radius, in physical units

calibration - the spatial calibration (pixel size); if null, a calibration of 1 in all directions will be used

DiscCursor

public DiscCursor(Image<T> img,
                  float[] center,
                  float radius)

Construct a DiscCursor on an image, using the spatial calibration stored in the image and a default OutOfBoundsStrategyValueFactory to handle off-bounds locations.

Parameters:

img - the image

center - the disc center, in physical units

radius - the disc radius, in physical units

See Also:

Image.setCalibration(float[])

DiscCursor

public DiscCursor(Image<T> img,
                  Localizable centerCursor,
                  float radius,
                  float[] calibration,
                  OutOfBoundsStrategyFactory<T> outOfBoundsFactory)

Construct a DiscCursor on an image with a given spatial calibration and a given OutOfBoundsStrategyFactory to handle off-bounds locations. The center of the disc is set by the Localizable given in argument.

Parameters:

img - the image

centerCursor - the localizable object which position will set the disc center

radius - the disc radius, in physical units

calibration - the spatial calibration (pixel size); if null, a calibration of 1 in all directions will be used

DiscCursor

public DiscCursor(Image<T> img,
                  Localizable centerCursor,
                  float radius,
                  float[] calibration)

Construct a DiscCursor on an image, using the given spatial calibration and a default OutOfBoundsStrategyValueFactory to handle off-bounds locations. The center of the disc is set by the Localizable given in argument.

Parameters:

img - the image

centerCursor - the cursor which position will set the disc center

radius - the disc radius, in physical units

DiscCursor

public DiscCursor(Image<T> img,
                  Localizable centerCursor,
                  float radius)

Construct a DiscCursor on an, using the spatial calibration stored in the image and a default OutOfBoundsStrategyValueFactory to handle off-bounds locations. The center of the disc is set by the Localizable given in argument.

Parameters:

img - the image

centerCursor - the localizable object which position will set the disc center

radius - the disc radius, in physical units

Method Detail

setSize

public void setSize(float size)

Change the radius of the disc this cursor iterates on. This resets this cursor.

Specified by:

setSize in class DomainCursor<T extends RealType<T>>

Parameters:

size - the radius to set, in physical units.

getNPixels

public int getNPixels()

Description copied from class: AbstractSpecialCursor

Return the number of pixels this cursor will iterate on (or, the number of iterations it will do before exhausting). This is useful when one needs to know the number of pixel iterated on in advance. For instance:

 DiscCursor dc = new DiscCursor(img, center, 5);
 int arrraySize = sc.getNPixels();
 float[] pixelVal = new float[arraySize];
 int index = 0;
 while (sc.hasNext()) {
        sc.fwd();
        pixelVal[index] = sc.getType().getRealFloat();
        index++;
 }
 

Specified by:

getNPixels in class AbstractSpecialCursor<T extends RealType<T>>

getPhi

public final double getPhi()

Return the azimuth of the spherical coordinates of this cursor, with respect to its center. Will be in the range ]-π, π].

In cylindrical coordinates, the azimuth is the angle measured between the X axis and the line OM where O is the sphere center and M is the cursor location

reset

public void reset()

fwd

public void fwd()