Features
Region - GetAnchoredPoint
Returns the point of the region described by the provided anchor.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InPointAnchor | Enum < Anchor2D > | Input anchor. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2D | Point2D | The computed point. |
| Error | ErrorState | Gets the execution error message |
Region - GetArea
Computes the region's area, i.e. the number of contained points.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | The computed value. |
| Error | ErrorState | Gets the execution error message |
Region - GetBoundaries
Returns a new region without the interior points.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InConnectivity | Enum < RegionConnectivity > | Type of connectivity used by the algorithm. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The computed region. |
| Error | ErrorState | Gets the execution error message |
Region - GetBoundingBox
Computes the box with minimum area the contains the entire region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBox | Box | The computed box. |
| Error | ErrorState | Gets the execution error message |
Region - GetBoundingCircle
Computes the circle with the smallest area that contains the entire region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2D | The computed circle. |
| Error | ErrorState | Gets the execution error message |
Region - GetBoundingRect
Returns the rectangle with minimal area that contains the entire region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRectangle2D | Rectangle2D | The computed rectangle. |
| Error | ErrorState | Gets the execution error message |
Region - GetCaliperDiameters
Uses the caliper diameter algorithm to compute the longest and the shortest segments connecting two points of the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The modified Core.Data.Types.Region |
| Error | ErrorState | Gets the execution error message |
Region - GetCircularity
Computes the region circularity. Note: The circularity is defined as the region area divided by the area of an equivalent circle having the same selected feature.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InCircularityMeasure | Enum < CircularityMeasure > | Select the type of equivalent circle used to compute the circularity. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed value. |
| Error | ErrorState | Gets the execution error message |
Region - GetConvexHull
Computes the region's convex hull as a Region object.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The computed region. |
| Error | ErrorState | Gets the execution error message |
Region - GetConvexity
Computes the region convexity, defined as its area divided by the area of its convex hull.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed value. |
| Error | ErrorState | Gets the execution error message |
Region - GetDiameter
Computes the longest segment connecting two points of the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2D | The computes segment. |
| Error | ErrorState | Gets the execution error message |
Region - GetElongation
Computes the region elongation. Note: A result equal to 1 means perfect elongation, which is theoretically possible only considering the perfect circle.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed value. |
| Error | ErrorState | Gets the execution error message |
Region - GetHoles
Convert holes of the region into region themselves.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InConnectivity | Enum < RegionConnectivity > | Type of connectivity used by the algorithm. |
| InMinHoleArea | Int | Holes with lower area are discarded. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | RegionArray | An array containing all the extracted regions. |
| Error | ErrorState | Gets the execution error message |
Region - GetInteriors
Returns a new region without the border point.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InConnectivity | Enum < RegionConnectivity > | Type of connectivity used by the algorithm. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The computed region. |
| Error | ErrorState | Gets the execution error message |
Region - GetMajorEllipticAxis
Computes the major elliptical axis of the region. Note: The elliptical axis is defined as the axis of an ellipse that has the same first and second order moments of the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2D | The computed segment. |
| Error | ErrorState | Gets the execution error message |
Region - GetMassCenter
Computes the center of mass of all the points of the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2D | Point2D | The computed point. |
| Error | ErrorState | Gets the execution error message |
Region - GetMinorEllipticAxis
Computes the minor elliptical axis of the region. Note: The elliptical axis is defined as the axis of an ellipse that has the same first and second order moments of the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2D | The computed segment. |
| Error | ErrorState | Gets the execution error message |
Region - GetMoment
Computes the requested region moment.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InMomentType | Enum < RegionMoment > | Select the moment that should be computed. |
| InCentral | Bool | If true, the central moment is computed. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed value. |
| Error | ErrorState | Gets the execution error message |
Region - GetNormMoment
Computes the requested region moment, normalized to the region area.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InMomentType | Enum < RegionMoment > | Select the moment that should be computed. |
| InCentral | Bool | If true, the central moment is computed. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed value. |
| Error | ErrorState | Gets the execution error message |
Region - GetOrientation
Computes the region orientation.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InAngleRange | Enum < AngleRange > | Range of the output angle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed angle. |
| Error | ErrorState | Gets the execution error message |
Region - GetOuterBoundaries
Computes boundaries of the region, divided by top, bottom, left and right points.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutTopBoundary | Point2DiArray | Array of points that are not connected to points with lower y coordinate. |
| OutRightBoundary | Point2DiArray | Array of points that are not connected to points with higher x coordinate. |
| OutBottomBoundary | Point2DiArray | Array of points that are not connected to points with higher y coordinate. |
| OutLeftBoundary | Point2DiArray | Array of points that are not connected to points with lower x coordinate. |
| Error | ErrorState | Gets the execution error message |
Region - GetOuterBoundary
Computes one of the region boundaries.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InRegionOuterBoundary | Enum < RegionOuterBoundary > | Select the type of boundary that will be computed. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPoint2Di | Point2DiArray | The computed boundary. |
| Error | ErrorState | Gets the execution error message |
Region - GetPathConvexHull
Computes the region's convex hull as a Path object.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The computed path. |
| Error | ErrorState | Gets the execution error message |
Region - GetPerimeter
Returns the Region Perimeter.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | the region perimeter |
| Error | ErrorState | Gets the execution error message |
Region - GetPointsSequenceLengths
Computes the lengths of all the region's point sequences.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | IntArray | An array containing all the computed lengths. |
| Error | ErrorState | Gets the execution error message |
Region - GetProjection
Computes the number of points either in each row or column of the region.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| InProjectionDirection | Enum < ProjectionDirection > | Direction used to count the number of points. 'Horizontal' will provide the count by rows. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfile | Profile | A profile containing all requested counts. |
| Error | ErrorState | Gets the execution error message |
Region - GetRectangularity
Computes the region rectangularity, defined as its area divided by the area of it bounding rectangle.
IN
| Name | Type | Description |
|---|---|---|
| InRegion | Region | The input Region |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The computed value. |
| Error | ErrorState | Gets the execution error message |