ClassesClasses | | Operators

get_metrology_model_paramT_get_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParam (Operator)

Name

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

Signature

get_metrology_model_param( : : MetrologyHandle, GenParamName : GenParamValue)

Herror T_get_metrology_model_param(const Htuple MetrologyHandle, const Htuple GenParamName, Htuple* GenParamValue)

void GetMetrologyModelParam(const HTuple& MetrologyHandle, const HTuple& GenParamName, HTuple* GenParamValue)

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

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

static void HOperatorSet.GetMetrologyModelParam(HTuple metrologyHandle, HTuple genParamName, out HTuple genParamValue)

HTuple HMetrologyModel.GetMetrologyModelParam(string genParamName)

Description

get_metrology_model_paramget_metrology_model_paramGetMetrologyModelParamGetMetrologyModelParamGetMetrologyModelParam 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 MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle.

The following generic parameter names for GenParamNameGenParamNameGenParamNameGenParamNamegenParamName are possible:

'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":

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":

The rotation and translation of the current reference coordinate system with respect to the image coordinate system. The tuple returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue contains [row, column, angle].

'scale'"scale""scale""scale""scale":

The scaling factor or unit of the results of the measurement returned by get_metrology_object_resultget_metrology_object_resultGetMetrologyObjectResultGetMetrologyObjectResultGetMetrologyObjectResult.

Execution Information

Parameters

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control)  metrology_model HMetrologyModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the metrology model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name HTupleHTupleHtuple (string) (string) (HString) (char*)

Name of the generic parameter.

Default value: 'camera_param' "camera_param" "camera_param" "camera_param" "camera_param"

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

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  attribute.value(-array) HTupleHTupleHtuple (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_paramGetMetrologyModelParamGetMetrologyModelParamGetMetrologyModelParam returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

get_metrology_object_indicesget_metrology_object_indicesGetMetrologyObjectIndicesGetMetrologyObjectIndicesGetMetrologyObjectIndices, set_metrology_model_paramset_metrology_model_paramSetMetrologyModelParamSetMetrologyModelParamSetMetrologyModelParam

Possible Successors

get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamGetMetrologyObjectParam

See also

get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamGetMetrologyObjectParam, get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstances

Module

2D Metrology


ClassesClasses | | Operators