Features
Profile - DivideInSections
Divides the profile into sections where the values fall into the specified range. Note: The values must be part of the range [inMinValue, inMaxValue] and the obtained sections must respect the width range specified. All sections have to be at a certain distance or can be merged if the distance is less than inMaxInnerGapWidth.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InMinSectionWidth | Float | Minimal width of the section. Range: 〔0, +inf）. |
| InMinGapWidth | Float | Minimal distance between consecutive sections. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfileSection | ProfileSectionArray | Profile sections. |
| Error | ErrorState | Gets the execution error message |
Profile - FindProfileEdges
Finds the positions where profile values change rapidly.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | Input profile. |
| InCyclic | Bool | Whether to consider the profile cyclic. |
| InEdgeScanParams | EdgeScanParams | Parameters controlling the edge extraction process. |
| InMinDistance | Float | Minimal distance between consecutive edges. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfileEdge | ProfileEdgeArray | Found edges. |
| Error | ErrorState | Gets the execution error message |
Profile - FindProfileRidges
Finds the local minima or maxima in the profile.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | Input profile. |
| InCyclic | Bool | Whether to consider the profile cyclic. |
| InRidgeScanParams | RidgeScanParams | Parameters controlling the ridge extraction process. |
| InMinDistance | Float | Minimal distance between consecutive ridges. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfileRidge | ProfileRidgeArray | Found ridges. |
| Error | ErrorState | Gets the execution error message |
Profile - FindProfileStripes
Finds segments included between two edges of opposite transition.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | Input profile. |
| InCyclic | Bool | Whether to consider the profile cyclic. |
| InStripeScanParams | StripeScanParams | Parameters controlling the stripe extraction process. |
| InMinGapWidth | Float | Minimal distance between consecutive stripes. Range: 〔0, +inf）. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutProfileStripe | ProfileStripeArray | Found stripes. |
| Error | ErrorState | Gets the execution error message |
Profile - FindZeroCrossings
Finds the X coordinates where the profile intersects the X axis.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | FloatArray | X coordinates. |
| Error | ErrorState | Gets the execution error message |
Profile - GetAverage
Computes the average value of the profile.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Average value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetLocalExtrema
Finds the local extrema positions (where the profile's values are locally minimum or maximum).
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InCyclic | Bool | Whether to consider the profile cyclic. |
| InExtremumType | Enum < ExtremumType > | Type of extremum to find （minimum, maximum or both）. |
| InConsiderPlateaus | Bool | Whether the result should include centers of plateau extrema （'groups' of minima/maxima composed by consecutive equal values）. |
| InInterpolationMethod | Enum < InterpolationMethod1D > | Interpolation method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutExtremum1D | Extremum1DArray | Local extrema. |
| Error | ErrorState | Gets the execution error message |
Profile - GetMaxValue
Finds the maximum value of the profile.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InInterpolationMethod | Enum < InterpolationMethod1D > | Interpolation method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Maximum value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetMinValue
Finds the minimum value of the profile.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| InInterpolationMethod | Enum < InterpolationMethod1D > | Interpolation method. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | minimum value. |
| Error | ErrorState | Gets the execution error message |
Profile - GetSize
Returns the size of the profile.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutInt | Int | Size. |
| Error | ErrorState | Gets the execution error message |
Profile - GetSum
Computes the sum of all profile values.
IN
| Name | Type | Description |
|---|---|---|
| InProfile | Profile | The input Profile |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutFloat | Float | Sum. |
| Error | ErrorState | Gets the execution error message |