Skip to content

get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstancesget_metrology_object_num_instancesT_get_metrology_object_num_instances🔗

Short description🔗

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

Signature🔗

get_metrology_object_num_instances( metrology_model MetrologyHandle, integer Index, out integer NumInstances )get_metrology_object_num_instances( : : MetrologyHandle, Index : NumInstances )void GetMetrologyObjectNumInstances( const HTuple& MetrologyHandle, const HTuple& Index, HTuple* NumInstances )static void HOperatorSet.GetMetrologyObjectNumInstances( HTuple metrologyHandle, HTuple index, out HTuple numInstances )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]Herror T_get_metrology_object_num_instances( const Htuple MetrologyHandle, const Htuple Index, Htuple* NumInstances )

HTuple HMetrologyModel::GetMetrologyObjectNumInstances( const HTuple& Index ) const

double HMetrologyModel::GetMetrologyObjectNumInstances( Hlong Index ) const

HTuple HMetrologyModel.GetMetrologyObjectNumInstances( HTuple index )

double HMetrologyModel.GetMetrologyObjectNumInstances( int index )

Description🔗

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

For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.

The metrology model is defined by the handle MetrologyHandlemetrologyHandlemetrology_handle. The parameter Indexindexindex specifies for which metrology object the instances are queried. For Indexindexindex set to 'all'"all", the number of instances of all metrology objects are returned. The number of instances is returned in NumInstancesnumInstancesnum_instances for each metrology object that was passed in Indexindexindex.

Execution information🔗

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🔗

MetrologyHandlemetrologyHandlemetrology_handle (input_control) metrology_model → (handle)(handle)HTuple (HHandle)HMetrologyModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the metrology model.

Indexindexindex (input_control) integer(-array) → (integer / string)(integer / string)HTuple (Hlong / HString)HTuple (int / long / string)MaybeSequence[Union[int, str]]Htuple (Hlong / char*)

Index of the metrology objects.

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

NumInstancesnumInstancesnum_instances (output_control) integer(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)Sequence[Union[int, float]]Htuple (double / Hlong)

Number of Instances of the metrology objects.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

apply_metrology_modelApplyMetrologyModel

Possible successors

clear_metrology_modelClearMetrologyModel

See also

get_metrology_object_indicesGetMetrologyObjectIndices

Module🔗

2D Metrology