Operator Reference

HALCON Operator Reference / Legacy / 2D Metrology
ClassesClasses | | Operators

copy_metrology_objectT_copy_metrology_objectCopyMetrologyObjectCopyMetrologyObjectcopy_metrology_object (Operator)

copy_metrology_objectT_copy_metrology_objectCopyMetrologyObjectCopyMetrologyObjectcopy_metrology_object — Copy metrology metrology objects of a metrology model.

Warning

copy_metrology_objectcopy_metrology_objectCopyMetrologyObjectCopyMetrologyObjectcopy_metrology_object is obsolete and is only provided for reasons of backward compatibility.

Signature

copy_metrology_object( : : MetrologyHandle, Index : CopiedIndices)

Herror T_copy_metrology_object(const Htuple MetrologyHandle, const Htuple Index, Htuple* CopiedIndices)

void CopyMetrologyObject(const HTuple& MetrologyHandle, const HTuple& Index, HTuple* CopiedIndices)

HTuple HMetrologyModel::CopyMetrologyObject(const HTuple& Index) const

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

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

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

static void HOperatorSet.CopyMetrologyObject(HTuple metrologyHandle, HTuple index, out HTuple copiedIndices)

HTuple HMetrologyModel.CopyMetrologyObject(HTuple index)

int HMetrologyModel.CopyMetrologyObject(string index)

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

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

Description

copy_metrology_objectcopy_metrology_objectCopyMetrologyObjectCopyMetrologyObjectcopy_metrology_object copies metrology metrology objects within this metrology model.

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 determines the metrology objects that are copied. With IndexIndexIndexindexindex set to 'all'"all""all""all""all", all metrology objects are copied. The operator copy_metrology_objectcopy_metrology_objectCopyMetrologyObjectCopyMetrologyObjectcopy_metrology_object returns the index of the new created metrology objects in the parameter CopiedIndicesCopiedIndicesCopiedIndicescopiedIndicescopied_indices. The order of the new metrology objects corresponds to the order of the original metrology objects. Access to the parameters of the metrology objects of the metrology model 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

CopiedIndicesCopiedIndicesCopiedIndicescopiedIndicescopied_indices (output_control)  integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Indices of the copied metrology objects.

Result

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

Module

2D Metrology

ClassesClasses | | Operators