get_metrology_object_paramT_get_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_param (Operator)
Name
get_metrology_object_paramT_get_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_param — Get one or several parameters of a metrology model.
Signature
Description
get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_param allows to access the parameters
that are used by a metrology object.
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 parameter IndexIndexIndexIndexindexindex
determines for which metrology objects the information is accessed.
With IndexIndexIndexIndexindexindex set to 'all'"all""all""all""all""all", the parameters of all
metrology objects are accessed. The names of the desired parameters
are passed in the generic parameter GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name, the
corresponding values are returned in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value in the
same order. All these general parameters can be set and changed at
any time with the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param.
Parameters that describe the geometry of an object can only be set by
creating the metrology object with the operators
add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure,
add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure,
add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure, or
add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure.
The following parameters can be accessed:
-
Valid for all types of metrology objects:
- 'min_score'"min_score""min_score""min_score""min_score""min_score", 'num_instances'"num_instances""num_instances""num_instances""num_instances""num_instances",
'instances_outside_measure_regions'"instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions":
-
The meaning and the use of these parameters is described with the
operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param.
- 'rand_seed'"rand_seed""rand_seed""rand_seed""rand_seed""rand_seed", 'distance_threshold'"distance_threshold""distance_threshold""distance_threshold""distance_threshold""distance_threshold",
'max_num_iterations'"max_num_iterations""max_num_iterations""max_num_iterations""max_num_iterations""max_num_iterations":
-
The meaning and the use of these parameters is described with the
operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param.
- 'measure_length1'"measure_length1""measure_length1""measure_length1""measure_length1""measure_length1", 'measure_length2'"measure_length2""measure_length2""measure_length2""measure_length2""measure_length2":
-
The meaning and the use of these parameters is described with the
operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param.
- 'measure_sigma'"measure_sigma""measure_sigma""measure_sigma""measure_sigma""measure_sigma", 'measure_threshold'"measure_threshold""measure_threshold""measure_threshold""measure_threshold""measure_threshold",
'measure_transition'"measure_transition""measure_transition""measure_transition""measure_transition""measure_transition", 'measure_select'"measure_select""measure_select""measure_select""measure_select""measure_select":
-
The meaning and the use of these parameters is described with
the operator measure_posmeasure_posMeasurePosMeasurePosMeasurePosmeasure_pos by the parameters SigmaSigmaSigmaSigmasigmasigma,
ThresholdThresholdThresholdThresholdthresholdthreshold, TransitionTransitionTransitionTransitiontransitiontransition, and SelectSelectSelectSelectselectselect.
- 'measure_interpolation'"measure_interpolation""measure_interpolation""measure_interpolation""measure_interpolation""measure_interpolation":
-
The meaning and the use of this parameter is described with the
operator gen_measure_rectangle2gen_measure_rectangle2GenMeasureRectangle2GenMeasureRectangle2GenMeasureRectangle2gen_measure_rectangle2 by the parameter
InterpolationInterpolationInterpolationInterpolationinterpolationinterpolation.
- 'measure_distance_min'"measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min":
-
Returns the minimum distance between the centers of the generated
measure regions, which depends on the geometry of the object and
the value of the input parameter 'measure_distance'"measure_distance""measure_distance""measure_distance""measure_distance""measure_distance" or
the value of the input parameter 'num_measures'"num_measures""num_measures""num_measures""num_measures""num_measures" of the
operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param. For
a metrology object circle or a metrology object line the
distances between measure regions are uniformly distributed.
Therefore, 'measure_distance_min'"measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min" and
'measure_distance_max'"measure_distance_max""measure_distance_max""measure_distance_max""measure_distance_max""measure_distance_max" return the same value.
- 'measure_distance_max'"measure_distance_max""measure_distance_max""measure_distance_max""measure_distance_max""measure_distance_max":
-
Returns the maximum distance between the centers of the generated
measure regions, which depends on the geometry of the object and
the value of the input parameter 'measure_distance'"measure_distance""measure_distance""measure_distance""measure_distance""measure_distance" or
the value of the input parameter 'num_measures'"num_measures""num_measures""num_measures""num_measures""num_measures" of the
operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param. For
a metrology object circle or a metrology object line the distances
between measure regions are uniformly distributed. Therefore,
'measure_distance_min'"measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min" and 'measure_distance_max'"measure_distance_max""measure_distance_max""measure_distance_max""measure_distance_max""measure_distance_max"
return the same value.
- 'num_measures'"num_measures""num_measures""num_measures""num_measures""num_measures":
-
Returns the number of generated measure regions, which depends
on the geometry of the object and the value of the input parameter
'measure_distance'"measure_distance""measure_distance""measure_distance""measure_distance""measure_distance" or the value of the input parameter
'num_measures'"num_measures""num_measures""num_measures""num_measures""num_measures" of the operator
set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param.
- 'object_type'"object_type""object_type""object_type""object_type""object_type":
-
Type of the geometric shape of
the metrology object.
For a metrology object of type circle, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the value 'circle'"circle""circle""circle""circle""circle".
For a metrology object of type ellipse, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the value 'ellipse'"ellipse""ellipse""ellipse""ellipse""ellipse".
For a metrology object of type line, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the value 'line'"line""line""line""line""line".
For a metrology object of type rectangle, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the value 'rectangle'"rectangle""rectangle""rectangle""rectangle""rectangle".
- 'object_params'"object_params""object_params""object_params""object_params""object_params":
-
The parameters of the geometric
shape of the metrology object.
For a metrology object of type circle, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the geometry of the circle in
the following order: 'row'"row""row""row""row""row", 'column'"column""column""column""column""column",
'radius'"radius""radius""radius""radius""radius". The meaning and the use of these
parameters is described with the operator
add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure.
For a metrology object of type ellipse, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the geometry of the ellipse in
the following order: '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". The
meaning and the use of these parameters is described with the
operator add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure.
For a metrology object of type line, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the geometry of the line in the
following order: 'row_begin'"row_begin""row_begin""row_begin""row_begin""row_begin", 'column_begin'"column_begin""column_begin""column_begin""column_begin""column_begin",
'row_end'"row_end""row_end""row_end""row_end""row_end", 'column_end'"column_end""column_end""column_end""column_end""column_end". The meaning and the
use of these parameters is described with the operator
add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure.
For a metrology object of type rectangle, the output parameter
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value contains the geometry of the rectangle in
the following order: '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". The
meaning and the use of these parameters is described with the
operator add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure.
-
Only valid for a metrology object of type circle:
- 'row'"row""row""row""row""row", 'column'"column""column""column""column""column", 'radius'"radius""radius""radius""radius""radius":
-
These are parameters for a metrology object of type circle.
The meaning and the use of these parameters is described with the
operator add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure.
-
Only valid for a metrology object of type ellipse:
- '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":
-
These are parameters
for a metrology object of type ellipse. The meaning and the use
of these parameters is described with the operator
add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure.
-
Only valid for a metrology object of type line:
- 'row_begin'"row_begin""row_begin""row_begin""row_begin""row_begin", 'column_begin'"column_begin""column_begin""column_begin""column_begin""column_begin",
'row_end'"row_end""row_end""row_end""row_end""row_end", 'column_end'"column_end""column_end""column_end""column_end""column_end":
-
These are parameters
for a metrology object of type line. The meaning and the use
of these parameters is described with the operator
add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure.
-
Only valid for a metrology object of type rectangle:
- '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":
-
These are
parameters for a metrology object of type rectangle. The meaning
and the use of these parameters is described with the
operator add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure.
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.
IndexIndexIndexIndexindexindex (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"
"all"
Suggested values:
'all'"all""all""all""all""all", 0, 1, 2
GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Names of the generic parameters.
Default:
'num_measures'
"num_measures"
"num_measures"
"num_measures"
"num_measures"
"num_measures"
List of values:
'column'"column""column""column""column""column", 'column_begin'"column_begin""column_begin""column_begin""column_begin""column_begin", 'column_end'"column_end""column_end""column_end""column_end""column_end", 'distance_threshold'"distance_threshold""distance_threshold""distance_threshold""distance_threshold""distance_threshold", 'end_phi'"end_phi""end_phi""end_phi""end_phi""end_phi", 'instances_outside_measure_regions'"instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions", 'length1'"length1""length1""length1""length1""length1", 'length2'"length2""length2""length2""length2""length2", 'max_num_iterations'"max_num_iterations""max_num_iterations""max_num_iterations""max_num_iterations""max_num_iterations", 'measure_distance_min'"measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min", 'measure_distance_min'"measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min", 'measure_interpolation'"measure_interpolation""measure_interpolation""measure_interpolation""measure_interpolation""measure_interpolation", 'measure_length1'"measure_length1""measure_length1""measure_length1""measure_length1""measure_length1", 'measure_length2'"measure_length2""measure_length2""measure_length2""measure_length2""measure_length2", 'measure_select'"measure_select""measure_select""measure_select""measure_select""measure_select", 'measure_sigma'"measure_sigma""measure_sigma""measure_sigma""measure_sigma""measure_sigma", 'measure_threshold'"measure_threshold""measure_threshold""measure_threshold""measure_threshold""measure_threshold", 'measure_transition'"measure_transition""measure_transition""measure_transition""measure_transition""measure_transition", 'min_score'"min_score""min_score""min_score""min_score""min_score", 'num_instances'"num_instances""num_instances""num_instances""num_instances""num_instances", 'num_measures'"num_measures""num_measures""num_measures""num_measures""num_measures", 'object_params'"object_params""object_params""object_params""object_params""object_params", 'object_type'"object_type""object_type""object_type""object_type""object_type", 'phi'"phi""phi""phi""phi""phi", 'point_order'"point_order""point_order""point_order""point_order""point_order", 'radius'"radius""radius""radius""radius""radius", 'radius1'"radius1""radius1""radius1""radius1""radius1", 'radius2'"radius2""radius2""radius2""radius2""radius2", 'rand_seed'"rand_seed""rand_seed""rand_seed""rand_seed""rand_seed", 'row'"row""row""row""row""row", 'row_begin'"row_begin""row_begin""row_begin""row_begin""row_begin", 'row_end'"row_end""row_end""row_end""row_end""row_end", 'start_phi'"start_phi""start_phi""start_phi""start_phi""start_phi", 'x'"x""x""x""x""x", 'x_begin'"x_begin""x_begin""x_begin""x_begin""x_begin", 'x_end'"x_end""x_end""x_end""x_end""x_end", 'y'"y""y""y""y""y", 'y_begin'"y_begin""y_begin""y_begin""y_begin""y_begin", 'y_end'"y_end""y_end""y_end""y_end""y_end"
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)
Values of the generic parameters.
Result
If the parameters are valid, the operator
get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParamGetMetrologyObjectParamget_metrology_object_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_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param
Possible Successors
set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param
See also
get_metrology_object_fuzzy_paramget_metrology_object_fuzzy_paramGetMetrologyObjectFuzzyParamGetMetrologyObjectFuzzyParamGetMetrologyObjectFuzzyParamget_metrology_object_fuzzy_param,
get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instances
Module
2D Metrology