PolygonFeatures
Path - GetArea
Computes the polygon area. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - GetCircularity
Computes the path circularity, defined as the polygon area divided by the area of the circle having the same provided feature. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InCircularityMeasure | Enum < CircularityMeasure > | Equivalent circle feature. |
| 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 |
Path - GetConvexity
Computes the path convexity, defined as the polygon area normalized to the area of the convex hull. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - GetElongation
Computes the polygon elongation. Note: The perfect circle has the minimal elongation of 1. It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - GetInscribedCircle
Computes the path's inscribed circle with the maximal area. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - GetMajorEllipticAxis
Computes the path major elliptical axis. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - GetMinorEllipticAxis
Computes the path minor elliptical axis. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - GetMoment
Computer the polygon second-order moment. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InMomentType | Enum < PolygonMoment > | Moment type. |
| InCentral | Bool | If true, computes the central moment. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The value of the requested moment. |
| Error | ErrorState | Gets the execution error message |
Path - GetNormMoment
Computer the polygon second-order normalized moment. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| InMomentType | Enum < PolygonMoment > | Moment type. |
| InCentral | Bool | If true, returns the central moment. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | The value of the requested moment normalized using the polygon area. |
| Error | ErrorState | Gets the execution error message |
Path - GetOrientation
Computes the polygon orientation as an angle. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 in the range 〔0, 180〕. |
| Error | ErrorState | Gets the execution error message |
Path - GetPolygonMassCenter
Computes the polygon mass center. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - GetRectangularity
Computes the path rectangularity, defined as the polygon area divided by the area of its bounding rectangle. Note: It returns a correct result only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| 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 |
Path - NormalizeOrientation
Normalize the polygon orientation based on the axis. Note: The normalization is correct only if the path is actually a polygon (close and without self-intersections).
IN
| Name | Type | Description |
|---|---|---|
| InPath | Path | The input Path |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | The modified Core.Data.Types.Path |
| Error | ErrorState | Gets the execution error message |