get_metrology_model_paramT_get_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParamget_metrology_model_param (Operator)
Name
get_metrology_model_paramT_get_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParamget_metrology_model_param — Get parameters that are valid for the entire metrology model.
Signature
Description
get_metrology_model_paramget_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParamGetMetrologyModelParamget_metrology_model_param queries parameters that are
valid for the entire 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 MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle.
The following generic parameter names for GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name
are possible:
- 'camera_param'"camera_param""camera_param""camera_param""camera_param""camera_param":
-
The internal
camera parameters that are set for the metrology model.
- 'plane_pose'"plane_pose""plane_pose""plane_pose""plane_pose""plane_pose":
-
The 3D pose of the
measurement plane that is set for the metrology model. The 3D pose is
given in camera coordinates.
- 'reference_system'"reference_system""reference_system""reference_system""reference_system""reference_system":
-
The rotation and translation of the current
reference coordinate system with respect to the image coordinate system.
The tuple returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains [row, column, angle].
- 'scale'"scale""scale""scale""scale""scale":
-
The scaling factor or
unit of the results of the measurement returned by
get_metrology_object_resultget_metrology_object_resultGetMetrologyObjectResultGetMetrologyObjectResultGetMetrologyObjectResultget_metrology_object_result.
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
MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (input_control) metrology_model → HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the metrology model.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the generic parameter.
Default value:
'camera_param'
"camera_param"
"camera_param"
"camera_param"
"camera_param"
"camera_param"
List of values: 'camera_param'"camera_param""camera_param""camera_param""camera_param""camera_param", 'plane_pose'"plane_pose""plane_pose""plane_pose""plane_pose""plane_pose", 'reference_system'"reference_system""reference_system""reference_system""reference_system""reference_system", 'scale'"scale""scale""scale""scale""scale"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) attribute.value(-array) → HTupleSequence[Union[str, float, int]]HTupleHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong)
Value of the generic parameter.
Result
If the parameters are valid, the operator
get_metrology_model_paramget_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParamGetMetrologyModelParamget_metrology_model_param returns the value 2 (H_MSG_TRUE).
If necessary, an exception is raised.
Possible Predecessors
get_metrology_object_indicesget_metrology_object_indicesGetMetrologyObjectIndicesGetMetrologyObjectIndicesGetMetrologyObjectIndicesget_metrology_object_indices,
set_metrology_model_paramset_metrology_model_paramSetMetrologyModelParamSetMetrologyModelParamSetMetrologyModelParamset_metrology_model_param
Possible Successors
get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_param
See also
get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_param,
get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instances
Module
2D Metrology