ROI2D

java.lang.Object
- icy.roi.ROI
- - icy.roi.ROI2D

All Implemented Interfaces:

ChangeListener, XMLPersistent

Direct Known Subclasses:

ROI2DArea, ROI2DShape
```
public abstract class ROI2D
extends ROI
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ROI2D.ROI2DPainter
- Nested classes/interfaces inherited from class icy.roi.ROI
  ROI.ROIGroupId, ROI.ROIIdComparator, ROI.ROINameComparator, ROI.ROIPainter

Nested Classes
Modifier and Type	Class and Description
`class`	`ROI2D.ROI2DPainter`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String ID_C

static java.lang.String ID_T

static java.lang.String 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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ID_C`
`static java.lang.String`	`ID_T`
`static java.lang.String`	`ID_Z`

Constructor Summary

Constructors
Constructor and Description

ROI2D()

Constructors
Constructor and Description
`ROI2D()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canSetBounds()` Returns `true` if this ROI accepts bounds change through the `ROI.setBounds5D(Rectangle5D)` method.
`boolean`	`canSetPosition()` Returns `true` if this ROI accepts position change through the `ROI.setPosition5D(Point5D)` method.
`boolean`	`canTranslate()` Returns `true` if the ROI support translate operation.
`abstract java.awt.geom.Rectangle2D`	`computeBounds2D()` Calculate and returns the 2D bounding box of the `ROI`.
`Rectangle5D`	`computeBounds5D()` Calculate and returns the bounding box of the `ROI`.
`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.
`double`	`computePerimeter(Sequence sequence)` Deprecated. Perimeter computation cannot be cached so directly use #getLength(Sequence) instead.
`abstract boolean`	`contains(double x, double y)` Tests if the specified coordinates are inside the `ROI`.
`abstract boolean`	`contains(double x, double y, double w, double h)` Tests if the `ROI` entirely contains the specified rectangular area.
`boolean`	`contains(double x, double y, double z, double t, double c)` Tests if a specified 5D point is inside the ROI.
`boolean`	`contains(double x, double y, double z, double t, double c, double sizeX, double sizeY, double sizeZ, double sizeT, double sizeC)` Tests if the `ROI` entirely contains the specified 5D 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`.
`double`	`getArea()` Deprecated. Use `ROI.getNumberOfPoints()` instead.
`BooleanMask2D`	`getAsBooleanMask()` Deprecated. Use `getBooleanMask(boolean)` instead.
`BooleanMask2D`	`getAsBooleanMask(boolean inclusive)` Deprecated. Use `getBooleanMask(boolean)` instead.
`boolean[]`	`getAsBooleanMask(int x, int y, int w, int h)` Deprecated. Use `getBooleanMask(boolean)` instead.
`boolean[]`	`getAsBooleanMask(int x, int y, int w, int h, boolean inclusive)` Deprecated. Use `getBooleanMask(int, int, int, int, boolean)` instead.
`boolean[]`	`getAsBooleanMask(java.awt.Rectangle rect)` Deprecated. Use `getBooleanMask(boolean)` instead.
`boolean[]`	`getAsBooleanMask(java.awt.Rectangle rect, boolean inclusive)` Deprecated. Use `getBooleanMask(Rectangle, boolean)` instead.
`BooleanMask2D`	`getBooleanMask()` Deprecated. Use `getBooleanMask(boolean)` instead.
`BooleanMask2D`	`getBooleanMask(boolean inclusive)` Get the `BooleanMask2D` object representing the roi.
`boolean[]`	`getBooleanMask(int x, int y, int width, int height)` Deprecated. Use `getBooleanMask(int, int, int, int, boolean)` instead
`boolean[]`	`getBooleanMask(int x, int y, int width, int height, boolean inclusive)` Get the boolean bitmap mask for the specified rectangular area of the roi.
`boolean[]`	`getBooleanMask(java.awt.Rectangle rect)` Deprecated. Use `getBooleanMask(Rectangle, boolean)` instead
`boolean[]`	`getBooleanMask(java.awt.Rectangle rect, boolean inclusive)` Get the boolean bitmap mask for the specified rectangular area of the roi.
`BooleanMask2D`	`getBooleanMask2D(int z, int t, int c, boolean inclusive)` Returns the `BooleanMask2D` object representing the XY plan content at specified Z, T, C position.
`boolean[]`	`getBooleanMask2D(int x, int y, int width, int height, int z, int t, int c, boolean inclusive)` Returns the boolean array mask for the specified rectangular region at specified C, Z, T position.
`java.awt.Rectangle`	`getBounds()` Returns an integer `Rectangle` that completely encloses the `ROI`.
`java.awt.geom.Rectangle2D`	`getBounds2D()` Returns a high precision and more accurate bounding box of the `ROI` than the `getBounds` method.
`int`	`getC()` Returns the C position.
`java.lang.String`	`getDefaultName()`
`int`	`getDimension()` Returns the number of dimension of the ROI: 2 for ROI2D 3 for ROI3D 4 for ROI4D 5 for ROI5D
`double`	`getPerimeter()` Deprecated. Use `ROI.getNumberOfContourPoints()` instead.
`double`	`getPerimeter(Sequence sequence)` Deprecated. Use `ROI.getLength(Sequence)` instead
`java.awt.Point`	`getPosition()` Returns the upper left point of the ROI bounds.
`java.awt.geom.Point2D`	`getPosition2D()` Returns the ROI position which normally correspond to the minimum point of the ROI bounds: `new Point2D.Double(getBounds2D().getX(), getBounds2D().getY())`
`static java.util.ArrayList<ROI2D>`	`getROI2DList(java.util.ArrayList<ROI> rois)` Deprecated. Use `getROI2DList(List)` instead.
`static java.util.List<ROI2D>`	`getROI2DList(java.util.List<ROI> rois)` Return ROI2D of ROI list.
`static ROI2D[]`	`getROI2DList(ROI[] rois)` Deprecated. Use `getROI2DList(List)` instead.
`ROI`	`getSubROI(int z, int t, int c)` Returns a sub part of the ROI.
`int`	`getT()` Returns the T position.
`int`	`getZ()` Returns the Z position.
`abstract boolean`	`intersects(double x, double y, double w, double h)` Tests if the interior of the `ROI` intersects the interior of a specified rectangular area.
`boolean`	`intersects(double x, double y, double z, double t, double c, double sizeX, double sizeY, double sizeZ, double sizeT, double sizeC)` Tests if the interior of the `ROI` intersects the interior of a specified rectangular area.
`boolean`	`intersects(java.awt.geom.Rectangle2D r)` Tests if the interior of the `ROI` intersects the interior of a specified `Rectangle2D`.
`boolean`	`intersects(ROI roi)` Tests if the current `ROI` intersects the specified `ROI`.
`boolean`	`isActiveFor(IcyCanvas canvas)` Return true if the ROI is active for the specified canvas.
`boolean`	`isActiveFor(int z, int t, int c)` Return true if the ROI is active for the specified Z, T, C coordinates
`boolean`	`isOver(IcyCanvas canvas, double x, double y)` Deprecated. Use `isOverEdge(IcyCanvas, double, double)` instead.
`boolean`	`isOver(IcyCanvas canvas, java.awt.geom.Point2D p)` Deprecated. Use `isOverEdge(IcyCanvas, Point2D)` instead.
`abstract boolean`	`isOverEdge(IcyCanvas canvas, double x, double y)` Returns true if specified point coordinates overlap the ROI edge.
`boolean`	`isOverEdge(IcyCanvas canvas, double x, double y, double z, double t, double c)` Returns true if specified point coordinates overlap the ROI edge.
`boolean`	`isOverEdge(IcyCanvas canvas, java.awt.geom.Point2D p)` Returns true if specified point coordinates overlap the ROI edge.
`boolean`	`isOverEdge(IcyCanvas canvas, Point5D p)` Returns true if specified point coordinates overlap the ROI edge.
`boolean`	`loadFromXML(org.w3c.dom.Node node)` LOAD
`static ROI2D`	`merge(ROI2D[] rois, ShapeUtil.ShapeOperation operation)` Deprecated. Use `ROIUtil.merge(List, icy.util.ShapeUtil.BooleanOperator)` instead.
`boolean`	`saveToXML(org.w3c.dom.Node node)` SAVE
`void`	`setBounds2D(java.awt.geom.Rectangle2D bounds)` Set the `ROI` 2D bounds.
`void`	`setBounds5D(Rectangle5D bounds)` Set the `ROI` bounds.
`void`	`setC(int value)` Sets C position of this 2D ROI.
`void`	`setPosition(java.awt.geom.Point2D position)` Deprecated. Use `setPosition2D(Point2D)` instead.
`void`	`setPosition2D(java.awt.geom.Point2D position)` Set the `ROI` 2D position.
`void`	`setPosition5D(Point5D position)` Set the `ROI` position.
`void`	`setT(int value)` Sets T position of this 3D ROI.
`void`	`setZ(int value)` Sets Z position of this 2D ROI.
`static ROI2D`	`substract(ROI2D roi1, ROI2D roi2)` Deprecated. Use `ROI.getSubtraction(ROI)` instead.
`static ROI2D`	`subtract(ROI2D roi1, ROI2D roi2)` Deprecated. Use `ROI.getSubtraction(ROI)` instead.
`void`	`translate(double dx, double dy)` Translate the ROI position by the specified delta X/Y.

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, getExclusiveUnion, getFirstSequence, getFocusedColor, getGroupId, getIcon, getId, getIntersection, getLength, getName, getNameSuffix, getNumberOfContourPoints, getNumberOfPoints, getOpacity, getOverlay, getPainter, getPosition5D, getProperties, getProperty, getPropertyValue, getROICount, getROIList, getROIList, getROIList, getROIsFromXML, getSelectedColor, getSequences, getShowName, getSimpleClassName, getStroke, getSubtraction, getUnion, getVolume, hasSelectedPoint, internalFocus, internalSelect, internalUnfocus, internalUnselect, intersect, intersects, isAttached, isCreating, isDefaultName, isEditable, isEmpty, isFocused, isReadOnly, isSelected, isUpdating, loadFromXML, loadROIsFromXML, merge, mergeWith, nameChanged, onChanged, 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, unselectAllPoints

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

- Field Detail
  - ID_Z
```
public static final java.lang.String ID_Z
```
    See Also:
    Constant Field Values
  - ID_T
```
public static final java.lang.String ID_T
```
    See Also:
    Constant Field Values
  - ID_C
```
public static final java.lang.String ID_C
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ROI2D
```
public ROI2D()
```
- Method Detail
  - getROI2DList
```
public static java.util.List<ROI2D> getROI2DList(java.util.List<ROI> rois)
```
    Return ROI2D of ROI list.
  - getROI2DList
```
@Deprecated
public static java.util.ArrayList<ROI2D> getROI2DList(java.util.ArrayList<ROI> rois)
```
    Deprecated. Use getROI2DList(List) instead.
  - getROI2DList
```
@Deprecated
public static ROI2D[] getROI2DList(ROI[] rois)
```
    Deprecated. Use getROI2DList(List) instead.
  - merge
```
@Deprecated
public static ROI2D merge(ROI2D[] rois,
                     ShapeUtil.ShapeOperation operation)
```
    Deprecated. Use ROIUtil.merge(List, icy.util.ShapeUtil.BooleanOperator) instead.
  - substract
```
@Deprecated
public static ROI2D substract(ROI2D roi1,
                         ROI2D roi2)
```
    Deprecated. Use ROI.getSubtraction(ROI) instead.
  - subtract
```
@Deprecated
public static ROI2D subtract(ROI2D roi1,
                        ROI2D roi2)
```
    Deprecated. Use ROI.getSubtraction(ROI) instead.
  - getDefaultName
```
public java.lang.String getDefaultName()
```
    Overrides:
    
    getDefaultName in class ROI
    
    Returns:
    the default name for this ROI class
  - getDimension
```
public final int getDimension()
```
    Description copied from class: ROI
    
    Returns the number of dimension of the ROI:
    2 for ROI2D
    3 for ROI3D
    4 for ROI4D
    5 for ROI5D
    
    Specified by:
    
    getDimension in class ROI
  - getZ
```
public int getZ()
```
    Returns the Z position.
    -1 is a special value meaning the ROI is set on all Z slices (infinite Z dimension).
  - setZ
```
public void setZ(int value)
```
    Sets Z position of this 2D ROI.
    You cannot set the ROI on a negative Z position as -1 is a special value meaning the ROI is set on all Z slices (infinite Z dimension).
  - getT
```
public int getT()
```
    Returns the T position.
    -1 is a special value meaning the ROI is set on all T frames (infinite T dimension).
  - setT
```
public void setT(int value)
```
    Sets T position of this 3D ROI.
    You cannot set the ROI on a negative T position as -1 is a special value meaning the ROI is set on all T frames (infinite T dimension).
  - getC
```
public int getC()
```
    Returns the C position.
    -1 is a special value meaning the ROI is set on all C channels (infinite C dimension).
  - setC
```
public void setC(int value)
```
    Sets C position of this 2D ROI.
    You cannot set the ROI on a negative C position as -1 is a special value meaning the ROI is set on all C channels (infinite C dimension).
  - isActiveFor
```
public boolean isActiveFor(IcyCanvas canvas)
```
    Description copied from class: ROI
    
    Return true if the ROI is active for the specified canvas.
    
    Specified by:
    
    isActiveFor in class ROI
  - isActiveFor
```
public boolean isActiveFor(int z,
                  int t,
                  int c)
```
    Return true if the ROI is active for the specified Z, T, C coordinates
  - isOver
```
@Deprecated
public boolean isOver(IcyCanvas canvas,
                        java.awt.geom.Point2D p)
```
    Deprecated. Use isOverEdge(IcyCanvas, Point2D) instead.
  - isOver
```
@Deprecated
public boolean isOver(IcyCanvas canvas,
                        double x,
                        double y)
```
    Deprecated. Use isOverEdge(IcyCanvas, double, double) instead.
  - isOverEdge
```
public boolean isOverEdge(IcyCanvas canvas,
                 java.awt.geom.Point2D p)
```
    Returns true if specified point coordinates overlap the ROI edge.
    Use contains(Point2D) to test for content overlap instead.
  - isOverEdge
```
public abstract boolean isOverEdge(IcyCanvas canvas,
                 double x,
                 double y)
```
    Returns true if specified point coordinates overlap the ROI edge.
    Use contains(double, double) to test for content overlap instead.
  - isOverEdge
```
public boolean isOverEdge(IcyCanvas canvas,
                 Point5D p)
```
    Returns true if specified point coordinates overlap the ROI edge.
    Use ROI.contains(Point5D) to test for content overlap instead.
  - isOverEdge
```
public boolean isOverEdge(IcyCanvas canvas,
                 double x,
                 double y,
                 double z,
                 double t,
                 double c)
```
    Returns true if specified point coordinates overlap the ROI edge.
    Use contains(double, double, double, double, double) to test for content overlap instead.
  - contains
```
public boolean contains(java.awt.geom.Point2D p)
```
    Tests if a specified Point2D is inside the ROI.
    
    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(java.awt.geom.Rectangle2D r)
```
    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.
    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:
    contains(double, double, double, double)
  - contains
```
public abstract boolean contains(double x,
               double y)
```
    Tests if the specified coordinates are inside the ROI.
    
    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 abstract boolean contains(double x,
               double y,
               double w,
               double h)
```
    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.
    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(double x,
               double y,
               double z,
               double t,
               double c)
```
    Description copied from class: ROI
    
    Tests if a specified 5D point is inside the ROI.
    
    Specified by:
    
    contains in class ROI
    
    Returns:
    true if the specified Point5D is inside the boundary of the ROI; false otherwise.
  - contains
```
public boolean contains(double x,
               double y,
               double z,
               double t,
               double c,
               double sizeX,
               double sizeY,
               double sizeZ,
               double sizeT,
               double sizeC)
```
    Description copied from class: ROI
    Tests if the ROI entirely contains the specified 5D 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 class ROI
    
    Parameters:
    x - the X coordinate of the start corner of the specified rectangular area
    y - the Y coordinate of the start corner of the specified rectangular area
    z - the Z coordinate of the start corner of the specified rectangular area
    t - the T coordinate of the start corner of the specified rectangular area
    c - the C coordinate of the start corner of the specified rectangular area
    sizeX - the X size of the specified rectangular area
    sizeY - the Y size of the specified rectangular area
    sizeZ - the Z size of the specified rectangular area
    sizeT - the T size of the specified rectangular area
    sizeC - the C size 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(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 ROI
    
    Returns:
    true if the current ROI entirely contains the specified ROI; false otherwise.
  - intersects
```
public boolean intersects(java.awt.geom.Rectangle2D r)
```
    Tests if the interior of the ROI intersects the interior of a specified Rectangle2D. The ROI.intersects() method allows a ROI implementation to conservatively return true when:
    - there is a high probability that the Rectangle2D and the ROI intersect, but
    - the calculations to accurately determine this intersection are prohibitively expensive.
    This means that for some ROIs this method might return true even though the Rectangle2D does not intersect the ROI.
    Parameters:
    r - the specified Rectangle2D
    
    Returns:
    true if the interior of the ROI and the interior of the specified Rectangle2D intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.
    See Also:
    intersects(double, double, double, double)
  - intersects
```
public abstract boolean intersects(double x,
                 double y,
                 double w,
                 double h)
```
    Tests if the interior of the ROI intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the ROI if any point is contained in both the interior of the ROI and the specified rectangular area.
    The ROI.intersects() method allows a ROI implementation to conservatively return true when:
    - there is a high probability that the rectangular area and the ROI intersect, but
    - the calculations to accurately determine this intersection are prohibitively expensive.
    This means that for some ROIs this method might return true even though the rectangular area does not intersect the ROI.
    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 and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.
  - intersects
```
public boolean intersects(double x,
                 double y,
                 double z,
                 double t,
                 double c,
                 double sizeX,
                 double sizeY,
                 double sizeZ,
                 double sizeT,
                 double sizeC)
```
    Description copied from class: ROI
    Tests if the interior of the ROI intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the ROI if any point is contained in both the interior of the ROI and the specified rectangular area.
    The ROI.intersects() method allows a ROI implementation to conservatively return true when:
    - there is a high probability that the rectangular area and the ROI intersect, but
    - the calculations to accurately determine this intersection are prohibitively expensive.
    This means that for some ROIs this method might return true even though the rectangular area does not intersect the ROI.
    Specified by:
    
    intersects in class ROI
    
    Returns:
    true if the interior of the ROI and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.
  - intersects
```
public boolean intersects(ROI roi)
```
    Description copied from class: ROI
    
    Tests if the current ROI intersects the specified ROI.
    Note that this method may be "pixel accurate" only depending the internal implementation.
    
    Overrides:
    
    intersects in class ROI
    
    Returns:
    true if ROI intersect, false otherwise.
  - computeBounds2D
```
public abstract java.awt.geom.Rectangle2D computeBounds2D()
```
    Calculate and returns the 2D bounding box of the ROI.
    This method is used by getBounds2D() which should try to cache the result as the bounding box calculation can take some computation time for complex ROI.
  - computeBounds5D
```
public Rectangle5D computeBounds5D()
```
    Description copied from class: ROI
    
    Calculate and returns the bounding box of the ROI.
    This method is used by ROI.getBounds5D() which should try to cache the result as the bounding box calculation can take some computation time for complex ROI.
    
    Specified by:
    
    computeBounds5D in class ROI
  - getBounds
```
public java.awt.Rectangle getBounds()
```
    Returns an integer Rectangle that completely encloses the ROI. Note that there is no guarantee that the returned Rectangle is the smallest bounding box that encloses the ROI, only that the ROI lies entirely within the indicated Rectangle. The returned Rectangle might also fail to completely enclose the ROI if the ROI overflows the limited range of the integer data type. The getBounds2D method generally returns a tighter bounding box due to its greater flexibility in representation.
    
    Returns:
    an integer Rectangle that completely encloses the ROI.
  - getBounds2D
```
public java.awt.geom.Rectangle2D getBounds2D()
```
    Returns a high precision and more accurate bounding box of the ROI than the getBounds method. Note that there is no guarantee that the returned Rectangle2D is the smallest bounding box that encloses the ROI, only that the ROI lies entirely within the indicated Rectangle2D. The bounding box returned by this method is usually tighter than that returned by the getBounds method and never fails due to overflow problems since the return value can be an instance of the Rectangle2D that uses double precision values to store the dimensions.
    
    Returns:
    an instance of Rectangle2D that is a high-precision bounding box of the ROI.
  - getPosition
```
public java.awt.Point getPosition()
```
    Returns the upper left point of the ROI bounds.
    Equivalent to :
    getBounds().getLocation()
    
    See Also:
    getBounds()
  - getPosition2D
```
public java.awt.geom.Point2D getPosition2D()
```
    Returns the ROI position which normally correspond to the minimum point of the ROI bounds:
    new Point2D.Double(getBounds2D().getX(), getBounds2D().getY())
    
    See Also:
    getBounds2D()
  - canSetBounds
```
public boolean canSetBounds()
```
    Description copied from class: ROI
    
    Returns true if this ROI accepts bounds change through the ROI.setBounds5D(Rectangle5D) method.
    
    Specified by:
    
    canSetBounds in class ROI
  - setBounds2D
```
public void setBounds2D(java.awt.geom.Rectangle2D bounds)
```
    Set the ROI 2D bounds.
    Note that not all ROI supports bounds modification and you should call canSetBounds() first to test if the operation is supported.
    
    Parameters:
    bounds - new ROI 2D bounds
  - setBounds5D
```
public void setBounds5D(Rectangle5D bounds)
```
    Description copied from class: ROI
    
    Set the ROI bounds.
    Note that not all ROI supports bounds modification and you should call ROI.canSetBounds() first to test if the operation is supported.
    
    Specified by:
    
    setBounds5D in class ROI
    
    Parameters:
    bounds - new ROI bounds
  - canSetPosition
```
public boolean canSetPosition()
```
    Description copied from class: ROI
    
    Returns true if this ROI accepts position change through the ROI.setPosition5D(Point5D) method.
    
    Specified by:
    
    canSetPosition in class ROI
  - setPosition
```
@Deprecated
public void setPosition(java.awt.geom.Point2D position)
```
    Deprecated. Use setPosition2D(Point2D) instead.
  - setPosition2D
```
public void setPosition2D(java.awt.geom.Point2D position)
```
    Set the ROI 2D position.
    Note that not all ROI supports position modification and you should call canSetPosition() first to test if the operation is supported.
    
    Parameters:
    position - new ROI 2D position
  - setPosition5D
```
public void setPosition5D(Point5D position)
```
    Description copied from class: ROI
    
    Set the ROI position.
    Note that not all ROI supports position modification and you should call ROI.canSetPosition() first to test if the operation is supported.
    
    Specified by:
    
    setPosition5D in class ROI
    
    Parameters:
    position - new ROI position
  - canTranslate
```
public boolean canTranslate()
```
    Returns true if the ROI support translate operation.
    
    See Also:
    translate(double, double)
  - translate
```
public void translate(double dx,
             double dy)
```
    Translate the ROI position by the specified delta X/Y.
    Note that not all ROI support this operation so you should test it by calling canTranslate() first.
    
    Parameters:
    dx - translation value to apply on X dimension
    dy - translation value to apply on Y dimension
    See Also:
    canTranslate(), setPosition2D(Point2D)
  - getBooleanMask2D
```
public boolean[] getBooleanMask2D(int x,
                         int y,
                         int width,
                         int height,
                         int z,
                         int t,
                         int c,
                         boolean inclusive)
```
    Description copied from class: ROI
    
    Returns the boolean array mask for the specified rectangular region at specified C, Z, T position.
    
    If pixel (x1, y1, c, z, t) is contained in the roi:
    result[((y1 - y) * width) + (x1 - x)] = true
    If pixel (x1, y1, c, z, t) is not contained in the roi:
    result[((y1 - y) * width) + (x1 - x)] = false
    
    Overrides:
    
    getBooleanMask2D in class ROI
    
    Parameters:
    x - the X coordinate of the upper-left corner of the specified rectangular region
    y - the Y coordinate of the upper-left corner of the specified rectangular region
    width - the width of the specified rectangular region
    height - the height of the specified rectangular region
    z - Z position we want to retrieve the boolean mask
    t - T position we want to retrieve the boolean mask
    c - C position we want to retrieve the boolean mask
    inclusive - If true then all partially contained (intersected) pixels are included in the mask.
    
    Returns:
    the boolean bitmap mask
  - getBooleanMask
```
public boolean[] getBooleanMask(int x,
                       int y,
                       int width,
                       int height,
                       boolean inclusive)
```
    Get the boolean bitmap mask for the specified rectangular area of the roi.
    if the pixel (x,y) is contained in the roi then result[(y * width) + x] = true
    if the pixel (x,y) is not contained in the roi then result[(y * width) + x] = false
    
    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
    width - the width of the specified rectangular area
    height - the height of the specified rectangular area
    inclusive - If true then all partially contained (intersected) pixels are included in the mask.
    
    Returns:
    the boolean bitmap mask
  - getBooleanMask
```
@Deprecated
public boolean[] getBooleanMask(int x,
                                  int y,
                                  int width,
                                  int height)
```
    Deprecated. Use getBooleanMask(int, int, int, int, boolean) instead
  - getBooleanMask
```
public boolean[] getBooleanMask(java.awt.Rectangle rect,
                       boolean inclusive)
```
    Get the boolean bitmap mask for the specified rectangular area of the roi.
    if the pixel (x,y) is contained in the roi then result[(y * w) + x] = true
    if the pixel (x,y) is not contained in the roi then result[(y * w) + x] = false
    
    Parameters:
    rect - area we want to retrieve the boolean mask
    inclusive - If true then all partially contained (intersected) pixels are included in the mask.
  - getBooleanMask
```
@Deprecated
public boolean[] getBooleanMask(java.awt.Rectangle rect)
```
    Deprecated. Use getBooleanMask(Rectangle, boolean) instead
  - getBooleanMask2D
```
public BooleanMask2D getBooleanMask2D(int z,
                             int t,
                             int c,
                             boolean inclusive)
```
    Description copied from class: ROI
    
    Returns the BooleanMask2D object representing the XY plan content at specified Z, T, C position.
    
    If pixel (x, y, c, z, t) is contained in the roi:
    mask[(y - bounds.y) * bounds.width) + (x - bounds.x)] = true
    If pixel (x, y, c, z, t) is not contained in the roi:
    mask[(y - bounds.y) * bounds.width) + (x - bounds.x)] = false
    
    Overrides:
    
    getBooleanMask2D in class ROI
    
    Parameters:
    z - Z position we want to retrieve the boolean mask.
    Set it to -1 to retrieve the mask whatever is the Z position of ROI2D.
    t - T position we want to retrieve the boolean mask.
    Set it to -1 to retrieve the mask whatever is the T position of ROI2D/ROI3D.
    c - C position we want to retrieve the boolean mask.
    Set it to -1 to retrieve the mask whatever is the C position of ROI2D/ROI3D/ROI4D.
    inclusive - If true then all partially contained (intersected) pixels are included in the mask.
  - getBooleanMask
```
public BooleanMask2D getBooleanMask(boolean inclusive)
```
    Get the BooleanMask2D object representing the roi.
    It contains the rectangle mask bounds and the associated boolean array mask.
    if the pixel (x,y) is contained in the roi then result.mask[(y * w) + x] = true
    if the pixel (x,y) is not contained in the roi then result.mask[(y * w) + x] = false
    
    Parameters:
    inclusive - If true then all partially contained (intersected) pixels are included in the mask.
  - getBooleanMask
```
@Deprecated
public BooleanMask2D getBooleanMask()
```
    Deprecated. Use getBooleanMask(boolean) instead.
  - getAsBooleanMask
```
@Deprecated
public BooleanMask2D getAsBooleanMask(boolean inclusive)
```
    Deprecated. Use getBooleanMask(boolean) instead.
  - getAsBooleanMask
```
@Deprecated
public boolean[] getAsBooleanMask(java.awt.Rectangle rect,
                                    boolean inclusive)
```
    Deprecated. Use getBooleanMask(Rectangle, boolean) instead.
  - getAsBooleanMask
```
@Deprecated
public boolean[] getAsBooleanMask(int x,
                                    int y,
                                    int w,
                                    int h,
                                    boolean inclusive)
```
    Deprecated. Use getBooleanMask(int, int, int, int, boolean) instead.
  - getAsBooleanMask
```
@Deprecated
public BooleanMask2D getAsBooleanMask()
```
    Deprecated. Use getBooleanMask(boolean) instead.
  - getAsBooleanMask
```
@Deprecated
public boolean[] getAsBooleanMask(java.awt.Rectangle rect)
```
    Deprecated. Use getBooleanMask(boolean) instead.
  - getAsBooleanMask
```
@Deprecated
public boolean[] getAsBooleanMask(int x,
                                    int y,
                                    int w,
                                    int h)
```
    Deprecated. Use getBooleanMask(boolean) instead.
  - computeNumberOfContourPoints
```
public double computeNumberOfContourPoints()
```
    Description copied from class: ROI
    
    Compute and returns the number of point (pixel) composing the ROI contour.
    
    Specified by:
    
    computeNumberOfContourPoints in class ROI
  - computeNumberOfPoints
```
public double computeNumberOfPoints()
```
    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.
    
    Specified by:
    
    computeNumberOfPoints in class ROI
  - computePerimeter
```
@Deprecated
public double computePerimeter(Sequence sequence)
```
    Deprecated. Perimeter computation cannot be cached so directly use #getLength(Sequence) instead.
  - getPerimeter
```
@Deprecated
public double getPerimeter(Sequence sequence)
                    throws java.lang.UnsupportedOperationException
```
    Deprecated. Use ROI.getLength(Sequence) instead
    
    Throws:
    
    java.lang.UnsupportedOperationException
  - getPerimeter
```
@Deprecated
public double getPerimeter()
```
    Deprecated. Use ROI.getNumberOfContourPoints() instead.
    
    Return perimeter of the 2D ROI in pixels.
    This is basically the number of pixel representing ROI contour.
    
    Overrides:
    
    getPerimeter in class ROI
    
    See Also:
    ROI.getNumberOfContourPoints(), computeNumberOfContourPoints()
  - getArea
```
@Deprecated
public double getArea()
```
    Deprecated. Use ROI.getNumberOfPoints() instead.
    
    Return area of the 2D ROI in pixels.
    This is basically the number of pixel contained in the ROI.
    
    See Also:
    ROI.getNumberOfPoints(), computeNumberOfPoints()
  - getSubROI
```
public ROI getSubROI(int z,
            int t,
            int c)
```
    Returns a sub part of the ROI.
    null can be returned if result is empty.
    
    Overrides:
    
    getSubROI in class ROI
    
    Parameters:
    z - the specific Z position (slice) we want to retrieve (-1 to retrieve the whole ROI Z dimension)
    t - the specific T position (frame) we want to retrieve (-1 to retrieve the whole ROI T dimension)
    c - the specific C position (channel) we want to retrieve (-1 to retrieve the whole ROI C dimension)
  - 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 ROI
  - 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 ROI

Class ROI2D

Nested Class Summary

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

Field Summary

Fields inherited from class icy.roi.ROI

Constructor Summary

Method Summary

Methods inherited from class icy.roi.ROI

Methods inherited from class java.lang.Object

Field Detail

ID_Z

ID_T

ID_C

Constructor Detail

ROI2D

Method Detail

getROI2DList

getROI2DList

getROI2DList

merge

substract

subtract

getDefaultName

getDimension

getZ

setZ

getT

setT

getC

setC

isActiveFor

isActiveFor

isOver

isOver

isOverEdge

isOverEdge

isOverEdge

isOverEdge

contains

contains

contains

contains

contains

contains

contains

intersects

intersects

intersects

intersects

computeBounds2D

computeBounds5D

getBounds

getBounds2D

getPosition

getPosition2D

canSetBounds

setBounds2D

setBounds5D

canSetPosition

setPosition

setPosition2D

setPosition5D

canTranslate

translate

getBooleanMask2D

getBooleanMask

getBooleanMask

getBooleanMask

getBooleanMask

getBooleanMask2D

getBooleanMask

getBooleanMask

getAsBooleanMask

getAsBooleanMask

getAsBooleanMask

getAsBooleanMask

getAsBooleanMask

getAsBooleanMask

computeNumberOfContourPoints

computeNumberOfPoints