Operator Reference

HALCON Operator Reference / 2D Metrology
ClassesClasses | | Operators

copy_metrology_modelT_copy_metrology_modelCopyMetrologyModelCopyMetrologyModelcopy_metrology_model (Operator)

copy_metrology_modelT_copy_metrology_modelCopyMetrologyModelCopyMetrologyModelcopy_metrology_model — Copy a metrology model.

Signature

copy_metrology_model( : : MetrologyHandle, Index : CopiedMetrologyHandle)

Herror T_copy_metrology_model(const Htuple MetrologyHandle, const Htuple Index, Htuple* CopiedMetrologyHandle)

void CopyMetrologyModel(const HTuple& MetrologyHandle, const HTuple& Index, HTuple* CopiedMetrologyHandle)

Hlong HMetrologyModel::CopyMetrologyModel(const HTuple& Index) const

Hlong HMetrologyModel::CopyMetrologyModel(const HString& Index) const

Hlong HMetrologyModel::CopyMetrologyModel(const char* Index) const

Hlong HMetrologyModel::CopyMetrologyModel(const wchar_t* Index) const   ( Windows only)

static void HOperatorSet.CopyMetrologyModel(HTuple metrologyHandle, HTuple index, out HTuple copiedMetrologyHandle)

int HMetrologyModel.CopyMetrologyModel(HTuple index)

int HMetrologyModel.CopyMetrologyModel(string index)

def copy_metrology_model(metrology_handle: HHandle, index: MaybeSequence[Union[str, int]]) -> int

Description

copy_metrology_modelcopy_metrology_modelCopyMetrologyModelCopyMetrologyModelcopy_metrology_model creates a new metrology model and copies the selected metrology objects of the input metrology model to this new output metrology model.

For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.

The input metrology model is defined by a handle MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. The parameter IndexIndexIndexindexindex determines the metrology objects that are copied. With IndexIndexIndexindexindex set to 'all'"all""all""all""all", all metrology objects are copied. The operator returns the handle CopiedMetrologyHandleCopiedMetrologyHandleCopiedMetrologyHandlecopiedMetrologyHandlecopied_metrology_handle of the new metrology model. It can be used to save memory space. Access to the parameters of the metrology objects is possible, e.g., with the operator get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_param.

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

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

Handle of the metrology model.

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

Index of the metrology objects.

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

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

CopiedMetrologyHandleCopiedMetrologyHandleCopiedMetrologyHandlecopiedMetrologyHandlecopied_metrology_handle (output_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Handle of the copied metrology model.

Result

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

Module

2D Metrology

ClassesClasses | | Operators