Skip to content

get_metrology_object_model_contourget_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContourget_metrology_object_model_contourT_get_metrology_object_model_contour🔗

Short description🔗

get_metrology_object_model_contourget_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContourget_metrology_object_model_contourT_get_metrology_object_model_contour — Query the model contour of a metrology object in image coordinates.

Signature🔗

get_metrology_object_model_contour( out xld_cont Contour, metrology_model MetrologyHandle, integer Index, real Resolution )get_metrology_object_model_contour( : Contour : MetrologyHandle, Index, Resolution : )void GetMetrologyObjectModelContour( HObject* Contour, const HTuple& MetrologyHandle, const HTuple& Index, const HTuple& Resolution )static void HOperatorSet.GetMetrologyObjectModelContour( out HObject contour, HTuple metrologyHandle, HTuple index, HTuple resolution )def get_metrology_object_model_contour( metrology_handle: HHandle, index: MaybeSequence[Union[int, str]], resolution: float ) -> HObject

Herror T_get_metrology_object_model_contour( Hobject* Contour, const Htuple MetrologyHandle, const Htuple Index, const Htuple Resolution )

HXLDCont HMetrologyModel::GetMetrologyObjectModelContour( const HTuple& Index, double Resolution ) const

HXLDCont HMetrologyModel::GetMetrologyObjectModelContour( Hlong Index, double Resolution ) const

HXLDCont HMetrologyModel.GetMetrologyObjectModelContour( HTuple index, double resolution )

HXLDCont HMetrologyModel.GetMetrologyObjectModelContour( int index, double resolution )

Description🔗

get_metrology_object_model_contourGetMetrologyObjectModelContour 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 MetrologyHandlemetrologyHandlemetrology_handle. The parameter Indexindexindex specifies for which metrology objects the contours are queried. For Indexindexindex set to '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_genericAddMetrologyObjectGeneric, add_metrology_object_circle_measureAddMetrologyObjectCircleMeasure, etc. If a different reference coordinate system was set for the metrology model using set_metrology_model_paramSetMetrologyModelParam or an alignment of the metrology model was performed using align_metrology_modelAlignMetrologyModel, these values influence the current pose of the metrology objects and thus the pose of the contours returned in Contourcontourcontour.

The resolution of the returned Contourcontourcontour is controlled via Resolutionresolutionresolution 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🔗

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🔗

Contourcontourcontour (output_object) xld_cont(-array) → objectobjectHObjectHXLDContHObjectHobject *

Model contour.

MetrologyHandlemetrologyHandlemetrology_handle (input_control) metrology_model → (handle)(handle)HTuple (HHandle)HMetrologyModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the metrology model.

Indexindexindex (input_control) integer(-array) → (integer / string)(integer / string)HTuple (Hlong / HString)HTuple (int / long / string)MaybeSequence[Union[int, str]]Htuple (Hlong / char*)

Index of the metrology object.

Default: 00
Suggested values: 'all', 0, 1, 2"all", 0, 1, 2

Resolutionresolutionresolution (input_control) real → (real)(real)HTuple (double)HTuple (double)floatHtuple (double)

Distance between neighboring contour points.

Default: 1.51.5
Restriction: Resolution >= 1.192e-7

Result🔗

If the parameters are valid, the operator get_metrology_object_model_contourGetMetrologyObjectModelContour returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

add_metrology_object_genericAddMetrologyObjectGeneric, add_metrology_object_circle_measureAddMetrologyObjectCircleMeasure, add_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasure, add_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measure, add_metrology_object_line_measureAddMetrologyObjectLineMeasure

Possible successors

apply_metrology_modelApplyMetrologyModel

See also

set_metrology_model_paramSetMetrologyModelParam, get_metrology_object_measuresGetMetrologyObjectMeasures, align_metrology_modelAlignMetrologyModel

Module🔗

2D Metrology