get_metrology_object_num_instancesT_get_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instances (Operator)
Name
get_metrology_object_num_instancesT_get_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instances — Get the number of instances of the metrology objects of a metrology model.
Signature
def get_metrology_object_num_instances(metrology_handle: HHandle, index: MaybeSequence[Union[int, str]]) -> Sequence[Union[int, float]]
def get_metrology_object_num_instances_s(metrology_handle: HHandle, index: MaybeSequence[Union[int, str]]) -> Union[int, float]
Description
get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instances allows to access the number of
instances (results) of measurements applied by apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_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_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instances will typically be
1 as well. To allow more instances, before applying the measurement
with apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model 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_paramSetMetrologyObjectParamSetMetrologyObjectParamset_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 MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle. 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 NumInstancesNumInstancesNumInstancesnumInstancesnum_instances 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
MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (input_control) metrology_model → HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the metrology model.
IndexIndexIndexindexindex (input_control) integer(-array) → HTupleMaybeSequence[Union[int, str]]HTupleHtuple (integer / string) (int / long / string) (Hlong / HString) (Hlong / char*)
Index of the metrology objects.
Default:
0
Suggested values:
'all'"all""all""all""all", 0, 1, 2
NumInstancesNumInstancesNumInstancesnumInstancesnum_instances (output_control) integer(-array) → HTupleSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Number of Instances of the metrology objects.
Result
If the parameters are valid, the operator
get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instances returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Possible Predecessors
apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model
Possible Successors
clear_metrology_modelclear_metrology_modelClearMetrologyModelClearMetrologyModelclear_metrology_model
See also
get_metrology_object_indicesget_metrology_object_indicesGetMetrologyObjectIndicesGetMetrologyObjectIndicesget_metrology_object_indices
Module
2D Metrology