EllipseRegionOfInterest (ImgLib2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imglib2.roi.AbstractRegionOfInterest
- - net.imglib2.roi.AbstractIterableRegionOfInterest
  - - net.imglib2.roi.EllipseRegionOfInterest

All Implemented Interfaces:

EuclideanSpace, RealInterval, RealRandomAccessible<BitType>, RealRandomAccessibleRealInterval<BitType>, IterableRegionOfInterest, RegionOfInterest

Deprecated.
```
@Deprecated
public class EllipseRegionOfInterest
extends AbstractIterableRegionOfInterest
```
A (hyper) ellipse defined by an origin and a radius per dimension where the region of interest is defined by: ∑((Xⁿ - Oⁿ)/Rⁿ)² <= 1

Author:

Lee Kamentsky

Nested Class Summary
- Nested classes/interfaces inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest
  AbstractIterableRegionOfInterest.AROIClippedIterableInterval<T extends Type<T>>, AbstractIterableRegionOfInterest.AROIIterableInterval<T extends Type<T>>, AbstractIterableRegionOfInterest.AROIIterationOrder
- Nested classes/interfaces inherited from class net.imglib2.roi.AbstractRegionOfInterest
  AbstractRegionOfInterest.AROIRandomAccess

Field Summary
- Fields inherited from class net.imglib2.roi.AbstractRegionOfInterest
  nDimensions

Constructor Summary

Constructors
Constructor and Description
`EllipseRegionOfInterest()` Deprecated. Constructor of a 2-dimensional ellipse centered at the origin with radius 0.
`EllipseRegionOfInterest(int nDim)` Deprecated. Constructor of an N-dimensional hyper-ellipse centered at the origin with radius 0.
`EllipseRegionOfInterest(RealLocalizable origin)` Deprecated. Construct an N-dimensional hyper-ellipse centered at an origin with zero radius
`EllipseRegionOfInterest(RealLocalizable origin, double radius)` Deprecated. Construct a hyper-circle centered at an origin with the same radius for all dimensions.
`EllipseRegionOfInterest(RealLocalizable origin, double[] radii)` Deprecated. Construct an N-dimensional hyper-ellipse centered at the origin with a given radius.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`contains(double[] position)` Deprecated. Determine whether a point is a member of the region of interest
`protected void`	`getExtrema(long[] minima, long[] maxima)` Deprecated. Get the minimum and maximum corners of a bounding hypercube around all points in the ROI.
`void`	`getOrigin(double[] orig)` Deprecated.
`double`	`getOrigin(int d)` Deprecated. Get a single coordinate of the origin position
`void`	`getOrigin(RealPositionable orig)` Deprecated. Get the coordinates of the origin
`void`	`getRadii(double[] r)` Deprecated. Get the radius along all of the dimensions
`double`	`getRadius(int d)` Deprecated. Get the ellipse radius along the given dimension
`protected void`	`getRealExtrema(double[] minima, double[] maxima)` Deprecated. Get the minimum and maximum corners of a bounding hypercube using real coordinates (which might have fractional components) The implementer should only override this if the ROI is described in real coordinates.
`boolean`	`isMember(long[] position)` Deprecated. Test to see if an integer position is inside the ellipse.
`void`	`move(double[] displacement)` Deprecated.
`void`	`move(double displacement, int d)` Deprecated.
`void`	`move(RealLocalizable displacement)` Deprecated. Move the origin of the ellipse by the given displacement
`protected boolean`	`nextRaster(long[] position, long[] end)` Deprecated. Advance the position to the next raster.
`void`	`setOrigin(double[] origin)` Deprecated. Set the origin of the ellipse to the given coordinates
`void`	`setOrigin(double origin, int d)` Deprecated. Set the origin of the ellipse along the given dimension
`void`	`setOrigin(RealLocalizable origin)` Deprecated. Change the origin of the ellipse.
`void`	`setRadii(double[] radii)` Deprecated. Set all of the radii
`void`	`setRadius(double radius)` Deprecated. Set all radii similarly so that the ellipse is really a circle
`void`	`setRadius(double radius, int d)` Deprecated. Set the radius along the given dimension

Methods inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest
dimension, dimensions, getCachedSize, getIterableIntervalOverROI, invalidateCachedState, jumpFwd, max, max, max, min, min, min, nextRaster, remove, size

Methods inherited from class net.imglib2.roi.AbstractRegionOfInterest
numDimensions, realMax, realMax, realMax, realMin, realMin, realMin, realRandomAccess, realRandomAccess, validateRealExtremaCache

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.imglib2.RealRandomAccessible
getAt, getAt, getAt, realRandomAccess, realRandomAccess

Methods inherited from interface net.imglib2.RealInterval
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMax, realMin, realMin, realMin

Methods inherited from interface net.imglib2.EuclideanSpace
numDimensions

- Constructor Detail
  - EllipseRegionOfInterest
```
public EllipseRegionOfInterest()
```
    Deprecated.
    
    Constructor of a 2-dimensional ellipse centered at the origin with radius 0.
  - EllipseRegionOfInterest
```
public EllipseRegionOfInterest(int nDim)
```
    Deprecated.
    
    Constructor of an N-dimensional hyper-ellipse centered at the origin with radius 0.
    
    Parameters:
    
    nDim -
  - EllipseRegionOfInterest
```
public EllipseRegionOfInterest(RealLocalizable origin,
                               double[] radii)
```
    Deprecated.
    
    Construct an N-dimensional hyper-ellipse centered at the origin with a given radius.
    
    Parameters:
    
    origin -
    
    radii -
  - EllipseRegionOfInterest
```
public EllipseRegionOfInterest(RealLocalizable origin)
```
    Deprecated.
    
    Construct an N-dimensional hyper-ellipse centered at an origin with zero radius
    
    Parameters:
    
    origin -
  - EllipseRegionOfInterest
```
public EllipseRegionOfInterest(RealLocalizable origin,
                               double radius)
```
    Deprecated.
    
    Construct a hyper-circle centered at an origin with the same radius for all dimensions.
    
    Parameters:
    
    origin -
    
    radius -
- Method Detail
  - setOrigin
```
public void setOrigin(RealLocalizable origin)
```
    Deprecated.
    
    Change the origin of the ellipse.
    
    Parameters:
    
    origin - the new origin
  - setOrigin
```
public void setOrigin(double[] origin)
```
    Deprecated.
    
    Set the origin of the ellipse to the given coordinates
    
    Parameters:
    
    origin -
  - setOrigin
```
public void setOrigin(double origin,
                      int d)
```
    Deprecated.
    
    Set the origin of the ellipse along the given dimension
    
    Parameters:
    
    origin - the new center coordinate
    
    d - the dimension (0 to n-1 for n-dimensional hyper-ellipse) of the coordinate
  - move
```
public void move(RealLocalizable displacement)
```
    Deprecated.
    
    Move the origin of the ellipse by the given displacement
    
    Parameters:
    
    displacement - add this displacement to the origin coordinates.
  - move
```
public void move(double[] displacement)
```
    Deprecated.
    
    Specified by:
    
    move in interface RegionOfInterest
    
    Overrides:
    
    move in class AbstractRegionOfInterest
  - move
```
public void move(double displacement,
                 int d)
```
    Deprecated.
  - getOrigin
```
public double getOrigin(int d)
```
    Deprecated.
    
    Get a single coordinate of the origin position
    
    Parameters:
    
    d - dimension to retrieve
    
    Returns:
    
    the coordinate of the origin / center at that dimension
  - getOrigin
```
public void getOrigin(RealPositionable orig)
```
    Deprecated.
    
    Get the coordinates of the origin
    
    Parameters:
    
    orig - set the position of this RealPositionable to that of the origin.
  - getOrigin
```
public void getOrigin(double[] orig)
```
    Deprecated.
  - getRadius
```
public double getRadius(int d)
```
    Deprecated.
    
    Get the ellipse radius along the given dimension
    
    Parameters:
    
    d - fetch radius for this dimension
  - getRadii
```
public void getRadii(double[] r)
```
    Deprecated.
    
    Get the radius along all of the dimensions
    
    Parameters:
    
    r - an array of doubles to be filled with the radii
  - setRadius
```
public void setRadius(double radius)
```
    Deprecated.
    
    Set all radii similarly so that the ellipse is really a circle
    
    Parameters:
    
    radius -
  - setRadius
```
public void setRadius(double radius,
                      int d)
```
    Deprecated.
    
    Set the radius along the given dimension
    
    Parameters:
    
    radius - the new radius
    
    d - dimension to be adjusted
  - setRadii
```
public void setRadii(double[] radii)
```
    Deprecated.
    
    Set all of the radii
    
    Parameters:
    
    radii -
  - getExtrema
```
protected void getExtrema(long[] minima,
                          long[] maxima)
```
    Deprecated.
    
    Description copied from class: AbstractIterableRegionOfInterest
    
    Get the minimum and maximum corners of a bounding hypercube around all points in the ROI. The implementer should strongly consider implementing this to provide a more efficient implementation.
    
    Overrides:
    
    getExtrema in class AbstractIterableRegionOfInterest
    
    Parameters:
    
    minima - - minimum coordinates of the ROI
    
    maxima - - maximum coordinates of the ROI
  - getRealExtrema
```
protected void getRealExtrema(double[] minima,
                              double[] maxima)
```
    Deprecated.
    
    Description copied from class: AbstractIterableRegionOfInterest
    
    Get the minimum and maximum corners of a bounding hypercube using real coordinates (which might have fractional components) The implementer should only override this if the ROI is described in real coordinates. Otherwise, the pixel extrema are used.
    
    Overrides:
    
    getRealExtrema in class AbstractIterableRegionOfInterest
  - nextRaster
```
protected boolean nextRaster(long[] position,
                             long[] end)
```
    Deprecated.
    
    Description copied from class: AbstractIterableRegionOfInterest
    
    Advance the position to the next raster. The AbstractRegionOfInterest successively adds one to the lowest dimension of the position until the position is outside the ROI as determined by isMember. At this point, it calls nextRaster to find the start of the next raster. As an example, a rectangle might have x, y, width and height. The code would determine if the y position was before, within or after the rectangle bounds. If before, set position[0] = x, position[1] = y and return true, if within, set position[0] = x, position[1] += 1, if after, return false.
    
    Specified by:
    
    nextRaster in class AbstractIterableRegionOfInterest
    
    Parameters:
    
    position - on entry, the position of the raster after advancement to its end (or initial or final position)
    
    end - on exit, the coordinates of the end of the raster. Index 0 is generally the only pertinent variable, subsequent indices should be duplicates of the start raster. Nevertheless, using an array lets the caller pass the results as a modification of the array.
    
    Returns:
    
    true if there is a raster after this one.
  - contains
```
public boolean contains(double[] position)
```
    Deprecated.
    
    Description copied from interface: RegionOfInterest
    
    Determine whether a point is a member of the region of interest
    
    Parameters:
    
    position - position in question
    
    Returns:
    
    true if a member
  - isMember
```
public boolean isMember(long[] position)
```
    Deprecated.
    
    Test to see if an integer position is inside the ellipse.
    
    Parameters:
    
    position -

Class EllipseRegionOfInterest

Nested Class Summary

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest

Nested classes/interfaces inherited from class net.imglib2.roi.AbstractRegionOfInterest

Field Summary

Fields inherited from class net.imglib2.roi.AbstractRegionOfInterest

Constructor Summary

Method Summary

Methods inherited from class net.imglib2.roi.AbstractIterableRegionOfInterest

Methods inherited from class net.imglib2.roi.AbstractRegionOfInterest

Methods inherited from class java.lang.Object

Methods inherited from interface net.imglib2.RealRandomAccessible

Methods inherited from interface net.imglib2.RealInterval

Methods inherited from interface net.imglib2.EuclideanSpace

Constructor Detail

EllipseRegionOfInterest

EllipseRegionOfInterest

EllipseRegionOfInterest

EllipseRegionOfInterest

EllipseRegionOfInterest

Method Detail

setOrigin

setOrigin

setOrigin

move

move

move

getOrigin

getOrigin

getOrigin

getRadius

getRadii

setRadius

setRadius

setRadii

getExtrema

getRealExtrema

nextRaster

contains

isMember