get_metrology_object_num_instancesT_get_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstances (Operator)

Name

get_metrology_object_num_instancesT_get_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstances — Get the number of instances of the metrology objects of a metrology model.

Signature

get_metrology_object_num_instances( : : MetrologyHandle, Index : NumInstances)

Description

get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstances allows to access the number of instances (results) of measurements applied by apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelApplyMetrologyModel for the metrology objects. Note that by default, the maximum number of instances of each metrology object is set to 1. Thus, by default, the result of get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstances will typically be 1 as well. To allow more instances, before applying the measurement with apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelApplyMetrologyModel you have to explicitly set the parameter 'num_instances'"num_instances""num_instances""num_instances""num_instances" to a higher value or to 'all'"all""all""all""all" using set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParam.

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 parameter IndexIndexIndexIndexindex specifies for which metrology object the instances are queried. For IndexIndexIndexIndexindex set to 'all'"all""all""all""all", the number of instances of all metrology objects are returned. The number of instances is returned in NumInstancesNumInstancesNumInstancesNumInstancesnumInstances for each metrology object that was passed in IndexIndexIndexIndexindex.

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

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control) metrology_model → (handle)

Handle of the metrology model.

IndexIndexIndexIndexindex (input_control) integer(-array) → (integer / string)

Index of the metrology objects.

Default value: 0

Suggested values: 'all'"all""all""all""all", 0, 1, 2

NumInstancesNumInstancesNumInstancesNumInstancesnumInstances (output_control) integer(-array) → (real / integer)

Number of Instances of the metrology objects.

Result

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