get_metrology_object_model_contourT_get_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContour (Operator)
Name
get_metrology_object_model_contourT_get_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContour — Query the model contour of a metrology object in image coordinates.
Signature
Description
get_metrology_object_model_contourget_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContourGetMetrologyObjectModelContour returns the contours for the
chosen metrology objects in image coordinates.
For an explanation of the concept of 2D metrology see the
introduction of chapter 2D Metrology.
The metrology model is defined by the handle MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle. The
parameter IndexIndexIndexIndexindex specifies for which metrology objects the contours
are queried. For IndexIndexIndexIndexindex set to 'all'"all""all""all""all", the contours of all
metrology objects are returned.
The form and pose of each contour is determined by the
parameters set when adding the object using e.g.
add_metrology_object_genericadd_metrology_object_genericAddMetrologyObjectGenericAddMetrologyObjectGenericAddMetrologyObjectGeneric,
add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasure, etc. If a different
reference coordinate system was set for the metrology model using
set_metrology_model_paramset_metrology_model_paramSetMetrologyModelParamSetMetrologyModelParamSetMetrologyModelParam or an alignment of the metrology model was
performed using align_metrology_modelalign_metrology_modelAlignMetrologyModelAlignMetrologyModelAlignMetrologyModel, these values influence the
current pose of the metrology objects and thus the pose of the contours
returned in ContourContourContourContourcontour.
The resolution of the returned ContourContourContourContourcontour is
controlled via ResolutionResolutionResolutionResolutionresolution containing the Euclidean
distance (in pixel) between neighboring contour points. If the input value
falls below the minimal possible value (1.192e-7), the resolution is set
internally to the smallest valid value.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ContourContourContourContourcontour (output_object) xld_cont(-array) → objectHXLDContHXLDContHobject *
Model contour.
MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control) metrology_model → HMetrologyModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the metrology model.
IndexIndexIndexIndexindex (input_control) integer(-array) → HTupleHTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Index of the metrology object.
Default value: 0
Suggested values: 'all'"all""all""all""all", 0, 1, 2
ResolutionResolutionResolutionResolutionresolution (input_control) real → HTupleHTupleHtuple (real) (double) (double) (double)
Distance between neighboring contour points.
Default value: 1.5
Restriction: Resolution >= 1.192e-7
Result
If the parameters are valid, the operator
get_metrology_object_model_contourget_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContourGetMetrologyObjectModelContour returns the value 2 (H_MSG_TRUE).
If necessary, an exception is raised.
Possible Predecessors
add_metrology_object_genericadd_metrology_object_genericAddMetrologyObjectGenericAddMetrologyObjectGenericAddMetrologyObjectGeneric,
add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasure,
add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure,
add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measure,
add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasure
Possible Successors
apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelApplyMetrologyModel
See also
set_metrology_model_paramset_metrology_model_paramSetMetrologyModelParamSetMetrologyModelParamSetMetrologyModelParam,
get_metrology_object_measuresget_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasures,
align_metrology_modelalign_metrology_modelAlignMetrologyModelAlignMetrologyModelAlignMetrologyModel
Module
2D Metrology