ShapeFitting
ShapeFitting - BuildArcFittingMap
Creates and ArcFittingMap starting from the corresponding field.
IN
| Name | Type | Description |
|---|---|---|
| InImageFormat | ImageFormat | Metadata of the image on which the fitting will be performed. |
| InFittingField | ArcFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingMap | ArcFittingMap | The initialized ArcFittingMap object. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - BuildCircleFittingMap
Creates a CircleFittingMap starting from the corresponding field.
IN
| Name | Type | Description |
|---|---|---|
| InImageFormat | ImageFormat | Metadata of the image on which the fitting will be performed. |
| InFittingField | CircleFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingMap | CircleFittingMap | The initialized CircleFittingMap object. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - BuildPathFittingMap
Creates a CircleFittingMap starting from the corresponding field.
IN
| Name | Type | Description |
|---|---|---|
| InImageFormat | ImageFormat | Metadata of the image on which the fitting will be performed. |
| InFittingField | PathFittingField | Field on which the fitting map is based. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingMap | PathFittingMap | The initialized PathFittingMap object. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - BuildSegmentFittingMap
Creates a SegmentFittingMap starting from the corresponding field.
IN
| Name | Type | Description |
|---|---|---|
| InImageFormat | ImageFormat | Metadata of the image on which the fitting will be performed. |
| InFittingField | SegmentFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕 |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingMap | SegmentFittingMap | The initialized SegmentFittingMap object. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitArc_ToEdges
Fits an arc using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | ArcFittingMap | Input fitting map. The map must be initialized using the buildArcFittingMap（） function. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the edge scanning process. |
| InEdgeSelection | Enum < Selection > | Select the edge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2DNull | The fitted arc. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitArc_ToEdges_Direct
Fits an arc using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | ArcFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the edge scanning process. |
| InEdgeSelection | Enum < Selection > | Select the edge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2DNull | The fitted arc. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitArc_ToRidges
Fits an arc using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | ArcFittingMap | Input fitting map. The map must be initialized using the buildArcFittingMap（） function. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2DNull | The fitted arc. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitArc_ToRidges_Direct
Fits an arc using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | ArcFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2DNull | The fitted arc. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitArc_ToStripes
Fits an arc using the stripes detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | ArcFittingMap | Input fitting map. The map must be initialized using the buildArcFittingMap（） function. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2DNull | The arc fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitArc_ToStripes_Direct
Fits an arc using the stripes detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | ArcFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2DNull | The fitted arc. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitCircle_ToEdges
Fits a circle using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | CircleFittingMap | Input fitting map. The map must be initialized using the buildCircleFittingMap（） function. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the edge scanning process. |
| InEdgeSelection | Enum < Selection > | Select the edge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2DNull | The fitted circle. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitCircle_ToEdges_Direct
Fits a circle using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | CircleFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the edge scanning process. |
| InEdgeSelection | Enum < Selection > | Select the edge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2DNull | The fitted circle. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitCircle_ToRidges
Fits a circle using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | CircleFittingMap | Input fitting map. The map must be initialized using the buildCircleFittingMap（） function. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2DNull | The fitted circle. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitCircle_ToRidges_Direct
Fits a circle using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | CircleFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2DNull | The fitted circle. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitCircle_ToStripes
Fits a circle using the stripes detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | CircleFittingMap | Input fitting map. The map must be initialized using the buildCircleFittingMap（） function. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2DNull | The circle fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitCircle_ToStripes_Direct
Fits a circle using the stripes detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | CircleFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| InFittingMethod | Enum < CircleFittingMethod > | Algorithm used to fit the circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2DNull | The circle fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitPath_ToEdges
Fits a path using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | PathFittingMap | Input fitting map. The map must be initialized using the buildPathFittingMap（） function. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the edge scanning process. |
| InEdgeSelection | Enum < Selection > | Select the edge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathNull | The fitted path. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitPath_ToEdges_Direct
Fits a path using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | PathFittingField | Field on which the fitting map is based. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the edge scanning process. |
| InEdgeSelection | Enum < Selection > | Select the edge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathNull | The fitted path. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitPath_ToRidges
Fits a path using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | PathFittingMap | Input fitting map. The map must be initialized using the buildPathFittingMap（） function. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathNull | The fitted path. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitPath_ToRidges_Direct
Fits a path using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | PathFittingField | Field on which the fitting map is based. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathNull | The fitted path. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitPath_ToStripes
Fits a path using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | PathFittingMap | Input fitting map. The map must be initialized using the buildPathFittingMap（） function. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathNull | The path fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitPath_ToStripes_Direct
Fits a path using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | PathFittingField | Field on which the fitting map is based. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | PathNull | The path fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitSegment_ToEdges
Fits a segment using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | SegmentFittingMap | Input fitting map. The map must be initialized using the buildSegmentFittingMap（） function. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the edge scanning process. |
| InEdgeSelection | Enum < Selection > | Select the edge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2DNull | The fitted segment. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitSegment_ToEdges_Direct
Fits a segment using the edges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | SegmentFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InEdgeScanParams | EdgeScanParams | Parameters used to control the stripe scanning process. |
| InEdgeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2DNull | The path fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitSegment_ToRidges
Fits a segment using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | SegmentFittingMap | Input fitting map. The map must be initialized using the buildSegmentFittingMap（） function. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2DNull | The fitted segment. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitSegment_ToRidges_Direct
Fits a segment using the ridges detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | SegmentFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InRidgeScanParams | RidgeScanParams | Parameters used to control the ridge scanning process. |
| InRidgeSelection | Enum < Selection > | Select the ridge that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2DNull | The fitted segment. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitSegment_ToStripes
Fits a segment using the stripes detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingMap | SegmentFittingMap | Input fitting map. The map must be initialized using the buildSegmentFittingMap（） function. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2DNull | The segment fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
ShapeFitting - FitSegment_ToStripes_Direct
Fits a segment using the stripes detected inside the provided scan template.
IN
| Name | Type | Description |
|---|---|---|
| InImage | Image | Input image. It cannot be empty. |
| InFittingField | SegmentFittingField | Field on which the fitting map is based. |
| InScanCount | Int | Number of ScanTemplate objects that will be created inside the map. Range 〔3, +inf〕. |
| InScanWidth | Int | Width of a single ScanTemplate object. Range 〔1, +inf〕. |
| InSamplingParams | SamplingParams | Parameters used for the image sampling process. |
| InStripeScanParams | StripeScanParams | Parameters used to control the stripe scanning process. |
| InStripeSelection | Enum < Selection > | Select the stripe that will be used for the fit in case more than one are detected on the same fit segment. |
| InMaxIncompleteness | Float | Set the maximum number of missing points that will cause the fit to fail. Range 〔0, 0.999〕. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2DNull | The segment fitted using the stripe midpoints. The object is Null if the fit fails for any reason. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - Clear
Deletes all the elements of the ScanTemplate array.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingMap | SegmentFittingMap | The modified Core.Data.Types.SegmentFittingMap |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - EmplaceBack
Add a ScanTemplate object at the end of the array.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| InScanTemplate | ScanTemplate | Input scan template. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingMap | SegmentFittingMap | The modified Core.Data.Types.SegmentFittingMap |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - GetObject
Returns the segment object.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2D | Segment object. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - GetTemplate
Returns the ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| InIndex | Int | Index of the template to retrieve. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplate | ScanTemplate object. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - GetTemplates
Returns the array of templates.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplateArray | Array of ScanTemplate objects. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - IsEmpty
Returns true if the map does not contain any template, false otherwise.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | True if the map is empty, false otherwise. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - Reserve
Reserves the required space for the ScanTemplate array, without allocating memory.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| InCapacity | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingMap | SegmentFittingMap | The modified Core.Data.Types.SegmentFittingMap |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - Resize
Changes the size of the ScanTemplate array. If the new size is lower than the actual size, excess elements are discarded.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| InSize | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingMap | SegmentFittingMap | The modified Core.Data.Types.SegmentFittingMap |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - SetObject
Sets a new segment object.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| InObject | Segment2D | New segment. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingMap | SegmentFittingMap | The modified Core.Data.Types.SegmentFittingMap |
| Error | ErrorState | Gets the execution error message |
SegmentFittingMap - SetTemplate
Sets a new ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingMap | SegmentFittingMap | The input SegmentFittingMap |
| InIndex | Int | Index of the template to set. |
| InTemplate | ScanTemplate | New ScanTemplate object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingMap | SegmentFittingMap | The modified Core.Data.Types.SegmentFittingMap |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - CreateSegmentFittingField_Create
Constructs a new SegmentFittingField object with default values.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingField | SegmentFittingField | The input SegmentFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingField | SegmentFittingField | The SegmentFittingField instance. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - CreateSegmentFittingField_CreateFromFloats
Creates a new SegmentFittingField object using the provided values.
IN
| Name | Type | Description |
|---|---|---|
| InX1 | Float | X coordinate of the first segment point. |
| InY1 | Float | Y coordinate of the first segment point. |
| InX2 | Float | X coordinate of the second segment point. |
| InY2 | Float | Y coordinate of the second segment point. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingField | SegmentFittingField | The SegmentFittingField instance. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - CreateSegmentFittingField_CreateFromPoints
Creates a new SegmentFittingField object using the provided segment points.
IN
| Name | Type | Description |
|---|---|---|
| InPoint1 | Point2D | First segment point. |
| InPoint2 | Point2D | Second segment point. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingField | SegmentFittingField | The SegmentFittingField instance. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - CreateSegmentFittingField_CreateFromSegment
Creates a new SegmentFittingField object using the provided segment.
IN
| Name | Type | Description |
|---|---|---|
| InAxis | Segment2D | Input segment. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingField | SegmentFittingField | The SegmentFittingField instance. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - GetAxis
Returns the axis (segment).
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingField | SegmentFittingField | The input SegmentFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegment2D | Segment2D | Axis. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - GetWidth
Returns the width.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingField | SegmentFittingField | The input SegmentFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Outfloat | Float | Width. |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - SetAxis
Sets a new segment as axis.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingField | SegmentFittingField | The input SegmentFittingField |
| InAxis | Segment2D | New segment. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingField | SegmentFittingField | The modified Core.Data.Types.SegmentFittingField |
| Error | ErrorState | Gets the execution error message |
SegmentFittingField - SetWidth
Sets a new width.
IN
| Name | Type | Description |
|---|---|---|
| InSegmentFittingField | SegmentFittingField | The input SegmentFittingField |
| InWidth | Float | New width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSegmentFittingField | SegmentFittingField | The modified Core.Data.Types.SegmentFittingField |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - Clear
Deletes all the elements of the ScanTemplate array.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingMap | PathFittingMap | The modified Core.Data.Types.PathFittingMap |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - EmplaceBack
Add a ScanTemplate object at the end of the array.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| InScanTemplate | ScanTemplate | Input scan template. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingMap | PathFittingMap | The modified Core.Data.Types.PathFittingMap |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - GetObject
Returns the path object.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Path object. |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - GetTemplate
Returns the ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| InIndex | Int | Index of the template to retrieve. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplate | ScanTemplate object. |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - GetTemplates
Returns the array of templates.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplateArray | Array of ScanTemplate objects. |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - IsEmpty
Returns true if the map does not contain any template, false otherwise.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | True if the map is empty, false otherwise. |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - Reserve
Reserves the required space for the ScanTemplate array, without allocating memory.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| InCapacity | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingMap | PathFittingMap | The modified Core.Data.Types.PathFittingMap |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - Resize
Changes the size of the ScanTemplate array. If the new size is lower than the actual size, excess elements are discarded.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| InSize | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingMap | PathFittingMap | The modified Core.Data.Types.PathFittingMap |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - SetObject
Sets a new path object.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| InObject | Path | New path. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingMap | PathFittingMap | The modified Core.Data.Types.PathFittingMap |
| Error | ErrorState | Gets the execution error message |
PathFittingMap - SetTemplate
Sets a new ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingMap | PathFittingMap | The input PathFittingMap |
| InIndex | Int | Index of the template to set. |
| InTemplate | ScanTemplate | New ScanTemplate object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingMap | PathFittingMap | The modified Core.Data.Types.PathFittingMap |
| Error | ErrorState | Gets the execution error message |
PathFittingField - CreatePathFittingField_Create
Constructs a new PathFittingField object with default values.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingField | PathFittingField | The input PathFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingField | PathFittingField | The PathFittingField instance. |
| Error | ErrorState | Gets the execution error message |
PathFittingField - CreatePathFittingField_CreateFromPath
Creates a new PathFittingField object using the provided path.
IN
| Name | Type | Description |
|---|---|---|
| InAxis | Path | Input path. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingField | PathFittingField | The PathFittingField instance. |
| Error | ErrorState | Gets the execution error message |
PathFittingField - CreatePathFittingField_CreateFromPoints
Creates a new PathFittingField object using the provided points.
IN
| Name | Type | Description |
|---|---|---|
| InPoints | Point2DArray | Array of points used to build the path. |
| InClosed | Bool | True if the path is closed, false otherwise. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingField | PathFittingField | The PathFittingField instance. |
| Error | ErrorState | Gets the execution error message |
PathFittingField - GetAxis
Returns the axis (path).
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingField | PathFittingField | The input PathFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPath | Path | Axis. |
| Error | ErrorState | Gets the execution error message |
PathFittingField - GetWidth
Returns the width.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingField | PathFittingField | The input PathFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Outfloat | Float | Width. |
| Error | ErrorState | Gets the execution error message |
PathFittingField - SetAxis
Sets a new path as axis.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingField | PathFittingField | The input PathFittingField |
| InAxis | Path | New path. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingField | PathFittingField | The modified Core.Data.Types.PathFittingField |
| Error | ErrorState | Gets the execution error message |
PathFittingField - SetWidth
Sets a new width.
IN
| Name | Type | Description |
|---|---|---|
| InPathFittingField | PathFittingField | The input PathFittingField |
| InWidth | Float | New width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutPathFittingField | PathFittingField | The modified Core.Data.Types.PathFittingField |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - Clear
Deletes all the elements of the ScanTemplate array.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingMap | CircleFittingMap | The modified Core.Data.Types.CircleFittingMap |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - EmplaceBack
Add a ScanTemplate object at the end of the array.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| InScanTemplate | ScanTemplate | Input scan template. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingMap | CircleFittingMap | The modified Core.Data.Types.CircleFittingMap |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - GetObject
Returns the circle object.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2D | Circle object. |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - GetTemplate
Returns the ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| InIndex | Int | Index of the template to retrieve. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplate | ScanTemplate object. |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - GetTemplates
Returns the array of templates.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplateArray | Array of ScanTemplate objects. |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - IsEmpty
Returns true if the map does not contain any template, false otherwise.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | True if the map is empty, false otherwise. |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - Reserve
Reserves the required space for the ScanTemplate array, without allocating memory.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| InCapacity | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingMap | CircleFittingMap | The modified Core.Data.Types.CircleFittingMap |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - Resize
Changes the size of the ScanTemplate array. If the new size is lower than the actual size, excess elements are discarded.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| InSize | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingMap | CircleFittingMap | The modified Core.Data.Types.CircleFittingMap |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - SetObject
Sets a new circle object.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| InObject | Circle2D | New circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingMap | CircleFittingMap | The modified Core.Data.Types.CircleFittingMap |
| Error | ErrorState | Gets the execution error message |
CircleFittingMap - SetTemplate
Sets a new ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingMap | CircleFittingMap | The input CircleFittingMap |
| InIndex | Int | Index of the template to set. |
| InTemplate | ScanTemplate | New ScanTemplate object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingMap | CircleFittingMap | The modified Core.Data.Types.CircleFittingMap |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - CreateCircleFittingField_Create
Constructs a new CircleFittingField object with default values.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingField | CircleFittingField | The input CircleFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingField | CircleFittingField | The CircleFittingField instance. |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - CreateCircleFittingField_CreateFromCircle
Creates a new CircleFittingField object using the provided circle.
IN
| Name | Type | Description |
|---|---|---|
| InAxis | Circle2D | Input circle. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingField | CircleFittingField | The CircleFittingField instance. |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - CreateCircleFittingField_CreateFromFloats
Creates a new CircleFittingField object using the provided values.
IN
| Name | Type | Description |
|---|---|---|
| InX | Float | X coordinate of the circle center. |
| InY | Float | Y coordinate of the circle center. |
| InRadius | Float | Circle radius. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingField | CircleFittingField | The CircleFittingField instance. |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - CreateCircleFittingField_CreateFromPoint
Creates a new CircleFittingField object using the provided circle components.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Circle center. |
| InRadius | Float | Circle radius. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingField | CircleFittingField | The CircleFittingField instance. |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - GetAxis
Returns the axis (circle).
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingField | CircleFittingField | The input CircleFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircle2D | Circle2D | Axis. |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - GetWidth
Returns the width.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingField | CircleFittingField | The input CircleFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Outfloat | Float | Width. |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - SetAxis
Sets a new circle as axis.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingField | CircleFittingField | The input CircleFittingField |
| InAxis | Circle2D | New circle. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingField | CircleFittingField | The modified Core.Data.Types.CircleFittingField |
| Error | ErrorState | Gets the execution error message |
CircleFittingField - SetWidth
Sets a new width.
IN
| Name | Type | Description |
|---|---|---|
| InCircleFittingField | CircleFittingField | The input CircleFittingField |
| InWidth | Float | New width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutCircleFittingField | CircleFittingField | The modified Core.Data.Types.CircleFittingField |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - Clear
Deletes all the elements of the ScanTemplate array.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingMap | ArcFittingMap | The modified Core.Data.Types.ArcFittingMap |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - EmplaceBack
Add a ScanTemplate object at the end of the array.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| InScanTemplate | ScanTemplate | Input scan template. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingMap | ArcFittingMap | The modified Core.Data.Types.ArcFittingMap |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - GetObject
Returns the arc object.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2D | Arc object. |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - GetTemplate
Returns the ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| InIndex | Int | Index of the template to retrieve. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplate | ScanTemplate object. |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - GetTemplates
Returns the array of templates.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutScanTemplate | ScanTemplateArray | Array of ScanTemplate objects. |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - IsEmpty
Returns true if the map does not contain any template, false otherwise.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBool | Bool | True if the map is empty, false otherwise. |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - Reserve
Reserves the required space for the ScanTemplate array, without allocating memory.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| InCapacity | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingMap | ArcFittingMap | The modified Core.Data.Types.ArcFittingMap |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - Resize
Changes the size of the ScanTemplate array. If the new size is lower than the actual size, excess elements are discarded.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| InSize | Int | Input size. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingMap | ArcFittingMap | The modified Core.Data.Types.ArcFittingMap |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - SetObject
Sets a new arc object.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| InObject | Arc2D | New arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingMap | ArcFittingMap | The modified Core.Data.Types.ArcFittingMap |
| Error | ErrorState | Gets the execution error message |
ArcFittingMap - SetTemplate
Sets a new ScanTemplate object at the specified index.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingMap | ArcFittingMap | The input ArcFittingMap |
| InIndex | Int | Index of the template to set. |
| InTemplate | ScanTemplate | New ScanTemplate object. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingMap | ArcFittingMap | The modified Core.Data.Types.ArcFittingMap |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - CreateArcFittingField_Create
Constructs a new ArcFittingField object with default values.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingField | ArcFittingField | The input ArcFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingField | ArcFittingField | The ArcFittingField instance. |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - CreateArcFittingField_CreateFromArc
Creates a new ArcFittingField object using the provided arc.
IN
| Name | Type | Description |
|---|---|---|
| InAxis | Arc2D | Input arc. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingField | ArcFittingField | The ArcFittingField instance. |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - CreateArcFittingField_CreateFromFloats
Creates a new ArcFittingField object using the provided values.
IN
| Name | Type | Description |
|---|---|---|
| InX | Float | X coordinate of the arc center. |
| InY | Float | Y coordinate of the arc center. |
| InRadius | Float | Arc radius. |
| InStartAngle | Float | Arc start angle. |
| InSweepAngle | Float | Arc sweep angle. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingField | ArcFittingField | The ArcFittingField instance. |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - CreateArcFittingField_CreateFromPoint
Creates a new ArcFittingField object using the provided arc components.
IN
| Name | Type | Description |
|---|---|---|
| InPoint | Point2D | Arc center. |
| InRadius | Float | Arc radius. |
| InStartAngle | Float | Arc start angle. |
| InSweepAngle | Float | Arc sweep angle. |
| InWidth | Float | Input width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingField | ArcFittingField | The ArcFittingField instance. |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - GetAxis
Returns the axis (arc).
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingField | ArcFittingField | The input ArcFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArc2D | Arc2D | Axis. |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - GetWidth
Returns the width.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingField | ArcFittingField | The input ArcFittingField |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Outfloat | Float | Width. |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - SetAxis
Sets a new arc as axis.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingField | ArcFittingField | The input ArcFittingField |
| InAxis | Arc2D | New arc. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingField | ArcFittingField | The modified Core.Data.Types.ArcFittingField |
| Error | ErrorState | Gets the execution error message |
ArcFittingField - SetWidth
Sets a new width.
IN
| Name | Type | Description |
|---|---|---|
| InArcFittingField | ArcFittingField | The input ArcFittingField |
| InWidth | Float | New width. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutArcFittingField | ArcFittingField | The modified Core.Data.Types.ArcFittingField |
| Error | ErrorState | Gets the execution error message |