plugins.kernel.roi.roi2d

Class ROI2DEllipse

java.lang.Object

icy.roi.ROI

icy.roi.ROI2D

plugins.kernel.roi.roi2d.ROI2DShape

plugins.kernel.roi.roi2d.ROI2DRectShape

plugins.kernel.roi.roi2d.ROI2DEllipse

All Implemented Interfaces:

ChangeListener, XMLPersistent, java.awt.Shape

Direct Known Subclasses:

ROI2DEllipse

public class ROI2DEllipse
extends ROI2DRectShape

Author:

Stephane

Nested Class Summary

Nested classes/interfaces inherited from class plugins.kernel.roi.roi2d.ROI2DShape

ROI2DShape.ROI2DShapePainter

Nested classes/interfaces inherited from class icy.roi.ROI2D

ROI2D.ROI2DPainter

Nested classes/interfaces inherited from class icy.roi.ROI

ROI.ROIGroupId, ROI.ROIIdComparator, ROI.ROINameComparator, ROI.ROIPainter

Field Summary

Fields inherited from class plugins.kernel.roi.roi2d.ROI2DRectShape

ID_BOTTOMRIGHT, ID_TOPLEFT

Fields inherited from class icy.roi.ROI2D

ID_C, ID_T, ID_Z

Fields inherited from class icy.roi.ROI

DEFAULT_COLOR, DEFAULT_NORMAL_COLOR, DEFAULT_OPACITY, DEFAULT_STROKE, defaultColor, defaultOpacity, defaultShowName, defaultStroke, ID_CLASSNAME, ID_COLOR, ID_GROUPID, ID_ID, ID_NAME, ID_OPACITY, ID_PROPERTIES, ID_READONLY, ID_ROI, ID_SELECTED, ID_SHOWNAME, ID_STROKE, idComparator, nameComparator, PROPERTY_COLOR, PROPERTY_CREATING, PROPERTY_GROUPID, PROPERTY_ICON, PROPERTY_NAME, PROPERTY_OPACITY, PROPERTY_READONLY, PROPERTY_SHOWNAME, PROPERTY_STROKE, ROI_CHANGED_ALL, ROI_CHANGED_POSITION

Constructor Summary

Constructors

Constructor and Description
ROI2DEllipse()
ROI2DEllipse(double xmin, double ymin, double xmax, double ymax) Create a ROI ellipse from its rectangular bounds.
ROI2DEllipse(java.awt.geom.Ellipse2D ellipse)
ROI2DEllipse(java.awt.geom.Point2D pt)
ROI2DEllipse(java.awt.geom.Point2D pt, boolean cm) Deprecated.
ROI2DEllipse(java.awt.geom.Point2D topLeft, java.awt.geom.Point2D bottomRight)
ROI2DEllipse(java.awt.geom.Point2D topLeft, java.awt.geom.Point2D bottomRight, boolean cm) Deprecated.
ROI2DEllipse(Point5D pt) Generic constructor for interactive mode
ROI2DEllipse(java.awt.geom.Rectangle2D rectangle)
ROI2DEllipse(java.awt.geom.Rectangle2D rectangle, boolean cm) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
static double	computeEllipsePerimeter(double w, double h) Calculating the perimeter of an ellipse is non-trivial.
double	computeNumberOfContourPoints() Compute and returns the number of point (pixel) composing the ROI contour.
double	computeNumberOfPoints() Generic implementation for ROI2D using the BooleanMask object so the result is just an approximation.
java.lang.String	getDefaultName()
java.awt.geom.Ellipse2D	getEllipse()
double	getLength(Sequence sequence) Computes and returns the length/perimeter of the ROI in um given the pixel size informations from the specified Sequence.
void	setEllipse(java.awt.geom.Ellipse2D ellipse)
void	setToFitCircle(java.util.Collection<? extends java.awt.geom.Point2D> points) Adjust the ROI to fit the specified list of coordinates with a circle

Methods inherited from class plugins.kernel.roi.roi2d.ROI2DRectShape

canAddPoint, canRemovePoint, canSetBounds, controlPointPositionChanged, loadFromXML, saveToXML, setBounds2D, translate

Methods inherited from class plugins.kernel.roi.roi2d.ROI2DShape

addNewPoint, addNewPoint, addPoint, addPoint, addPointAt, canTranslate, computeBounds2D, contains, contains, contains, contains, controlPointOverlayChanged, getBooleanMask, getControlPoints, getExclusiveUnion, getIntersection, getPathIterator, getPathIterator, getPoints, getShape, getSubtraction, getUnion, hasSelectedPoint, intersects, intersects, isOverEdge, onChanged, painterChanged, removePoint, removePointAt, removeSelectedPoint, unselectAllPoints

Methods inherited from class icy.roi.ROI2D

canSetPosition, computeBounds5D, computePerimeter, contains, contains, contains, getArea, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask2D, getBooleanMask2D, getBounds, getBounds2D, getC, getDimension, getPerimeter, getPerimeter, getPosition, getPosition2D, getROI2DList, getROI2DList, getROI2DList, getSubROI, getT, getZ, intersects, intersects, isActiveFor, isActiveFor, isOver, isOver, isOverEdge, isOverEdge, isOverEdge, merge, setBounds5D, setC, setPosition, setPosition2D, setPosition5D, setT, setZ, substract, subtract

Methods inherited from class icy.roi.ROI

add, addListener, attachTo, beginUpdate, canvasToImageDeltaX, canvasToImageDeltaY, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaX, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaY, canvasToImageLogDeltaY, contains, contains, copyFrom, create, create, create, create, createFromXML, delete, delete, detachFrom, detachFromAll, detachFromAll, endUpdate, exclusiveAdd, focusChanged, getAdjustedStroke, getAdjustedStroke, getBooleanMask2D, getBounds5D, getClassName, getColor, getCopy, getDefaultColor, getDefaultOpacity, getDefaultShowName, getDefaultStroke, getDisplayColor, getFirstSequence, getFocusedColor, getGroupId, getIcon, getId, getName, getNameSuffix, getNumberOfContourPoints, getNumberOfPoints, getOpacity, getOverlay, getPainter, getPosition5D, getProperties, getProperty, getPropertyValue, getROICount, getROIList, getROIList, getROIList, getROIsFromXML, getSelectedColor, getSequences, getShowName, getSimpleClassName, getStroke, getVolume, internalFocus, internalSelect, internalUnfocus, internalUnselect, intersect, intersects, isAttached, isCreating, isDefaultName, isEditable, isEmpty, isFocused, isReadOnly, isSelected, isUpdating, loadFromXML, loadROIsFromXML, merge, mergeWith, nameChanged, painterChanged, propertyChanged, remove, remove, removeListener, roiChanged, roiChanged, roiChanged, saveROIsToXML, selectionChanged, setColor, setCreating, setDefaultColor, setDefaultOpacity, setDefaultShowName, setDefaultStroke, setEditable, setFocused, setGroupId, setIcon, setMousePos, setName, setOpacity, setProperty, setPropertyValue, setReadOnly, setROIsFromXML, setSelected, setSelected, setSelectedColor, setShowName, setStroke, subtract

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.Shape

getBounds, getBounds2D

Constructor Detail

ROI2DEllipse

@Deprecated
public ROI2DEllipse(java.awt.geom.Point2D topLeft,
                       java.awt.geom.Point2D bottomRight,
                       boolean cm)

Deprecated.

ROI2DEllipse

public ROI2DEllipse(java.awt.geom.Point2D topLeft,
            java.awt.geom.Point2D bottomRight)

ROI2DEllipse

public ROI2DEllipse(double xmin,
            double ymin,
            double xmax,
            double ymax)

Create a ROI ellipse from its rectangular bounds.

ROI2DEllipse

@Deprecated
public ROI2DEllipse(java.awt.geom.Rectangle2D rectangle,
                       boolean cm)

Deprecated.

ROI2DEllipse

public ROI2DEllipse(java.awt.geom.Rectangle2D rectangle)

ROI2DEllipse

public ROI2DEllipse(java.awt.geom.Ellipse2D ellipse)

ROI2DEllipse

@Deprecated
public ROI2DEllipse(java.awt.geom.Point2D pt,
                       boolean cm)

Deprecated.

ROI2DEllipse

public ROI2DEllipse(java.awt.geom.Point2D pt)

ROI2DEllipse

public ROI2DEllipse(Point5D pt)

Generic constructor for interactive mode

ROI2DEllipse

public ROI2DEllipse()

Method Detail

getDefaultName

public java.lang.String getDefaultName()

Overrides:

getDefaultName in class ROI2DShape

Returns:

the default name for this ROI class

getEllipse

public java.awt.geom.Ellipse2D getEllipse()

setEllipse

public void setEllipse(java.awt.geom.Ellipse2D ellipse)

getLength

public double getLength(Sequence sequence)
                 throws java.lang.UnsupportedOperationException

Description copied from class: ROI

Computes and returns the length/perimeter of the ROI in um given the pixel size informations from the specified Sequence.
Generic implementation of length computation uses the number of contour point (approximation). This method should be overridden whenever possible to provide faster and accurate calculation.
Throws a UnsupportedOperationException if the operation is not supported for this ROI.

Overrides:

getLength in class ROI2DShape

Throws:

java.lang.UnsupportedOperationException

See Also:

ROI.getNumberOfContourPoints()

computeNumberOfContourPoints

public double computeNumberOfContourPoints()

Description copied from class: ROI

Compute and returns the number of point (pixel) composing the ROI contour.

Overrides:

computeNumberOfContourPoints in class ROI2DShape

computeEllipsePerimeter

public static double computeEllipsePerimeter(double w,
                             double h)

Calculating the perimeter of an ellipse is non-trivial. Here we follow the approximation proposed in:
Ramanujan, S., "Modular Equations and Approximations to Pi," Quart. J. Pure. Appl. Math., v.45 (1913-1914), 350-372

Since:

Icy 1.5.3.2

computeNumberOfPoints

public double computeNumberOfPoints()

Description copied from class: ROI2D

Generic implementation for ROI2D using the BooleanMask object so the result is just an approximation. This method should be overridden whenever possible to provide more optimal approximations.

Overrides:

computeNumberOfPoints in class ROI2D

setToFitCircle

public void setToFitCircle(java.util.Collection<? extends java.awt.geom.Point2D> points)

Adjust the ROI to fit the specified list of coordinates with a circle

Parameters:

points - the list of points to fit