get_metrology_object_num_instances — Get the number of instances of the metrology objects of a metrology model.
get_metrology_object_num_instances allows to access the number of instances (results) of measurements applied by apply_metrology_model 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_instances will typically be 1 as well. To allow more instances, before applying the measurement with apply_metrology_model you have to explicitly set the parameter 'num_instances' to a higher value or to 'all' using set_metrology_object_param.
For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.
The metrology model is defined by the handle MetrologyHandle. The parameter Index specifies for which metrology object the instances are queried. For Index set to 'all', the number of instances of all metrology objects are returned. The number of instances is returned in NumInstances for each metrology object that was passed in Index.
Handle of the metrology model.
Index of the metrology objects.
Default value: 0
Suggested values: 'all', 0, 1, 2
Number of Instances of the metrology objects.
If the parameters are valid, the operator get_metrology_object_num_instances returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.