Name
get_metrology_object_resultget_metrology_object_resultGetMetrologyObjectResultget_metrology_object_resultGetMetrologyObjectResultGetMetrologyObjectResult — Get the results of the measurements applied for a metrology model.
Herror get_metrology_object_result(const Hlong MetrologyHandle, const Hlong Indices, const Hlong Instance, const char* GenParamName, const char* GenParamValue, double* Parameter)
Herror T_get_metrology_object_result(const Htuple MetrologyHandle, const Htuple Indices, const Htuple Instance, const Htuple GenParamName, const Htuple GenParamValue, Htuple* Parameter)
Herror get_metrology_object_result(const HTuple& MetrologyHandle, const HTuple& Indices, const HTuple& Instance, const HTuple& GenParamName, const HTuple& GenParamValue, double* Parameter)
Herror get_metrology_object_result(const HTuple& MetrologyHandle, const HTuple& Indices, const HTuple& Instance, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* Parameter)
HTuple HMetrologyModel::GetMetrologyObjectResult(const HTuple& Indices, const HTuple& Instance, const HTuple& GenParamName, const HTuple& GenParamValue) const
void GetMetrologyObjectResult(const HTuple& MetrologyHandle, const HTuple& Indices, const HTuple& Instance, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* Parameter)
HTuple HMetrologyModel::GetMetrologyObjectResult(const HTuple& Indices, const HTuple& Instance, const HTuple& GenParamName, const HTuple& GenParamValue) const
HTuple HMetrologyModel::GetMetrologyObjectResult(Hlong Indices, Hlong Instance, const HString& GenParamName, const HString& GenParamValue) const
HTuple HMetrologyModel::GetMetrologyObjectResult(Hlong Indices, Hlong Instance, const char* GenParamName, const char* GenParamValue) const
static void HOperatorSet.GetMetrologyObjectResult(HTuple metrologyHandle, HTuple indices, HTuple instance, HTuple genParamName, HTuple genParamValue, out HTuple parameter)
HTuple HMetrologyModel.GetMetrologyObjectResult(HTuple indices, HTuple instance, HTuple genParamName, HTuple genParamValue)
HTuple HMetrologyModel.GetMetrologyObjectResult(int indices, int instance, string genParamName, string genParamValue)
get_metrology_object_resultget_metrology_object_resultGetMetrologyObjectResultget_metrology_object_resultGetMetrologyObjectResultGetMetrologyObjectResult allows to access the results of a
measurement applied by apply_metrology_modelapply_metrology_modelApplyMetrologyModelapply_metrology_modelApplyMetrologyModelApplyMetrologyModel for the metrology
objects (see create_metrology_modelcreate_metrology_modelCreateMetrologyModelcreate_metrology_modelCreateMetrologyModelCreateMetrologyModel for the
basic principle of 2D metrology). The metrology model is defined by
the handle MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle. The parameter IndicesIndicesIndicesIndicesIndicesindices
specifies for which metrology objects the results are queried. For
IndicesIndicesIndicesIndicesIndicesindices set to 'all'"all""all""all""all""all", the results of all metrology
objects are returned. With the parameter InstanceInstanceInstanceInstanceInstanceinstance it can be
specified, which instances of the results are returned in
ParameterParameterParameterParameterParameterparameter. The results for all instances are returned by
setting InstanceInstanceInstanceInstanceInstanceinstance to 'all'"all""all""all""all""all". Different generic
parameters can be used to control the returned values in
ParameterParameterParameterParameterParameterparameter. The generic parameter names are passed in
GenParamNameGenParamNameGenParamNameGenParamNameGenParamNamegenParamName. The correspondig values are passed in
GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. The following parameters
and values are possible:
- 'result_type'"result_type""result_type""result_type""result_type""result_type":
-
This parameter determines the type
of the result.
By setting the parameter 'result_type'"result_type""result_type""result_type""result_type""result_type" to
'param'"param""param""param""param""param" the measurement results of the metrology objects are
returned (as obtained from the operator
apply_metrology_modelapply_metrology_modelApplyMetrologyModelapply_metrology_modelApplyMetrologyModelApplyMetrologyModel).
In particular, if the type of the metrology object is a circle, the return
values are the 'row'"row""row""row""row""row" and the 'column'"column""column""column""column""column"
coordinates of the center and the 'radius'"radius""radius""radius""radius""radius"
of the circle. The order is ['row'"row""row""row""row""row", 'column'"column""column""column""column""column",
'radius'"radius""radius""radius""radius""radius"].
If the type of the metrology object is an ellipse, the return values are
the 'row'"row""row""row""row""row" and the 'column'"column""column""column""column""column"
coordinates of the center, the orientation of the main axis
'phi'"phi""phi""phi""phi""phi", the length of the larger half axis
'radius1'"radius1""radius1""radius1""radius1""radius1", and the length of the smaler half axis
'radius2'"radius2""radius2""radius2""radius2""radius2" of the ellipse. The order is ['row'"row""row""row""row""row",
'column'"column""column""column""column""column",'phi'"phi""phi""phi""phi""phi",'radius1'"radius1""radius1""radius1""radius1""radius1",
'radius2'"radius2""radius2""radius2""radius2""radius2"].
If the type of the metrology object is a line, the 3 parameters of the
hessian normal form are returned, i.e., the unit normal
vector [row, column] and the
orthogonal distance [d] of the line from the origin of
the coordinate system. The order is [row,
column, d]. The sign of the distance
determines the side of the line on which the origin is located.
If the type of the metrology object is a rectangle, the return values are
the 'row'"row""row""row""row""row" and the 'column'"column""column""column""column""column"
coordinates of the center, the orientation of the main axis
'phi'"phi""phi""phi""phi""phi", the length of the larger half edge
'length1'"length1""length1""length1""length1""length1", and the length of the smaler half edge
'length2'"length2""length2""length2""length2""length2" of the rectangle. The order is ['row'"row""row""row""row""row",
'column'"column""column""column""column""column",'phi'"phi""phi""phi""phi""phi",'length1'"length1""length1""length1""length1""length1",
'length2'"length2""length2""length2""length2""length2"].
If the parameter 'result_type'"result_type""result_type""result_type""result_type""result_type" is set to the value
'score'"score""score""score""score""score", the fitting scores are returned. The score is the
number of measurements that is used for the calculation of the results
divided by the maximum number of measure regions.
List of values: 'param'"param""param""param""param""param", 'score'"score""score""score""score""score"
Default value: 'param'"param""param""param""param""param"
- 'scale'"scale""scale""scale""scale""scale":
-
The parameter determines the scaling or
unit of the results of the measurement. The parameter
'scale'"scale""scale""scale""scale""scale" must be specified as the ratio of the
desired unit to the original unit. Setting
the parameter 'scale'"scale""scale""scale""scale""scale" to a float value, the results are
scaled by this float value. For uncalibrated metrology objects the
original unit is a pixel. For calibrated metrology objects (see also
the parameters 'camera_param'"camera_param""camera_param""camera_param""camera_param""camera_param" and 'world_pose'"world_pose""world_pose""world_pose""world_pose""world_pose" of
the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParam), the original unit
is determined by the coordinates of the calibration metrology object.
If the original unit is the metric system (which is the case if you
use one of the standard calibration plates), the desired unit can be
set directly by selecting 'm'"m""m""m""m""m", 'cm'"cm""cm""cm""cm""cm", 'mm'"mm""mm""mm""mm""mm",
'microns'"microns""microns""microns""microns""microns", or 'um'"um""um""um""um""um".
List of values: 1.0, 0.1, 'm'"m""m""m""m""m",
'cm'"cm""cm""cm""cm""cm", 'mm'"mm""mm""mm""mm""mm", 'microns'"microns""microns""microns""microns""microns",
'um'"um""um""um""um""um"
Default value: 1.0
- 'angle_direction'"angle_direction""angle_direction""angle_direction""angle_direction""angle_direction":
-
The parameter determines the rotation
direction for angles that result from the fitting. Setting the
parameter 'angle_direction'"angle_direction""angle_direction""angle_direction""angle_direction""angle_direction" to 'positive'"positive""positive""positive""positive""positive" the angle is
specified between the main axis of the object and
the horizontal axis of the coordinate system in the mathematically
positive direction (counterclockwise). Setting the parameter
'angle_direction'"angle_direction""angle_direction""angle_direction""angle_direction""angle_direction" to 'negative'"negative""negative""negative""negative""negative" the angle is specified
between the main axis of the object and the horizontal axis
of the coordinate system in the mathematically negative direction
(clockwise). The results of the angles are returned in radians.
List of values: 'positive'"positive""positive""positive""positive""positive", 'negative'"negative""negative""negative""negative""negative"
Default value: 'positive'"positive""positive""positive""positive""positive"
It is possible to query the results of several metrology objects (see the
parameter IndicesIndicesIndicesIndicesIndicesindices) and several instances (see the parameter
InstanceInstanceInstanceInstanceInstanceinstance) of the metrology objects simulaneously. The results are
returned in the following order in ParameterParameterParameterParameterParameterparameter: 1st instance
of 1st metrology object, 2nd instance of 1st metrology object, etc., 1st
instance of 2nd metrology object, 2nd instance of 2nd metrology object,
etc.
A metrology model 'MetrologyHandle'"MetrologyHandle""MetrologyHandle""MetrologyHandle""MetrologyHandle""MetrologyHandle" cannot be shared between
two or more user's threads. Different metrology models can be used
independently and safely in different threads.
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Handle of the metrology model.
Indices of the metrology objects.
Default value: 0
Suggested values: 'all'"all""all""all""all""all", 0, 1, 2
Instance of the metrology object.
Default value:
'all'
"all"
"all"
"all"
"all"
"all"
Suggested values: 0, 1, 2, 'all'"all""all""all""all""all"
Names of the generic parameters.
Default value:
'result_type'
"result_type"
"result_type"
"result_type"
"result_type"
"result_type"
List of values: 'angle_direction'"angle_direction""angle_direction""angle_direction""angle_direction""angle_direction", 'result_type'"result_type""result_type""result_type""result_type""result_type", 'scale'"scale""scale""scale""scale""scale"
Values of the generic parameters.
Default value:
'param'
"param"
"param"
"param"
"param"
"param"
Suggested values: 'param'"param""param""param""param""param", 'score'"score""score""score""score""score", 1.0, 0.1, 'm'"m""m""m""m""m", 'mm'"mm""mm""mm""mm""mm", 'microns'"microns""microns""microns""microns""microns", 'um'"um""um""um""um""um", 'true'"true""true""true""true""true", 'false'"false""false""false""false""false"
If the parameters are valid, the operator
get_metrology_object_resultget_metrology_object_resultGetMetrologyObjectResultget_metrology_object_resultGetMetrologyObjectResultGetMetrologyObjectResult returns the value 2 (H_MSG_TRUE). If
necessary, an exception is raised.
apply_metrology_modelapply_metrology_modelApplyMetrologyModelapply_metrology_modelApplyMetrologyModelApplyMetrologyModel
clear_metrology_modelclear_metrology_modelClearMetrologyModelclear_metrology_modelClearMetrologyModelClearMetrologyModel
2D Metrology