icy.roi

Class BooleanMask2D

java.lang.Object

icy.roi.BooleanMask2D

All Implemented Interfaces:

java.lang.Cloneable

public class BooleanMask2D
extends java.lang.Object
implements java.lang.Cloneable

Class to define a 2D boolean mask region and make basic boolean operation between masks.
The bounds property of this object represents the region defined by the boolean mask.

Author:

Stephane

Field Summary

Fields

Modifier and Type	Field and Description
java.awt.Rectangle	bounds Region represented by the mask.
boolean[]	mask Boolean mask array.

Constructor Summary

Constructors

Constructor and Description
BooleanMask2D() Create an empty BooleanMask2D
BooleanMask2D(int[] points) Build a new boolean mask from the specified array of integer representing points.
BooleanMask2D(java.awt.Point[] points) Build a new boolean mask from the specified array of Point.
BooleanMask2D(java.awt.Rectangle bounds, boolean[] mask)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(BooleanMask2D booleanMask) Add the specified mask into the current mask (bounds can be enlarged): current mask + mask = result ################ ################ ################ ############## ############## ################ ############ ############ ################ ########## ########## ################ ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
void	add(java.awt.Rectangle boundsToAdd, boolean[] maskToAdd) Add the specified mask into the current mask (bounds can be enlarged): current mask + mask = result ################ ################ ################ ############## ############## ################ ############ ############ ################ ########## ########## ################ ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
java.lang.Object	clone()
boolean	contains(BooleanMask2D booleanMask) Return true if mask contains the specified 2D mask.
boolean	contains(int x, int y) Return true if mask contains the specified point
boolean	contains(java.awt.Rectangle rect, boolean[] bmask) Return true if mask contains the specified 2D mask.
BooleanMask2D	downscale() Fast 2x down scaling (each 2x2 block points become 1 point).
static BooleanMask2D	downscale(BooleanMask2D mask) Fast 2x down scaling (each 2x2 block points become 1 point).
static BooleanMask2D	downscale(BooleanMask2D mask, int nbPointForTrue) Fast 2x down scaling (each 2x2 block points become 1 point).
BooleanMask2D	downscale(int nbPointForTrue) Fast 2x down scaling (each 2x2 block points become 1 point).
void	exclusiveAdd(BooleanMask2D booleanMask) Exclusively add the specified mask into the current mask (bounds can change): mask1 xor mask2 = result ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
void	exclusiveAdd(java.awt.Rectangle boundsToXAdd, boolean[] maskToXAdd) Exclusively add the specified mask into the current mask (bounds can change): mask1 xor mask2 = result ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
void	exclusiveUnion(BooleanMask2D booleanMask) Deprecated. Use getExclusiveUnion(BooleanMask2D) instead.
void	exclusiveUnion(java.awt.Rectangle bounds, boolean[] mask) Deprecated. Use getExclusiveUnion(Rectangle, boolean[]) instead.
BooleanMask2D[]	getComponents() Return an array of boolean mask representing each independent component of the current mask.
java.awt.Point[][]	getComponentsPoints(boolean sorted) Compute and return a 2D array of Point representing points of each component of the current mask.
int[][]	getComponentsPointsAsIntArray() Compute and return a 2D array of integer representing points of each component of the current mask.
java.util.List<java.awt.Point>	getConnectedContourPoints() Returns a list of Point representing the contour points of the mask in connected order.
double	getContourLength() Computes and returns the length of the contour.
java.awt.Point[]	getContourPoints() Returns an array of Point containing the contour points of the mask.
static java.util.List<java.awt.Point>	getContourPoints(java.awt.Rectangle bounds, boolean[] mask) Return a list of Point representing the contour points of the mask.
int[]	getContourPointsAsIntArray() Returns an array of integer containing the contour points of the mask.
static byte[]	getDownscaleValues(BooleanMask2D mask) Fast 2x down scaling (each 2x2 block points become 1 point value).
java.awt.Point[]	getEdgePoints() Deprecated. Use getContourPoints() instead.
BooleanMask2D	getExclusiveUnion(BooleanMask2D booleanMask) Compute exclusive union operation with specified mask and return result in a new mask.
static BooleanMask2D	getExclusiveUnion(BooleanMask2D mask1, BooleanMask2D mask2) Build resulting mask from exclusive union of the mask1 and mask2.
static BooleanMask2D	getExclusiveUnion(java.util.List<BooleanMask2D> masks) Build global boolean mask from exclusive union of all specified mask
BooleanMask2D	getExclusiveUnion(java.awt.Rectangle bounds, boolean[] mask) Compute exclusive union operation with specified mask and return result in a new mask
static BooleanMask2D	getExclusiveUnion(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Build resulting mask from exclusive union of the mask1 and mask2: mask1 xor mask2 = result ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
static BooleanMask2D	getExclusiveUnionBooleanMask(java.util.ArrayList<ROI2D> rois) Deprecated. Use ROIUtil.getExclusiveUnion(List) instead.
static BooleanMask2D	getExclusiveUnionBooleanMask(BooleanMask2D mask1, BooleanMask2D mask2) Deprecated. Use getExclusiveUnion(BooleanMask2D, BooleanMask2D) instead.
static BooleanMask2D	getExclusiveUnionBooleanMask(java.util.List<BooleanMask2D> masks) Deprecated. Use getExclusiveUnion(List) instead.
static BooleanMask2D	getExclusiveUnionBooleanMask(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Deprecated. Use getExclusiveUnion(Rectangle, boolean[], Rectangle, boolean[]) instead.
static BooleanMask2D	getExclusiveUnionBooleanMask(ROI2D[] rois) Deprecated. Use ROIUtil.getExclusiveUnion(List) instead.
BooleanMask2D	getIntersect(BooleanMask2D booleanMask) Deprecated. Use getIntersection(BooleanMask2D) instead.
BooleanMask2D	getIntersect(java.awt.Rectangle bounds, boolean[] mask) Deprecated. Use getIntersection(Rectangle, boolean[]) instead.
static BooleanMask2D	getIntersectBooleanMask(java.util.ArrayList<ROI2D> rois) Deprecated. Use ROIUtil.getIntersection(List) instead.
static BooleanMask2D	getIntersectBooleanMask(BooleanMask2D mask1, BooleanMask2D mask2) Deprecated. Use getIntersectionBooleanMask(BooleanMask2D, BooleanMask2D) instead.
static BooleanMask2D	getIntersectBooleanMask(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Deprecated. Use getIntersectionBooleanMask(Rectangle, boolean[], Rectangle, boolean[]) instead.
static BooleanMask2D	getIntersectBooleanMask(ROI2D[] rois) Deprecated. Use ROIUtil.getIntersection(List) instead.
BooleanMask2D	getIntersection(BooleanMask2D booleanMask) Compute intersection with specified mask and return result in a new mask.
static BooleanMask2D	getIntersection(BooleanMask2D mask1, BooleanMask2D mask2) Build resulting mask from intersection of the mask1 and mask2.
static BooleanMask2D	getIntersection(java.util.List<BooleanMask2D> masks) Build global boolean mask from intersection of all specified mask
BooleanMask2D	getIntersection(java.awt.Rectangle bounds, boolean[] mask) Compute intersection with specified mask and return result in a new mask.
static BooleanMask2D	getIntersection(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Build resulting mask from intersection of the mask1 and mask2: mask1 intersect mask2 = result ################ ################ ################ ############## ############## ############ ############ ############ ######## ########## ########## #### ######## ######## ###### ###### #### #### ## ##
static BooleanMask2D	getIntersectionBooleanMask(BooleanMask2D mask1, BooleanMask2D mask2) Deprecated. Use getIntersection(BooleanMask2D, BooleanMask2D) instead.
static BooleanMask2D	getIntersectionBooleanMask(java.util.List<BooleanMask2D> masks) Deprecated. Use getIntersection(List) instead.
static BooleanMask2D	getIntersectionBooleanMask(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Deprecated. Use getIntersection(Rectangle, boolean[], Rectangle, boolean[]) instead.
int	getNumberOfPoints() Return the number of points contained in this boolean mask.
java.awt.Rectangle	getOptimizedBounds() Get the smallest bounds which fit mask content.
java.awt.Point[]	getPoints() Return an array of Point representing all points of the current mask.
int[]	getPointsAsIntArray() Return an array of integer representing all points of the current mask.
BooleanMask2D	getSubtraction(BooleanMask2D mask) Subtract the specified mask from current and return result in a new mask.
static BooleanMask2D	getSubtraction(BooleanMask2D mask1, BooleanMask2D mask2) Build resulting mask from the subtraction of mask2 from mask1.
BooleanMask2D	getSubtraction(java.awt.Rectangle bounds, boolean[] mask) Subtract the specified mask from current and return result in a new mask.
static BooleanMask2D	getSubtraction(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Build resulting mask from the subtraction of mask2 from mask1: mask1 - mask2 = result ################ ################ ############## ############## ## ############ ############ #### ########## ########## ###### ######## ######## ######## ###### ###### ###### #### #### #### ## ## ##
BooleanMask2D	getUnion(BooleanMask2D booleanMask) Compute union with specified mask and return result in a new mask.
static BooleanMask2D	getUnion(BooleanMask2D mask1, BooleanMask2D mask2) Build resulting mask from union of the mask1 and mask2.
static BooleanMask2D	getUnion(java.util.List<BooleanMask2D> masks) Build global boolean mask from union of all specified mask
BooleanMask2D	getUnion(java.awt.Rectangle bounds, boolean[] mask) Compute union with specified mask and return result in a new mask.
static BooleanMask2D	getUnion(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Build resulting mask from union of the mask1 and mask2: mask1 + mask2 = result ################ ################ ################ ############## ############## ################ ############ ############ ################ ########## ########## ################ ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
static BooleanMask2D	getUnionBooleanMask(java.util.ArrayList<ROI2D> rois) Deprecated. Use ROIUtil.getUnion(List) instead.
static BooleanMask2D	getUnionBooleanMask(BooleanMask2D mask1, BooleanMask2D mask2) Deprecated. Use getUnion(BooleanMask2D, BooleanMask2D) instead.
static BooleanMask2D	getUnionBooleanMask(java.util.List<BooleanMask2D> masks) Deprecated. Use getUnion(List) instead.
static BooleanMask2D	getUnionBooleanMask(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Deprecated. Use getUnion(Rectangle, boolean[], Rectangle, boolean[]) instead.
static BooleanMask2D	getUnionBooleanMask(ROI2D[] rois) Deprecated. Use ROIUtil.getUnion(List) instead.
BooleanMask2D	getXor(BooleanMask2D booleanMask) Deprecated. Use getExclusiveUnion(BooleanMask2D) instead.
BooleanMask2D	getXor(java.awt.Rectangle bounds, boolean[] mask) Deprecated. Use getExclusiveUnion(Rectangle, boolean[]) instead.
static BooleanMask2D	getXorBooleanMask(java.util.ArrayList<ROI2D> rois) Deprecated. Use getExclusiveUnionBooleanMask(List) instead.
static BooleanMask2D	getXorBooleanMask(BooleanMask2D mask1, BooleanMask2D mask2) Deprecated. Use getExclusiveUnionBooleanMask(BooleanMask2D, BooleanMask2D) instead.
static BooleanMask2D	getXorBooleanMask(java.awt.Rectangle bounds1, boolean[] mask1, java.awt.Rectangle bounds2, boolean[] mask2) Deprecated. Uses getExclusiveUnionBooleanMask(Rectangle, boolean[], Rectangle, boolean[]) instead.
static BooleanMask2D	getXorBooleanMask(ROI2D[] rois) Deprecated. Use getExclusiveUnionBooleanMask(ROI2D[]) instead.
void	intersect(BooleanMask2D booleanMask) Set the content of current mask with the result of the intersection with the specified mask: current mask intersect newMask = result ################ ################ ################ ############## ############## ############ ############ ############ ######## ########## ########## #### ######## ######## ###### ###### #### #### ## ##
void	intersect(java.awt.Rectangle boundsToIntersect, boolean[] maskToIntersect) Set the content of current mask with the result of the intersection with the specified mask: current mask intersect newMask = result ################ ################ ################ ############## ############## ############ ############ ############ ######## ########## ########## #### ######## ######## ###### ###### #### #### ## ##
boolean	intersects(BooleanMask2D booleanMask) Return true if mask intersects (contains at least one point) the specified 2D mask.
boolean	intersects(java.awt.Rectangle rect, boolean[] bmask) Return true if mask intersects (contains at least one point) the specified 2D mask region.
boolean	isEmpty() Return true if boolean mask is empty
void	moveBounds(java.awt.Rectangle value) Change the bounds of BooleanMask.
void	optimizeBounds() Optimize mask bounds so it fit mask content.
void	setBounds(java.awt.Rectangle value) Deprecated. Use moveBounds(Rectangle) instead.
void	subtract(java.awt.Rectangle boundsToSubtract, boolean[] maskToSubtract) Subtract the specified mask from the current mask (bounds can change): current mask - mask = result ################ ################ ############## ############## ## ############ ############ #### ########## ########## ###### ######## ######## ######## ###### ###### ###### #### #### #### ## ## ##
void	union(BooleanMask2D booleanMask) Deprecated. Use add(BooleanMask2D) instead.
void	union(java.awt.Rectangle bounds, boolean[] mask) Deprecated. Use add(BooleanMask2D) instead.
BooleanMask2D	upscale() Fast 2x up scaling (each point become 2x2 bloc point).
static BooleanMask2D	upscale(BooleanMask2D mask) Fast 2x up scaling (each point become 2x2 bloc points).
void	xor(BooleanMask2D booleanMask) Deprecated. Use exclusiveUnion(BooleanMask2D) instead
void	xor(java.awt.Rectangle bounds, boolean[] mask) Deprecated. Use exclusiveUnion(Rectangle, boolean[]) instead

Methods inherited from class java.lang.Object

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

Field Detail

bounds

public java.awt.Rectangle bounds

Region represented by the mask.

mask

public boolean[] mask

Boolean mask array.

Constructor Detail

BooleanMask2D

public BooleanMask2D()

Create an empty BooleanMask2D

BooleanMask2D

public BooleanMask2D(java.awt.Rectangle bounds,
             boolean[] mask)

Parameters:

bounds -

mask -

BooleanMask2D

public BooleanMask2D(java.awt.Point[] points)

Build a new boolean mask from the specified array of Point.

BooleanMask2D

public BooleanMask2D(int[] points)

Build a new boolean mask from the specified array of integer representing points.

The array should contains point coordinates defined as follow:
result.length = number of point * 2
result[(pt * 2) + 0] = X coordinate for point pt.
result[(pt * 2) + 1] = Y coordinate for point pt.

Method Detail

getContourPoints

public static java.util.List<java.awt.Point> getContourPoints(java.awt.Rectangle bounds,
                                              boolean[] mask)

Return a list of Point representing the contour points of the mask.
Points are returned in ascending XY order:

  1234 
  5  6
  7 8
   9
 

upscale

public static BooleanMask2D upscale(BooleanMask2D mask)

Fast 2x up scaling (each point become 2x2 bloc points).
This method create a new boolean mask.

getDownscaleValues

public static byte[] getDownscaleValues(BooleanMask2D mask)

Fast 2x down scaling (each 2x2 block points become 1 point value).
This method create a new int[] array returning the number of true point for each 2x2 block.

Parameters:

mask - the boolean mask to download

downscale

public static BooleanMask2D downscale(BooleanMask2D mask,
                      int nbPointForTrue)

Fast 2x down scaling (each 2x2 block points become 1 point).
This method create a new boolean mask.

Parameters:

mask - the boolean mask to download

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

downscale

public static BooleanMask2D downscale(BooleanMask2D mask)

Fast 2x down scaling (each 2x2 block points become 1 point).
This method create a new boolean mask.

getUnion

public static BooleanMask2D getUnion(java.util.List<BooleanMask2D> masks)

Build global boolean mask from union of all specified mask

getUnion

public static BooleanMask2D getUnion(BooleanMask2D mask1,
                     BooleanMask2D mask2)

Build resulting mask from union of the mask1 and mask2.
If mask1 is null then a copy of mask2 is returned.
If mask2 is null then a copy of mask1 is returned.
An empty mask is returned if both mask1 and mask2 are null.

getUnion

public static BooleanMask2D getUnion(java.awt.Rectangle bounds1,
                     boolean[] mask1,
                     java.awt.Rectangle bounds2,
                     boolean[] mask2)

Build resulting mask from union of the mask1 and mask2:

        mask1          +       mask2        =      result
 
     ################     ################     ################
     ##############         ##############     ################
     ############             ############     ################
     ##########                 ##########     ################
     ########                     ########     ################
     ######                         ######     ######    ######
     ####                             ####     ####        ####
     ##                                 ##     ##            ##
 

getIntersection

public static BooleanMask2D getIntersection(java.util.List<BooleanMask2D> masks)

Build global boolean mask from intersection of all specified mask

getIntersection

public static BooleanMask2D getIntersection(BooleanMask2D mask1,
                            BooleanMask2D mask2)

Build resulting mask from intersection of the mask1 and mask2.
An empty mask is returned if mask1 or mask2 is null.

getIntersection

public static BooleanMask2D getIntersection(java.awt.Rectangle bounds1,
                            boolean[] mask1,
                            java.awt.Rectangle bounds2,
                            boolean[] mask2)

Build resulting mask from intersection of the mask1 and mask2:

        mask1     intersect     mask2      =        result
 
     ################     ################     ################
     ##############         ##############       ############
     ############             ############         ########
     ##########                 ##########           ####
     ########                     ########
     ######                         ######
     ####                             ####
     ##                                 ##
 

getExclusiveUnion

public static BooleanMask2D getExclusiveUnion(java.util.List<BooleanMask2D> masks)

Build global boolean mask from exclusive union of all specified mask

getExclusiveUnion

public static BooleanMask2D getExclusiveUnion(BooleanMask2D mask1,
                              BooleanMask2D mask2)

Build resulting mask from exclusive union of the mask1 and mask2.
If mask1 is null then a copy of mask2 is returned.
If mask2 is null then a copy of mask1 is returned.
null is returned if both mask1 and mask2 are null.

getExclusiveUnion

public static BooleanMask2D getExclusiveUnion(java.awt.Rectangle bounds1,
                              boolean[] mask1,
                              java.awt.Rectangle bounds2,
                              boolean[] mask2)

Build resulting mask from exclusive union of the mask1 and mask2:

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

getSubtraction

public static BooleanMask2D getSubtraction(BooleanMask2D mask1,
                           BooleanMask2D mask2)

Build resulting mask from the subtraction of mask2 from mask1.
If mask2 is null then a copy of mask1 is returned.
If mask1 is null then a empty mask is returned.

getSubtraction

public static BooleanMask2D getSubtraction(java.awt.Rectangle bounds1,
                           boolean[] mask1,
                           java.awt.Rectangle bounds2,
                           boolean[] mask2)

Build resulting mask from the subtraction of mask2 from mask1:

        mask1          -        mask2       =  result
 
     ################     ################
     ##############         ##############     ##
     ############             ############     ####
     ##########                 ##########     ######
     ########                     ########     ########
     ######                         ######     ######
     ####                             ####     ####
     ##                                 ##     ##
 

getUnionBooleanMask

@Deprecated
public static BooleanMask2D getUnionBooleanMask(java.util.List<BooleanMask2D> masks)

Deprecated. Use getUnion(List) instead.

getUnionBooleanMask

@Deprecated
public static BooleanMask2D getUnionBooleanMask(ROI2D[] rois)

Deprecated. Use ROIUtil.getUnion(List) instead.

getUnionBooleanMask

@Deprecated
public static BooleanMask2D getUnionBooleanMask(java.util.ArrayList<ROI2D> rois)

Deprecated. Use ROIUtil.getUnion(List) instead.

getUnionBooleanMask

@Deprecated
public static BooleanMask2D getUnionBooleanMask(BooleanMask2D mask1,
                                           BooleanMask2D mask2)

Deprecated. Use getUnion(BooleanMask2D, BooleanMask2D) instead.

getUnionBooleanMask

@Deprecated
public static BooleanMask2D getUnionBooleanMask(java.awt.Rectangle bounds1,
                                           boolean[] mask1,
                                           java.awt.Rectangle bounds2,
                                           boolean[] mask2)

Deprecated. Use getUnion(Rectangle, boolean[], Rectangle, boolean[]) instead.

getIntersectionBooleanMask

@Deprecated
public static BooleanMask2D getIntersectionBooleanMask(java.util.List<BooleanMask2D> masks)

Deprecated. Use getIntersection(List) instead.

getIntersectionBooleanMask

@Deprecated
public static BooleanMask2D getIntersectionBooleanMask(BooleanMask2D mask1,
                                                  BooleanMask2D mask2)

Deprecated. Use getIntersection(BooleanMask2D, BooleanMask2D) instead.

getIntersectionBooleanMask

@Deprecated
public static BooleanMask2D getIntersectionBooleanMask(java.awt.Rectangle bounds1,
                                                  boolean[] mask1,
                                                  java.awt.Rectangle bounds2,
                                                  boolean[] mask2)

Deprecated. Use getIntersection(Rectangle, boolean[], Rectangle, boolean[]) instead.

getIntersectBooleanMask

@Deprecated
public static BooleanMask2D getIntersectBooleanMask(ROI2D[] rois)

Deprecated. Use ROIUtil.getIntersection(List) instead.

getIntersectBooleanMask

@Deprecated
public static BooleanMask2D getIntersectBooleanMask(java.util.ArrayList<ROI2D> rois)

Deprecated. Use ROIUtil.getIntersection(List) instead.

getIntersectBooleanMask

@Deprecated
public static BooleanMask2D getIntersectBooleanMask(BooleanMask2D mask1,
                                               BooleanMask2D mask2)

Deprecated. Use getIntersectionBooleanMask(BooleanMask2D, BooleanMask2D) instead.

getIntersectBooleanMask

@Deprecated
public static BooleanMask2D getIntersectBooleanMask(java.awt.Rectangle bounds1,
                                               boolean[] mask1,
                                               java.awt.Rectangle bounds2,
                                               boolean[] mask2)

Deprecated. Use getIntersectionBooleanMask(Rectangle, boolean[], Rectangle, boolean[]) instead.

getExclusiveUnionBooleanMask

@Deprecated
public static BooleanMask2D getExclusiveUnionBooleanMask(java.util.List<BooleanMask2D> masks)

Deprecated. Use getExclusiveUnion(List) instead.

getExclusiveUnionBooleanMask

@Deprecated
public static BooleanMask2D getExclusiveUnionBooleanMask(ROI2D[] rois)

Deprecated. Use ROIUtil.getExclusiveUnion(List) instead.

getExclusiveUnionBooleanMask

@Deprecated
public static BooleanMask2D getExclusiveUnionBooleanMask(java.util.ArrayList<ROI2D> rois)

Deprecated. Use ROIUtil.getExclusiveUnion(List) instead.

getExclusiveUnionBooleanMask

@Deprecated
public static BooleanMask2D getExclusiveUnionBooleanMask(BooleanMask2D mask1,
                                                    BooleanMask2D mask2)

Deprecated. Use getExclusiveUnion(BooleanMask2D, BooleanMask2D) instead.

getExclusiveUnionBooleanMask

@Deprecated
public static BooleanMask2D getExclusiveUnionBooleanMask(java.awt.Rectangle bounds1,
                                                    boolean[] mask1,
                                                    java.awt.Rectangle bounds2,
                                                    boolean[] mask2)

Deprecated. Use getExclusiveUnion(Rectangle, boolean[], Rectangle, boolean[]) instead.

getXorBooleanMask

@Deprecated
public static BooleanMask2D getXorBooleanMask(ROI2D[] rois)

Deprecated. Use getExclusiveUnionBooleanMask(ROI2D[]) instead.

getXorBooleanMask

@Deprecated
public static BooleanMask2D getXorBooleanMask(java.util.ArrayList<ROI2D> rois)

Deprecated. Use getExclusiveUnionBooleanMask(List) instead.

getXorBooleanMask

@Deprecated
public static BooleanMask2D getXorBooleanMask(BooleanMask2D mask1,
                                         BooleanMask2D mask2)

Deprecated. Use getExclusiveUnionBooleanMask(BooleanMask2D, BooleanMask2D) instead.

getXorBooleanMask

@Deprecated
public static BooleanMask2D getXorBooleanMask(java.awt.Rectangle bounds1,
                                         boolean[] mask1,
                                         java.awt.Rectangle bounds2,
                                         boolean[] mask2)

Deprecated. Uses getExclusiveUnionBooleanMask(Rectangle, boolean[], Rectangle, boolean[]) instead.

isEmpty

public boolean isEmpty()

Return true if boolean mask is empty

contains

public boolean contains(int x,
               int y)

Return true if mask contains the specified point

contains

public boolean contains(BooleanMask2D booleanMask)

Return true if mask contains the specified 2D mask.

contains

public boolean contains(java.awt.Rectangle rect,
               boolean[] bmask)

Return true if mask contains the specified 2D mask.

intersects

public boolean intersects(BooleanMask2D booleanMask)

Return true if mask intersects (contains at least one point) the specified 2D mask.

intersects

public boolean intersects(java.awt.Rectangle rect,
                 boolean[] bmask)

Return true if mask intersects (contains at least one point) the specified 2D mask region.

getNumberOfPoints

public int getNumberOfPoints()

Return the number of points contained in this boolean mask.

getPoints

public java.awt.Point[] getPoints()

Return an array of Point representing all points of the current mask.
Points are returned in ascending XY order :

 Ymin  12 
      3456
       78
 Ymax   9
 

See Also:

getPointsAsIntArray()

getPointsAsIntArray

public int[] getPointsAsIntArray()

Return an array of integer representing all points of the current mask.
result.length = number of point * 2
result[(pt * 2) + 0] = X coordinate for point pt.
result[(pt * 2) + 1] = Y coordinate for point pt.
Points are returned in ascending XY order :

 Ymin  12 
      3456
       78
 Ymax   9
 

getComponentsPoints

public java.awt.Point[][] getComponentsPoints(boolean sorted)

Compute and return a 2D array of Point representing points of each component of the current mask.
A component is basically an isolated object which do not touch any other object.

The array is returned in the following format :
result.lenght = number of component.
result[c].length = number of point of component c.
result[c][n] = Point n of component c.

Parameters:

sorted - When true points are returned in ascending XY order :

 Ymin  12 
      3456
       78
 Ymax   9
        

See Also:

getComponentsPointsAsIntArray()

getComponentsPointsAsIntArray

public int[][] getComponentsPointsAsIntArray()

Compute and return a 2D array of integer representing points of each component of the current mask.
A component is basically an isolated object which do not touch any other object.

The array is returned in the following format :
result.lenght = number of component.
result[c].length = number of point * 2 for component c.
result[c][(pt * 2) + 0] = X coordinate for point pt of component c.
result[c][(pt * 2) + 1] = Y coordinate for point pt of component c.

See Also:

getComponentsPoints(boolean)

getComponents

public BooleanMask2D[] getComponents()

Return an array of boolean mask representing each independent component of the current mask.
A component is basically an isolated object which does not touch any other objects.

getConnectedContourPoints

public java.util.List<java.awt.Point> getConnectedContourPoints()

Returns a list of Point representing the contour points of the mask in connected order.
Note that you should use this method carefully at it does not make any sense to use this method for mask containing disconnected objects.
Also it may returns incorrect result if the contour is not consistent (several connected contour possible).

See Also:

getContourPoints()

getContourPoints

public java.awt.Point[] getContourPoints()

Returns an array of Point containing the contour points of the mask.
Points are returned in ascending XY order:

  123 
  4 5
  6 7
   89
 

See Also:

getContourPointsAsIntArray()

getContourPointsAsIntArray

public int[] getContourPointsAsIntArray()

Returns an array of integer containing the contour points of the mask.
result.length = number of point * 2
result[(pt * 2) + 0] = X coordinate for point pt.
result[(pt * 2) + 1] = Y coordinate for point pt.
Points are returned in ascending XY order:

  123 
  4 5
  6 7
   89
 

See Also:

getConnectedContourPoints()

getEdgePoints

@Deprecated
public java.awt.Point[] getEdgePoints()

Deprecated. Use getContourPoints() instead.

getContourLength

public double getContourLength()

Computes and returns the length of the contour.
This is different from the number of contour point as it takes care of approximating correctly distance between each contour point.

Returns:

the length of the contour

getIntersection

public BooleanMask2D getIntersection(BooleanMask2D booleanMask)

Compute intersection with specified mask and return result in a new mask.

See Also:

intersect(BooleanMask2D)

getIntersection

public BooleanMask2D getIntersection(java.awt.Rectangle bounds,
                            boolean[] mask)

Compute intersection with specified mask and return result in a new mask.

See Also:

intersect(Rectangle, boolean[])

getIntersect

@Deprecated
public BooleanMask2D getIntersect(BooleanMask2D booleanMask)

Deprecated. Use getIntersection(BooleanMask2D) instead.

getIntersect

@Deprecated
public BooleanMask2D getIntersect(java.awt.Rectangle bounds,
                                    boolean[] mask)

Deprecated. Use getIntersection(Rectangle, boolean[]) instead.

getUnion

public BooleanMask2D getUnion(BooleanMask2D booleanMask)

Compute union with specified mask and return result in a new mask.

See Also:

add(BooleanMask2D)

getUnion

public BooleanMask2D getUnion(java.awt.Rectangle bounds,
                     boolean[] mask)

Compute union with specified mask and return result in a new mask.

See Also:

add(Rectangle, boolean[])

getExclusiveUnion

public BooleanMask2D getExclusiveUnion(BooleanMask2D booleanMask)

Compute exclusive union operation with specified mask and return result in a new mask.

See Also:

exclusiveAdd(BooleanMask2D)

getExclusiveUnion

public BooleanMask2D getExclusiveUnion(java.awt.Rectangle bounds,
                              boolean[] mask)

Compute exclusive union operation with specified mask and return result in a new mask

See Also:

exclusiveAdd(Rectangle, boolean[])

getSubtraction

public BooleanMask2D getSubtraction(BooleanMask2D mask)

Subtract the specified mask from current and return result in a new mask.

getSubtraction

public BooleanMask2D getSubtraction(java.awt.Rectangle bounds,
                           boolean[] mask)

Subtract the specified mask from current and return result in a new mask.

getXor

@Deprecated
public BooleanMask2D getXor(BooleanMask2D booleanMask)

Deprecated. Use getExclusiveUnion(BooleanMask2D) instead.

getXor

@Deprecated
public BooleanMask2D getXor(java.awt.Rectangle bounds,
                              boolean[] mask)

Deprecated. Use getExclusiveUnion(Rectangle, boolean[]) instead.

add

public void add(BooleanMask2D booleanMask)

Add the specified mask into the current mask (bounds can be enlarged):

       current mask    +         mask       =       result
 
     ################     ################     ################
     ##############         ##############     ################
     ############             ############     ################
     ##########                 ##########     ################
     ########                     ########     ################
     ######                         ######     ######    ######
     ####                             ####     ####        ####
     ##                                 ##     ##            ##
 

add

public void add(java.awt.Rectangle boundsToAdd,
       boolean[] maskToAdd)

Add the specified mask into the current mask (bounds can be enlarged):

       current mask    +         mask       =       result
 
     ################     ################     ################
     ##############         ##############     ################
     ############             ############     ################
     ##########                 ##########     ################
     ########                     ########     ################
     ######                         ######     ######    ######
     ####                             ####     ####        ####
     ##                                 ##     ##            ##
 

intersect

public void intersect(BooleanMask2D booleanMask)

Set the content of current mask with the result of the intersection with the specified mask:

     current mask  intersect     newMask       =       result
 
     ################     ################     ################
     ##############         ##############       ############
     ############             ############         ########
     ##########                 ##########           ####
     ########                     ########
     ######                         ######
     ####                             ####
     ##                                 ##
 

intersect

public void intersect(java.awt.Rectangle boundsToIntersect,
             boolean[] maskToIntersect)

Set the content of current mask with the result of the intersection with the specified mask:

     current mask  intersect     newMask       =       result
 
     ################     ################     ################
     ##############         ##############       ############
     ############             ############         ########
     ##########                 ##########           ####
     ########                     ########
     ######                         ######
     ####                             ####
     ##                                 ##
 

exclusiveAdd

public void exclusiveAdd(BooleanMask2D booleanMask)

Exclusively add the specified mask into the current mask (bounds can change):

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

exclusiveAdd

public void exclusiveAdd(java.awt.Rectangle boundsToXAdd,
                boolean[] maskToXAdd)

Exclusively add the specified mask into the current mask (bounds can change):

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

subtract

public void subtract(java.awt.Rectangle boundsToSubtract,
            boolean[] maskToSubtract)

Subtract the specified mask from the current mask (bounds can change):

       current mask    -        mask        =  result
 
     ################     ################
     ##############         ##############     ##
     ############             ############     ####
     ##########                 ##########     ######
     ########                     ########     ########
     ######                         ######     ######
     ####                             ####     ####
     ##                                 ##     ##
 

union

@Deprecated
public void union(BooleanMask2D booleanMask)

Deprecated. Use add(BooleanMask2D) instead.

union

@Deprecated
public void union(java.awt.Rectangle bounds,
                    boolean[] mask)

Deprecated. Use add(BooleanMask2D) instead.

exclusiveUnion

@Deprecated
public void exclusiveUnion(BooleanMask2D booleanMask)

Deprecated. Use getExclusiveUnion(BooleanMask2D) instead.

exclusiveUnion

@Deprecated
public void exclusiveUnion(java.awt.Rectangle bounds,
                             boolean[] mask)

Deprecated. Use getExclusiveUnion(Rectangle, boolean[]) instead.

xor

@Deprecated
public void xor(BooleanMask2D booleanMask)

Deprecated. Use exclusiveUnion(BooleanMask2D) instead

xor

@Deprecated
public void xor(java.awt.Rectangle bounds,
                  boolean[] mask)

Deprecated. Use exclusiveUnion(Rectangle, boolean[]) instead

getOptimizedBounds

public java.awt.Rectangle getOptimizedBounds()

Get the smallest bounds which fit mask content.

optimizeBounds

public void optimizeBounds()

Optimize mask bounds so it fit mask content.

setBounds

@Deprecated
public void setBounds(java.awt.Rectangle value)

Deprecated. Use moveBounds(Rectangle) instead.

moveBounds

public void moveBounds(java.awt.Rectangle value)

Change the bounds of BooleanMask.
Keep mask data intersecting from old bounds.

upscale

public BooleanMask2D upscale()

Fast 2x up scaling (each point become 2x2 bloc point).
This method create a new boolean mask.

downscale

public BooleanMask2D downscale(int nbPointForTrue)

Fast 2x down scaling (each 2x2 block points become 1 point).
This method create a new boolean mask.

Parameters:

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

downscale

public BooleanMask2D downscale()

Fast 2x down scaling (each 2x2 block points become 1 point).
This method create a new boolean mask.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object