plugins.kernel.roi.roi2d

Class ROI2DPath

java.lang.Object

icy.roi.ROI

icy.roi.ROI2D

plugins.kernel.roi.roi2d.ROI2DShape

plugins.kernel.roi.roi2d.ROI2DPath

All Implemented Interfaces:

ChangeListener, XMLPersistent, java.awt.Shape

Direct Known Subclasses:

ROI2DPath

public class ROI2DPath
extends ROI2DShape

ROI Path.
This ROI can display a Path2D shape.
You can modify and remove points (adding new point isn't supported).

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

Modifier and Type	Field and Description
static java.lang.String	ID_POINT
static java.lang.String	ID_POINTS
static java.lang.String	ID_WINDING

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
ROI2DPath()
ROI2DPath(java.awt.geom.Path2D path) Build a new ROI2DPath from the specified path.
ROI2DPath(java.awt.geom.Path2D path, java.awt.geom.Area closedArea, java.awt.geom.Path2D openPath) Build a new ROI2DPath from the specified path.
ROI2DPath(java.awt.geom.Point2D position)
ROI2DPath(java.awt.geom.Point2D pt, boolean cm) Deprecated.
ROI2DPath(Point5D pt) Generic constructor for interactive mode
ROI2DPath(java.awt.Shape shape) Build a new ROI2DPath from the specified path.

Method Summary

Methods

Modifier and Type	Method and Description
ROI	add(ROI roi, boolean allowCreate) Adds content of specified ROI into this ROI.
boolean	canAddPoint() Return true if this ROI support adding new point
boolean	contains(double x, double y) Tests if the specified coordinates are inside the ROI.
boolean	contains(double x, double y, double w, double h) Tests if the ROI entirely contains the specified rectangular area.
boolean	contains(java.awt.geom.Point2D p) Tests if a specified Point2D is inside the ROI.
boolean	contains(java.awt.geom.Rectangle2D r) Tests if the interior of the ROI entirely contains the specified Rectangle2D.
boolean	contains(ROI roi) Tests if the ROI entirely contains the specified ROI.
ROI	exclusiveAdd(ROI roi, boolean allowCreate) Sets the content of this ROI to be the union of its current content and the content of the specified ROI, minus their intersection.
java.awt.geom.Area	getClosedArea() Returns the closed area part of the ROI2DPath in Area shape format
java.lang.String	getDefaultName()
java.awt.geom.Path2D	getOpenPath() Returns the open path part of the ROI2DPath in Path2D shape format
java.util.List<PathAnchor2D>	getPathAnchors() Return the list of control points for this ROI.
ROI	intersect(ROI roi, boolean allowCreate) Sets the content of this ROI to the intersection of its current content and the content of the specified ROI.
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
boolean	saveToXML(org.w3c.dom.Node node) SAVE
ROI	subtract(ROI roi, boolean allowCreate) Subtract the specified ROI content from current ROI.

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

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

Methods inherited from class icy.roi.ROI2D

canSetBounds, canSetPosition, computeBounds5D, computeNumberOfPoints, computePerimeter, 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, setBounds2D, setBounds5D, setC, setPosition, setPosition2D, setPosition5D, setT, setZ, substract, subtract

Methods inherited from class icy.roi.ROI

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, 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, 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

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

Field Detail

ID_POINTS

public static final java.lang.String ID_POINTS

See Also:

Constant Field Values

ID_POINT

public static final java.lang.String ID_POINT

See Also:

Constant Field Values

ID_WINDING

public static final java.lang.String ID_WINDING

See Also:

Constant Field Values

Constructor Detail

ROI2DPath

public ROI2DPath(java.awt.geom.Path2D path,
         java.awt.geom.Area closedArea,
         java.awt.geom.Path2D openPath)

Build a new ROI2DPath from the specified path.

ROI2DPath

public ROI2DPath(java.awt.geom.Path2D path)

Build a new ROI2DPath from the specified path.

ROI2DPath

public ROI2DPath(java.awt.Shape shape)

Build a new ROI2DPath from the specified path.

ROI2DPath

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

Deprecated.

ROI2DPath

public ROI2DPath(java.awt.geom.Point2D position)

ROI2DPath

public ROI2DPath(Point5D pt)

Generic constructor for interactive mode

ROI2DPath

public ROI2DPath()

Method Detail

getDefaultName

public java.lang.String getDefaultName()

Overrides:

getDefaultName in class ROI2DShape

Returns:

the default name for this ROI class

getClosedArea

public java.awt.geom.Area getClosedArea()

Returns the closed area part of the ROI2DPath in Area shape format

getOpenPath

public java.awt.geom.Path2D getOpenPath()

Returns the open path part of the ROI2DPath in Path2D shape format

canAddPoint

public boolean canAddPoint()

Description copied from class: ROI2DShape

Return true if this ROI support adding new point

Overrides:

canAddPoint in class ROI2DShape

contains

public boolean contains(double x,
               double y)

Description copied from class: ROI2D

Tests if the specified coordinates are inside the ROI.

Specified by:

contains in interface java.awt.Shape

Overrides:

contains in class ROI2DShape

Parameters:

x - the specified X coordinate to be tested

y - the specified Y coordinate to be tested

Returns:

true if the specified coordinates are inside the ROI boundary; false otherwise.

contains

public boolean contains(java.awt.geom.Point2D p)

Description copied from class: ROI2D

Tests if a specified Point2D is inside the ROI.

Specified by:

contains in interface java.awt.Shape

Overrides:

contains in class ROI2DShape

Parameters:

p - the specified Point2D to be tested

Returns:

true if the specified Point2D is inside the boundary of the ROI; false otherwise.

contains

public boolean contains(double x,
               double y,
               double w,
               double h)

Description copied from class: ROI2D

Tests if the ROI entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within the ROI for the entire rectangular area to be considered contained within the ROI.

The ROI.contains() method allows a ROI implementation to conservatively return false when:

• the intersect method returns true and
• the calculations to determine whether or not the ROI entirely contains the rectangular area are prohibitively expensive.

This means that for some ROIs this method might return false even though the ROI contains the rectangular area.

Specified by:

contains in interface java.awt.Shape

Overrides:

contains in class ROI2DShape

Parameters:

x - the X coordinate of the upper-left corner of the specified rectangular area

y - the Y coordinate of the upper-left corner of the specified rectangular area

w - the width of the specified rectangular area

h - the height of the specified rectangular area

Returns:

true if the interior of the ROI entirely contains the specified rectangular area; false otherwise or, if the ROI contains the rectangular area and the intersects method returns true and the containment calculations would be too expensive to perform.

contains

public boolean contains(java.awt.geom.Rectangle2D r)

Description copied from class: ROI2D

Tests if the interior of the ROI entirely contains the specified Rectangle2D. The ROI.contains() method allows a implementation to conservatively return false when:

• the intersect method returns true and
• the calculations to determine whether or not the ROI entirely contains the Rectangle2D are prohibitively expensive.

This means that for some ROIs this method might return false even though the ROI contains the Rectangle2D.

Specified by:

contains in interface java.awt.Shape

Overrides:

contains in class ROI2DShape

Parameters:

r - The specified Rectangle2D

Returns:

true if the interior of the ROI entirely contains the Rectangle2D; false otherwise or, if the ROI contains the Rectangle2D and the intersects method returns true and the containment calculations would be too expensive to perform.

See Also:

ROI2D.contains(double, double, double, double)

contains

public boolean contains(ROI roi)

Description copied from class: ROI

Tests if the ROI entirely contains the specified ROI. WARNING: this method may be "pixel accurate" only depending the internal implementation.

Overrides:

contains in class ROI2D

Returns:

true if the current ROI entirely contains the specified ROI; false otherwise.

add

public ROI add(ROI roi,
      boolean allowCreate)
        throws java.lang.UnsupportedOperationException

Description copied from class: ROI

Adds content of specified ROI into this ROI. The resulting content of this ROI will include the union of both ROI's contents.
Note that this operation work only if the 2 ROIs are compatible for that type of operation. If that is not the case a UnsupportedOperationException is thrown if allowCreate parameter is set to false, if the parameter is set to true the result may be returned in a new created ROI.

     // Example:
      roi1 (before)     +         roi2       =    roi1 (after)
 
     ################     ################     ################
     ##############         ##############     ################
     ############             ############     ################
     ##########                 ##########     ################
     ########                     ########     ################
     ######                         ######     ######    ######
     ####                             ####     ####        ####
     ##                                 ##     ##            ##
 

Overrides:

add in class ROI

Parameters:

roi - the ROI to be added to the current ROI

allowCreate - if set to true the method will create a new ROI to return the result of the operation if it cannot be directly processed on the current ROI

Returns:

the modified ROI or a new created ROI if the operation cannot be directly processed on the current ROI and allowCreate parameter was set to true

Throws:

java.lang.UnsupportedOperationException - if the two ROI cannot be added together.

See Also:

ROI.getUnion(ROI)

intersect

public ROI intersect(ROI roi,
            boolean allowCreate)
              throws java.lang.UnsupportedOperationException

Description copied from class: ROI

Sets the content of this ROI to the intersection of its current content and the content of the specified ROI. The resulting ROI will include only contents that were contained in both ROI.
Note that this operation work only if the 2 ROIs are compatible for that type of operation. If that is not the case a UnsupportedOperationException is thrown if allowCreate parameter is set to false, if the parameter is set to true the result may be returned in a new created ROI.

     // Example:
     roi1 (before) intersect    roi2        =   roi1 (after)
 
     ################     ################     ################
     ##############         ##############       ############
     ############             ############         ########
     ##########                 ##########           ####
     ########                     ########
     ######                         ######
     ####                             ####
     ##                                 ##
 

Overrides:

intersect in class ROI

Parameters:

roi - the ROI to be intersected to the current ROI

allowCreate - if set to true the method will create a new ROI to return the result of the operation if it cannot be directly processed on the current ROI

Returns:

the modified ROI or a new created ROI if the operation cannot be directly processed on the current ROI and allowCreate parameter was set to true

Throws:

java.lang.UnsupportedOperationException - if the two ROI cannot be intersected together.

See Also:

ROI.getIntersection(ROI)

exclusiveAdd

public ROI exclusiveAdd(ROI roi,
               boolean allowCreate)
                 throws java.lang.UnsupportedOperationException

Description copied from class: ROI

Sets the content of this ROI to be the union of its current content and the content of the specified ROI, minus their intersection. The resulting ROI will include only content that were contained in either this ROI or in the specified ROI, but not in both.
Note that this operation work only if the 2 ROIs are compatible for that type of operation. If that is not the case a UnsupportedOperationException is thrown if allowCreate parameter is set to false, if the parameter is set to true the result may be returned in a new created ROI.

     // Example:
      roi1 (before)   xor      roi2         =    roi1 (after)
 
     ################     ################
     ##############         ##############     ##            ##
     ############             ############     ####        ####
     ##########                 ##########     ######    ######
     ########                     ########     ################
     ######                         ######     ######    ######
     ####                             ####     ####        ####
     ##                                 ##     ##            ##
 

Overrides:

exclusiveAdd in class ROI

Parameters:

roi - the ROI to be exclusively added to the current ROI

allowCreate - if set to true the method will create a new ROI to return the result of the operation if it cannot be directly processed on the current ROI

Returns:

the modified ROI or a new created ROI if the operation cannot be directly processed on the current ROI and allowCreate parameter was set to true

Throws:

java.lang.UnsupportedOperationException - if the two ROI cannot be exclusively added together.

See Also:

ROI.getExclusiveUnion(ROI)

subtract

public ROI subtract(ROI roi,
           boolean allowCreate)
             throws java.lang.UnsupportedOperationException

Description copied from class: ROI

Subtract the specified ROI content from current ROI.
Note that this operation work only if the 2 ROIs are compatible for that type of operation. If that is not the case a UnsupportedOperationException is thrown if allowCreate parameter is set to false, if the parameter is set to true the result may be returned in a new created ROI.

Overrides:

subtract in class ROI

Parameters:

roi - the ROI to subtract from the current ROI

allowCreate - if set to true the method will create a new ROI to return the result of the operation if it cannot be directly processed on the current ROI

Returns:

the modified ROI or a new created ROI if the operation cannot be directly processed on the current ROI and allowCreate parameter was set to true

Throws:

java.lang.UnsupportedOperationException - if we can't subtract the specified ROI from this ROI

See Also:

ROI.getSubtraction(ROI)

getPathAnchors

public java.util.List<PathAnchor2D> getPathAnchors()

Return the list of control points for this ROI.

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

LOAD

Specified by:

loadFromXML in interface XMLPersistent

Overrides:

loadFromXML in class ROI2DShape

saveToXML

public boolean saveToXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

SAVE

Specified by:

saveToXML in interface XMLPersistent

Overrides:

saveToXML in class ROI2D