plugins.kernel.roi.roi2d

Class ROI2DPolyLine

java.lang.Object

icy.roi.ROI

icy.roi.ROI2D

plugins.kernel.roi.roi2d.ROI2DShape

plugins.kernel.roi.roi2d.ROI2DPolyLine

All Implemented Interfaces:

ChangeListener, XMLPersistent, java.awt.Shape

Direct Known Subclasses:

ROI2DPolyLine

public class ROI2DPolyLine
extends ROI2DShape

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

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
ROI2DPolyLine()
ROI2DPolyLine(java.util.List<java.awt.geom.Point2D> points)
ROI2DPolyLine(java.awt.geom.Point2D pt)
ROI2DPolyLine(java.awt.geom.Point2D pt, boolean cm) Deprecated.
ROI2DPolyLine(Point5D pt) Generic constructor for interactive mode
ROI2DPolyLine(java.awt.Polygon polygon)
ROI2DPolyLine(Polyline2D polyline)

Method Summary

Methods

Modifier and Type	Method and Description
double	computeNumberOfPoints() Generic implementation for ROI2D using the BooleanMask object so the result is just an approximation.
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.
boolean[]	getBooleanMask(int x, int y, int w, int h, boolean inclusive) Get the boolean bitmap mask for the specified rectangular area of the roi.
java.lang.String	getDefaultName()
java.awt.Polygon	getPolygon()
Polyline2D	getPolyline2D()
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setPoints(java.util.ArrayList<java.awt.geom.Point2D> pts) Deprecated. Use setPoints(List) instead.
void	setPoints(java.util.List<java.awt.geom.Point2D> pts)
void	setPolygon(java.awt.Polygon polygon)
void	setPolyline2D(Polyline2D polyline2D)

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

addNewPoint, addNewPoint, addPoint, addPoint, addPointAt, canAddPoint, canRemovePoint, canTranslate, computeBounds2D, computeNumberOfContourPoints, controlPointOverlayChanged, controlPointPositionChanged, 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, 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

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

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

Constructor Detail

ROI2DPolyLine

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

Deprecated.

ROI2DPolyLine

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

ROI2DPolyLine

public ROI2DPolyLine(Point5D pt)

Generic constructor for interactive mode

ROI2DPolyLine

public ROI2DPolyLine(java.awt.Polygon polygon)

ROI2DPolyLine

public ROI2DPolyLine(Polyline2D polyline)

ROI2DPolyLine

public ROI2DPolyLine(java.util.List<java.awt.geom.Point2D> points)

ROI2DPolyLine

public ROI2DPolyLine()

Method Detail

getDefaultName

public java.lang.String getDefaultName()

Overrides:

getDefaultName in class ROI2DShape

Returns:

the default name for this ROI class

setPoints

public void setPoints(java.util.List<java.awt.geom.Point2D> pts)

setPoints

@Deprecated
public void setPoints(java.util.ArrayList<java.awt.geom.Point2D> pts)

Deprecated. Use setPoints(List) instead.

getPolyline2D

public Polyline2D getPolyline2D()

setPolyline2D

public void setPolyline2D(Polyline2D polyline2D)

getPolygon

public java.awt.Polygon getPolygon()

setPolygon

public void setPolygon(java.awt.Polygon polygon)

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.

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

getBooleanMask

public boolean[] getBooleanMask(int x,
                       int y,
                       int w,
                       int h,
                       boolean inclusive)

Description copied from class: ROI2D

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

Overrides:

getBooleanMask 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

inclusive - If true then all partially contained (intersected) pixels are included in the mask.

Returns:

the boolean bitmap mask

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