Operator Reference

HALCON Operator Reference / 2D Metrology
ClassesClasses | | Operators

get_metrology_object_result_contourT_get_metrology_object_result_contourGetMetrologyObjectResultContourGetMetrologyObjectResultContourget_metrology_object_result_contour (Operator)

get_metrology_object_result_contourT_get_metrology_object_result_contourGetMetrologyObjectResultContourGetMetrologyObjectResultContourget_metrology_object_result_contour — Query the result contour of a metrology object.

Signature

get_metrology_object_result_contour( : Contour : MetrologyHandle, Index, Instance, Resolution : )

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

void GetMetrologyObjectResultContour(HObject* Contour, const HTuple& MetrologyHandle, const HTuple& Index, const HTuple& Instance, const HTuple& Resolution)

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

HXLDCont HMetrologyModel::GetMetrologyObjectResultContour(Hlong Index, const HString& Instance, double Resolution) const

HXLDCont HMetrologyModel::GetMetrologyObjectResultContour(Hlong Index, const char* Instance, double Resolution) const

HXLDCont HMetrologyModel::GetMetrologyObjectResultContour(Hlong Index, const wchar_t* Instance, double Resolution) const   ( Windows only)

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

HXLDCont HMetrologyModel.GetMetrologyObjectResultContour(HTuple index, HTuple instance, double resolution)

HXLDCont HMetrologyModel.GetMetrologyObjectResultContour(int index, string instance, double resolution)

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

Description

get_metrology_object_result_contourget_metrology_object_result_contourGetMetrologyObjectResultContourGetMetrologyObjectResultContourget_metrology_object_result_contour returns for the chosen metrology objects and object instances, the result contours of a measurement performed by apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model 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 MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. The parameter IndexIndexIndexindexindex specifies for which metrology objects the result contours are queried. For IndexIndexIndexindexindex set to 'all'"all""all""all""all", the result contours of all metrology objects are returned. If for a metrology object several results (instances) were computed, then the parameter InstanceInstanceInstanceinstanceinstance specifies, for which instances the result contours are returned in ContourContourContourcontourcontour. The result contours for all instances are obtained by setting InstanceInstanceInstanceinstanceinstance to 'all'"all""all""all""all".

The resolution of the resulting contour ContourContourContourcontourcontour is controlled via ResolutionResolutionResolutionresolutionresolution containing the Euclidean distance between neighboring contour points in pixel. If the input value falls below the minimal possible value (1.192e-7), then 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) → objectHXLDContHObjectHObjectHobject *

Result contour for the given metrology object.

MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (input_control)  metrology_model → HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the metrology model.

IndexIndexIndexindexindex (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", 0, 1, 2

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

Instance of the metrology object.

Default: 'all' "all" "all" "all" "all"

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

ResolutionResolutionResolutionresolutionresolution (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_result_contourget_metrology_object_result_contourGetMetrologyObjectResultContourGetMetrologyObjectResultContourget_metrology_object_result_contour returns the value 2 ( H_MSG_TRUE) . If necessary, an exception is raised.

Possible Predecessors

apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model

See also

get_metrology_object_resultget_metrology_object_resultGetMetrologyObjectResultGetMetrologyObjectResultget_metrology_object_result, get_metrology_object_measuresget_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresget_metrology_object_measures

Module

2D Metrology

ClassesClasses | | Operators