Skip to content

get_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParamget_metrology_model_paramT_get_metrology_model_param🔗

Short description🔗

get_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParamget_metrology_model_paramT_get_metrology_model_param — Get parameters that are valid for the entire metrology model.

Signature🔗

get_metrology_model_param( metrology_model MetrologyHandle, attribute.name GenParamName, out attribute.value GenParamValue )void GetMetrologyModelParam( const HTuple& MetrologyHandle, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetMetrologyModelParam( HTuple metrologyHandle, HTuple genParamName, out HTuple genParamValue )def get_metrology_model_param( metrology_handle: HHandle, gen_param_name: str ) -> Sequence[Union[str, float, int]]

def get_metrology_model_param_s( metrology_handle: HHandle, gen_param_name: str ) -> Union[str, float, int]Herror T_get_metrology_model_param( const Htuple MetrologyHandle, const Htuple GenParamName, Htuple* GenParamValue )

HTuple HMetrologyModel::GetMetrologyModelParam( const HString& GenParamName ) const

HTuple HMetrologyModel::GetMetrologyModelParam( const char* GenParamName ) const

HTuple HMetrologyModel::GetMetrologyModelParam( const wchar_t* GenParamName ) const (Windows only)

HTuple HMetrologyModel.GetMetrologyModelParam( string genParamName )

Description🔗

get_metrology_model_paramGetMetrologyModelParam 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 MetrologyHandlemetrologyHandlemetrology_handle.

The following generic parameter names for GenParamNamegenParamNamegen_param_name are possible:

  • 'camera_param'"camera_param": The internal camera parameters that are set for the metrology model.

  • '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": The rotation and translation of the current reference coordinate system with respect to the image coordinate system. The tuple returned in GenParamValuegenParamValuegen_param_value contains [row, column, angle].

  • 'scale'"scale": The scaling factor or unit of the results of the measurement returned by get_metrology_object_resultGetMetrologyObjectResult.

Execution information🔗

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🔗

MetrologyHandlemetrologyHandlemetrology_handle (input_control) metrology_model → (handle)HTuple (HHandle)HMetrologyModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the metrology model.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the generic parameter.

Default: 'camera_param'"camera_param"
List of values: 'camera_param', 'plane_pose', 'reference_system', 'scale'"camera_param", "plane_pose", "reference_system", "scale"

GenParamValuegenParamValuegen_param_value (output_control) attribute.value(-array) → (string / real / integer)HTuple (HString / double / Hlong)HTuple (string / double / int / long)Sequence[Union[str, float, int]]Htuple (char* / double / Hlong)

Value of the generic parameter.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

get_metrology_object_indicesGetMetrologyObjectIndices, set_metrology_model_paramSetMetrologyModelParam

Possible successors

get_metrology_object_paramGetMetrologyObjectParam

See also

get_metrology_object_paramGetMetrologyObjectParam, get_metrology_object_num_instancesGetMetrologyObjectNumInstances

Module🔗

2D Metrology