get_metrology_object_model_contourT_get_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContourget_metrology_object_model_contour (Operator)

Name

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

Signature

get_metrology_object_model_contour( : Contour : MetrologyHandle, Index, Resolution : )

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

void GetMetrologyObjectModelContour(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

static void HOperatorSet.GetMetrologyObjectModelContour(out HObject contour, HTuple metrologyHandle, HTuple index, HTuple resolution)

HXLDCont HMetrologyModel.GetMetrologyObjectModelContour(HTuple index, double resolution)

HXLDCont HMetrologyModel.GetMetrologyObjectModelContour(int index, double resolution)

def get_metrology_object_model_contour(metrology_handle: HHandle, index: MaybeSequence[Union[int, str]], resolution: float) -> HObject

Description

get_metrology_object_model_contourget_metrology_object_model_contourGetMetrologyObjectModelContourGetMetrologyObjectModelContourGetMetrologyObjectModelContourget_metrology_object_model_contour 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 MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. The parameter IndexIndexIndexIndexindexindex specifies for which metrology objects the contours are queried. For IndexIndexIndexIndexindexindex set to 'all'"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_genericAddMetrologyObjectGenericAddMetrologyObjectGenericAddMetrologyObjectGenericadd_metrology_object_generic, add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure, etc. If a different reference coordinate system was set for the metrology model using set_metrology_model_paramset_metrology_model_paramSetMetrologyModelParamSetMetrologyModelParamSetMetrologyModelParamset_metrology_model_param or an alignment of the metrology model was performed using align_metrology_modelalign_metrology_modelAlignMetrologyModelAlignMetrologyModelAlignMetrologyModelalign_metrology_model, these values influence the current pose of the metrology objects and thus the pose of the contours returned in ContourContourContourContourcontourcontour.

The resolution of the returned ContourContourContourContourcontourcontour is controlled via ResolutionResolutionResolutionResolutionresolutionresolution 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

Parameters

ContourContourContourContourcontourcontour (output_object)  xld_cont(-array) objectHXLDContHObjectHXLDContHobject *

Model contour.

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (input_control)  metrology_model HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the metrology model.

IndexIndexIndexIndexindexindex (input_control)  integer(-array) HTupleMaybeSequence[Union[int, str]]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)

Index of the metrology object.

Default: 0

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

ResolutionResolutionResolutionResolutionresolutionresolution (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Distance between neighboring contour points.

Default: 1.5

Restriction: Resolution >= 1.192e-7

Result

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

Possible Predecessors

add_metrology_object_genericadd_metrology_object_genericAddMetrologyObjectGenericAddMetrologyObjectGenericAddMetrologyObjectGenericadd_metrology_object_generic, add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure, add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure, add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure, add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure

Possible Successors

apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelApplyMetrologyModelapply_metrology_model

See also

set_metrology_model_paramset_metrology_model_paramSetMetrologyModelParamSetMetrologyModelParamSetMetrologyModelParamset_metrology_model_param, get_metrology_object_measuresget_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresget_metrology_object_measures, align_metrology_modelalign_metrology_modelAlignMetrologyModelAlignMetrologyModelAlignMetrologyModelalign_metrology_model

Module

2D Metrology