Classification
Region - ExtractRegions
Extracts regions whose feature value is in the provided range.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InFeature | Enum < RegionFeature > | Feature used to classify each region. |
| 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 the regions whose feature value is in the provided range. |
| Error | ErrorState | Gets the execution error message |
Region - FilterRegions
Extracts regions whose feature value differs less than a percentage from the reference one.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InReferenceRegion | Region | Region used to compute the reference value. |
| InFeature | Enum < RegionFeature > | Feature considered during the filtering process. |
| InPercentageAbove | Float | Percentage used to calculate the range of accepted values above the reference. 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 the regions accepted by the filtering process. |
| Error | ErrorState | Gets the execution error message |
Region - FindMaxRegion
Selects the region with the highest value of the provided feature.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InFeature | Enum < RegionFeature > | Feature used to find the maximum. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The selected region. |
| Error | ErrorState | Gets the execution error message |
Region - FindMinRegion
Selects the region with the lowest value of the provided feature.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InFeature | Enum < RegionFeature > | Feature used to find the minimum. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutRegion | Region | The selected region. |
| Error | ErrorState | Gets the execution error message |
Region - GroupPathsByRegions
Splits all the paths in different groups, based on the region in which they are contained.
IN
| Name | Type | Description |
|---|---|---|
| InPaths | PathArray | Input paths. |
| InRegions | RegionArray | Input regions. |
| InMatchingCriterion | Enum < MatchingCriterion > | Method used by the algorithm to group objects. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | IntArrayArray | An array containing the indices of each path, grouped by regions. The first index match the index of the respective region. |
| Error | ErrorState | Gets the execution error message |
Region - GroupPointsByRegions
Splits all the points in different groups, based on the region in which they are contained.
IN
| Name | Type | Description |
|---|---|---|
| InPoints | Point2DArray | Input points. |
| InRegions | RegionArray | Input regions. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | IntArrayArray | An array containing the indices of each point, grouped by regions. The first index match the index of the respective region. |
| Error | ErrorState | Gets the execution error message |
Region - GroupRegionsByRegions
Splits all the regions in different groups, based on the region in which they are contained.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InGroupRegions | RegionArray | Region array used to group input objects. |
| InMatchingCriterion | Enum < MatchingCriterion > | Method used by the algorithm to group objects. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | IntArrayArray | An array containing the indices of each region, divided in respective groups. |
| Error | ErrorState | Gets the execution error message |
Region - MaximumRegionIndex
Returns the index of the region with the highest value of the selected feature.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InFeature | Enum < RegionFeature > | Feature used to find the minimum. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Index of the region with the highest feature value. |
| Error | ErrorState | Gets the execution error message |
Region - MinimumRegionIndex
Returns the index of the region with the lowest value of the selected feature.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InFeature | Enum < RegionFeature > | Feature used to find the minimum. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Index of the region with the lowest feature value. |
| Error | ErrorState | Gets the execution error message |
Region - SortRegions
Sorts the input regions based on the provided feature values.
IN
| Name | Type | Description |
|---|---|---|
| InRegions | RegionArray | Input regions. |
| InFeature | Enum < RegionFeature > | Feature used to sort regions. |
| InSortingOrder | Enum < SortingOrder > | Sorting order. |
| 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 the sorted regions. |
| Error | ErrorState | Gets the execution error message |