plugins.kernel.roi.roi2d

Class ROI2DArea

java.lang.Object

icy.roi.ROI

icy.roi.ROI2D

plugins.kernel.roi.roi2d.ROI2DArea

All Implemented Interfaces:

ChangeListener, XMLPersistent

Direct Known Subclasses:

ROI2DArea

public class ROI2DArea
extends ROI2D

ROI Area type.
Use a bitmap mask internally for fast boolean mask operation.

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ROI2DArea.ROI2DAreaPainter

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_BOOLMASK_DATA
static java.lang.String	ID_BOUNDS_H
static java.lang.String	ID_BOUNDS_W
static java.lang.String	ID_BOUNDS_X
static java.lang.String	ID_BOUNDS_Y

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
ROI2DArea() Create a ROI2D Area type from the specified BooleanMask2D.
ROI2DArea(BooleanMask2D mask) Create a ROI2D Area type from the specified BooleanMask2D.
ROI2DArea(java.awt.geom.Point2D position) Create a ROI2D Area type with a single point.
ROI2DArea(java.awt.geom.Point2D position, boolean cm) Deprecated. Use ROI2DArea(Point5D) instead
ROI2DArea(Point5D position) Generic constructor for interactive mode.
ROI2DArea(ROI2DArea area) Create a copy of the specified 2D Area ROI

Method Summary

Methods

Modifier and Type	Method and Description
void	add(BooleanMask2D mask) Add the specified BooleanMask2D content to this ROI2DArea
void	add(ROI2DArea roi) Add the specified ROI2DArea content to this ROI2DArea
ROI	add(ROI roi, boolean allowCreate) Adds content of specified ROI into this ROI.
void	addBrush(java.awt.geom.Point2D pos) Add brush point at specified position.
void	addPoint(int x, int y) Add a point to the mask
void	addPoint(java.awt.Point pos) Add a point to the mask
boolean	addPointAt(java.awt.geom.Point2D pos, boolean ctrl) Deprecated. Use addBrush(Point2D) instead.
void	addRect(int x, int y, int w, int h) Add a rectangle to the mask
void	addRect(java.awt.Rectangle r) Add a rectangle to the mask
void	addShape(java.awt.Shape s) Add a shape to the mask
boolean	canAddPoint() Deprecated. useless method.
boolean	canRemovePoint() Deprecated. useless 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.
void	clear() Clear the mask
java.awt.geom.Rectangle2D	computeBounds2D() Calculate and returns the 2D bounding box of the ROI.
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.
void	downscale() Fast 2x down scaling (each 2x2 block points become 1 point).
void	downscale(int nbPointForTrue) Fast 2x down scaling (each 2x2 block points become 1 point).
void	exclusiveAdd(BooleanMask2D mask) Exclusively add the specified BooleanMask2D content to this ROI2DArea: mask1 xor mask2 = result ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
void	exclusiveAdd(ROI2DArea roi) Exclusively add the specified ROI2DArea content to this ROI2DArea: mask1 xor mask2 = result ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
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.
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.awt.geom.Rectangle2D	getBounds2D() Returns a high precision and more accurate bounding box of the ROI than the getBounds method.
boolean	getBoundsNeedUpdate() Return true if bounds need to be updated by calling optimizeBounds() method.
java.lang.String	getDefaultName()
java.awt.image.BufferedImage	getImageMask() Returns the internal image mask.
java.awt.Color	getMaskColor() Deprecated. Use ROI.getDisplayColor() instead.
ROI2DArea.ROI2DAreaPainter	getOverlay() Returns the ROI overlay (used to draw and interact with ROI on IcyCanvas)
ROI2DArea.ROI2DAreaPainter	getPainter() Deprecated.
boolean	hasSelectedPoint() Returns true if the ROI has a (control) point which is currently focused/selected
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	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	isEmpty() Returns true if the ROI is empty (the mask does not contains any point).
boolean	isOverEdge(IcyCanvas canvas, double x, double y) Returns true if specified point coordinates overlap the ROI edge.
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
void	onChanged(CollapsibleEvent object) fire changed event
boolean	optimizeBounds() Optimize the bounds size to the minimum surface which still include all mask You should call it after consecutive remove operations.
void	optimizeBounds(boolean removeIfEmpty) Deprecated. Use optimizeBounds() instead.
void	remove(BooleanMask2D mask) Deprecated. Use subtract(BooleanMask2D) instead
void	remove(ROI2DArea roi) Deprecated. Use subtract(ROI2DArea) instead
void	removeBrush(java.awt.geom.Point2D pos) Remove brush point from the mask at specified position.
void	removePoint(int x, int y) Remove a point to the mask.
void	removePoint(java.awt.Point pos) Remove a point from the mask.
boolean	removePointAt(IcyCanvas canvas, java.awt.geom.Point2D pos) Deprecated. Use removeBrush(Point2D) instead.
void	removeRect(int x, int y, int w, int h) Remove a rectangle from the mask.
void	removeRect(java.awt.Rectangle r) Remove a rectangle from the mask.
void	removeShape(java.awt.Shape s) Remove a shape to the mask.
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setAsBooleanMask(BooleanMask2D mask) Set the mask from a BooleanMask2D object.
void	setAsBooleanMask(int x, int y, int w, int h, boolean[] booleanMask)
void	setAsBooleanMask(java.awt.Rectangle r, boolean[] booleanMask) Set the mask from a boolean array.
void	setPoint(int x, int y, boolean value) Set the value of the specified point.
void	setPosition2D(java.awt.geom.Point2D newPosition) Set the ROI 2D position.
void	subtract(BooleanMask2D mask) Subtract the specified BooleanMask2D from this ROI2DArea
void	subtract(ROI2DArea roi) Subtract the specified ROI2DArea from this ROI2DArea
ROI	subtract(ROI roi, boolean allowCreate) Subtract the specified ROI content from current ROI.
void	translate(double dx, double dy) Translate the ROI position by the specified delta X/Y.
void	updateMask(int x, int y, boolean remove) Deprecated. Use setPoint(int, int, boolean) instead.
void	updateMask(java.awt.Shape shape, boolean remove) Update mask from specified shape
void	updateMask(java.awt.Shape shape, boolean remove, boolean inclusive, boolean accurate, boolean immediateUpdate) Update mask by adding/removing the specified shape to/from it.
void	upscale() Fast up scaling by a factor of 2 (each point become a 2x2 block points)

Methods inherited from class icy.roi.ROI2D

canSetBounds, computeBounds5D, computeNumberOfContourPoints, computePerimeter, contains, contains, contains, contains, contains, getArea, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getAsBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask, getBooleanMask2D, getBooleanMask2D, getBounds, getC, getDimension, getPerimeter, getPerimeter, getPosition, getPosition2D, getROI2DList, getROI2DList, getROI2DList, getSubROI, getT, getZ, intersects, intersects, intersects, isActiveFor, isActiveFor, isOver, isOver, isOverEdge, isOverEdge, isOverEdge, merge, setBounds2D, setBounds5D, setC, setPosition, 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, getExclusiveUnion, getFirstSequence, getFocusedColor, getGroupId, getIcon, getId, getIntersection, getLength, getName, getNameSuffix, getNumberOfContourPoints, getNumberOfPoints, getOpacity, getPosition5D, getProperties, getProperty, getPropertyValue, getROICount, getROIList, getROIList, getROIList, getROIsFromXML, getSelectedColor, getSequences, getShowName, getSimpleClassName, getStroke, getSubtraction, getUnion, getVolume, internalFocus, internalSelect, internalUnfocus, internalUnselect, intersects, isAttached, isCreating, isDefaultName, isEditable, 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, unselectAllPoints

Methods inherited from class java.lang.Object

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

Field Detail

ID_BOUNDS_X

public static final java.lang.String ID_BOUNDS_X

See Also:

Constant Field Values

ID_BOUNDS_Y

public static final java.lang.String ID_BOUNDS_Y

See Also:

Constant Field Values

ID_BOUNDS_W

public static final java.lang.String ID_BOUNDS_W

See Also:

Constant Field Values

ID_BOUNDS_H

public static final java.lang.String ID_BOUNDS_H

See Also:

Constant Field Values

ID_BOOLMASK_DATA

public static final java.lang.String ID_BOOLMASK_DATA

See Also:

Constant Field Values

Constructor Detail

ROI2DArea

public ROI2DArea()

Create a ROI2D Area type from the specified BooleanMask2D.

ROI2DArea

@Deprecated
public ROI2DArea(java.awt.geom.Point2D position,
                    boolean cm)

Deprecated. Use ROI2DArea(Point5D) instead

ROI2DArea

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

Create a ROI2D Area type with a single point.

ROI2DArea

public ROI2DArea(Point5D position)

Generic constructor for interactive mode.

ROI2DArea

public ROI2DArea(BooleanMask2D mask)

Create a ROI2D Area type from the specified BooleanMask2D.

ROI2DArea

public ROI2DArea(ROI2DArea area)

Create a copy of the specified 2D Area ROI

Method Detail

getDefaultName

public java.lang.String getDefaultName()

Overrides:

getDefaultName in class ROI2D

Returns:

the default name for this ROI class

optimizeBounds

@Deprecated
public void optimizeBounds(boolean removeIfEmpty)

Deprecated. Use optimizeBounds() instead.

isEmpty

public boolean isEmpty()

Returns true if the ROI is empty (the mask does not contains any point).

Overrides:

isEmpty in class ROI

optimizeBounds

public boolean optimizeBounds()

Optimize the bounds size to the minimum surface which still include all mask
You should call it after consecutive remove operations.

getMaskColor

@Deprecated
public java.awt.Color getMaskColor()

Deprecated. Use ROI.getDisplayColor() instead.

getImageMask

public java.awt.image.BufferedImage getImageMask()

Returns the internal image mask.

setPoint

public void setPoint(int x,
            int y,
            boolean value)

Set the value of the specified point.
Don't forget to call optimizeBounds() after consecutive remove operation to refresh the mask bounds.

updateMask

@Deprecated
public void updateMask(int x,
                         int y,
                         boolean remove)

Deprecated. Use setPoint(int, int, boolean) instead.

add

public void add(ROI2DArea roi)

Add the specified ROI2DArea content to this ROI2DArea

add

public void add(BooleanMask2D mask)

Add the specified BooleanMask2D content to this ROI2DArea

exclusiveAdd

public void exclusiveAdd(ROI2DArea roi)

Exclusively add the specified ROI2DArea content to this ROI2DArea:

          mask1       xor      mask2        =       result
 
     ################     ################
     ##############         ##############     ##            ##
     ############             ############     ####        ####
     ##########                 ##########     ######    ######
     ########                     ########     ################
     ######                         ######     ######    ######
     ####                             ####     ####        ####
     ##                                 ##     ##            ##
 

exclusiveAdd

public void exclusiveAdd(BooleanMask2D mask)

Exclusively add the specified BooleanMask2D content to this ROI2DArea:

          mask1       xor      mask2        =       result
 
     ################     ################
     ##############         ##############     ##            ##
     ############             ############     ####        ####
     ##########                 ##########     ######    ######
     ########                     ########     ################
     ######                         ######     ######    ######
     ####                             ####     ####        ####
     ##                                 ##     ##            ##
 

subtract

public void subtract(ROI2DArea roi)

Subtract the specified ROI2DArea from this ROI2DArea

subtract

public void subtract(BooleanMask2D mask)

Subtract the specified BooleanMask2D from this ROI2DArea

remove

@Deprecated
public void remove(ROI2DArea roi)

Deprecated. Use subtract(ROI2DArea) instead

remove

@Deprecated
public void remove(BooleanMask2D mask)

Deprecated. Use subtract(BooleanMask2D) instead

updateMask

public void updateMask(java.awt.Shape shape,
              boolean remove,
              boolean inclusive,
              boolean accurate,
              boolean immediateUpdate)

Update mask by adding/removing the specified shape to/from it.

Parameters:

shape - the shape to add in or remove from the mask

remove - if set to true the shape will be removed from the mask

inclusive - if we should also consider the edge of the shape to update the mask

accurate - if set to true the operation will be done to be as pixel accurate as possible

immediateUpdate - if set to true the bounds of the mask will be immediately recomputed (only meaningful for a remove operation)

updateMask

public void updateMask(java.awt.Shape shape,
              boolean remove)

Update mask from specified shape

getPainter

@Deprecated
public ROI2DArea.ROI2DAreaPainter getPainter()

Deprecated.

Overrides:

getPainter in class ROI

getOverlay

public ROI2DArea.ROI2DAreaPainter getOverlay()

Description copied from class: ROI

Returns the ROI overlay (used to draw and interact with ROI on IcyCanvas)

Overrides:

getOverlay in class ROI

hasSelectedPoint

public boolean hasSelectedPoint()

Description copied from class: ROI

Returns true if the ROI has a (control) point which is currently focused/selected

Specified by:

hasSelectedPoint in class ROI

canAddPoint

@Deprecated
public boolean canAddPoint()

Deprecated. useless method.

canRemovePoint

@Deprecated
public boolean canRemovePoint()

Deprecated. useless method.

addPointAt

@Deprecated
public boolean addPointAt(java.awt.geom.Point2D pos,
                            boolean ctrl)

Deprecated. Use addBrush(Point2D) instead.

removePointAt

@Deprecated
public boolean removePointAt(IcyCanvas canvas,
                               java.awt.geom.Point2D pos)

Deprecated. Use removeBrush(Point2D) instead.

addBrush

public void addBrush(java.awt.geom.Point2D pos)

Add brush point at specified position.

removeBrush

public void removeBrush(java.awt.geom.Point2D pos)

Remove brush point from the mask at specified position.
Don't forget to call optimizeBounds() after consecutive remove operation to refresh the mask bounds.

addPoint

public void addPoint(java.awt.Point pos)

Add a point to the mask

addPoint

public void addPoint(int x,
            int y)

Add a point to the mask

removePoint

public void removePoint(java.awt.Point pos)

Remove a point from the mask.
Don't forget to call optimizeBounds() after consecutive remove operation to refresh the mask bounds.

removePoint

public void removePoint(int x,
               int y)

Remove a point to the mask.
Don't forget to call optimizeBounds() after consecutive remove operation to refresh the mask bounds.

addRect

public void addRect(java.awt.Rectangle r)

Add a rectangle to the mask

addRect

public void addRect(int x,
           int y,
           int w,
           int h)

Add a rectangle to the mask

removeRect

public void removeRect(java.awt.Rectangle r)

Remove a rectangle from the mask.
Don't forget to call optimizeBounds() after consecutive remove operation
to refresh the mask bounds.

removeRect

public void removeRect(int x,
              int y,
              int w,
              int h)

Remove a rectangle from the mask.
Don't forget to call optimizeBounds() after consecutive remove operation
to refresh the mask bounds.

addShape

public void addShape(java.awt.Shape s)

Add a shape to the mask

removeShape

public void removeShape(java.awt.Shape s)

Remove a shape to the mask.
Don't forget to call optimizeBounds() after consecutive remove operation
to refresh the mask bounds.

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)

getBoundsNeedUpdate

public boolean getBoundsNeedUpdate()

Return true if bounds need to be updated by calling optimizeBounds() method.

clear

public void clear()

Clear the mask

isOverEdge

public boolean isOverEdge(IcyCanvas canvas,
                 double x,
                 double y)

Description copied from class: ROI2D

Returns true if specified point coordinates overlap the ROI edge.
Use ROI2D.contains(double, double) to test for content overlap instead.

Specified by:

isOverEdge in class ROI2D

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 class ROI2D

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(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 class ROI2D

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.

computeBounds2D

public java.awt.geom.Rectangle2D computeBounds2D()

Description copied from class: ROI2D

Calculate and returns the 2D bounding box of the ROI.
This method is used by ROI2D.getBounds2D() which should try to cache the result as the bounding box calculation can take some computation time for complex ROI.

Specified by:

computeBounds2D in class ROI2D

getBounds2D

public java.awt.geom.Rectangle2D getBounds2D()

Description copied from class: ROI2D

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.

Overrides:

getBounds2D in class ROI2D

Returns:

an instance of Rectangle2D that is a high-precision bounding box of the ROI.

intersects

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

Description copied from class: ROI2D

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 ROI2D

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.

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 ROI2D

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

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

canTranslate

public boolean canTranslate()

Description copied from class: ROI2D

Returns true if the ROI support translate operation.

Overrides:

canTranslate in class ROI2D

See Also:

ROI2D.translate(double, double)

translate

public void translate(double dx,
             double dy)

Description copied from class: ROI2D

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 ROI2D.canTranslate() first.

Overrides:

translate in class ROI2D

Parameters:

dx - translation value to apply on X dimension

dy - translation value to apply on Y dimension

See Also:

ROI2D.canTranslate(), ROI2D.setPosition2D(Point2D)

canSetPosition

public boolean canSetPosition()

Description copied from class: ROI

Returns true if this ROI accepts position change through the ROI.setPosition5D(Point5D) method.

Overrides:

canSetPosition in class ROI2D

setPosition2D

public void setPosition2D(java.awt.geom.Point2D newPosition)

Description copied from class: ROI2D

Set the ROI 2D position.
Note that not all ROI supports position modification and you should call ROI2D.canSetPosition() first to test if the operation is supported.

Overrides:

setPosition2D in class ROI2D

Parameters:

newPosition - new ROI 2D position

setAsBooleanMask

public void setAsBooleanMask(BooleanMask2D mask)

Set the mask from a BooleanMask2D object.
If specified mask is null then ROI is cleared.

setAsBooleanMask

public void setAsBooleanMask(java.awt.Rectangle r,
                    boolean[] booleanMask)

Set the mask from a boolean array.
r represents the region defined by the boolean array.

Parameters:

r -

booleanMask -

setAsBooleanMask

public void setAsBooleanMask(int x,
                    int y,
                    int w,
                    int h,
                    boolean[] booleanMask)

upscale

public void upscale()

Fast up scaling by a factor of 2 (each point become a 2x2 block points)

downscale

public void downscale(int nbPointForTrue)

Fast 2x down scaling (each 2x2 block points become 1 point).

Parameters:

nbPointForTrue - the minimum number of truepoints from a 2x2 block to give a true resulting point.
Accepted value: 1 to 4

downscale

public void downscale()

Fast 2x down scaling (each 2x2 block points become 1 point).

onChanged

public void onChanged(CollapsibleEvent object)

Description copied from interface: ChangeListener

fire changed event

Specified by:

onChanged in interface ChangeListener

Overrides:

onChanged in class 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 ROI2D

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