Operator Reference

get_metrology_object_measuresT_get_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresget_metrology_object_measures (Operator)

get_metrology_object_measuresT_get_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresget_metrology_object_measures — Get the measure regions and the results of the edge location for the metrology objects of a metrology model.

Signature

get_metrology_object_measures( : Contours : MetrologyHandle, Index, Transition : Row, Column)

Herror T_get_metrology_object_measures(Hobject* Contours, const Htuple MetrologyHandle, const Htuple Index, const Htuple Transition, Htuple* Row, Htuple* Column)

void GetMetrologyObjectMeasures(HObject* Contours, const HTuple& MetrologyHandle, const HTuple& Index, const HTuple& Transition, HTuple* Row, HTuple* Column)

HXLDCont HMetrologyModel::GetMetrologyObjectMeasures(const HTuple& Index, const HString& Transition, HTuple* Row, HTuple* Column) const

HXLDCont HMetrologyModel::GetMetrologyObjectMeasures(const HString& Index, const HString& Transition, HTuple* Row, HTuple* Column) const

HXLDCont HMetrologyModel::GetMetrologyObjectMeasures(const char* Index, const char* Transition, HTuple* Row, HTuple* Column) const

HXLDCont HMetrologyModel::GetMetrologyObjectMeasures(const wchar_t* Index, const wchar_t* Transition, HTuple* Row, HTuple* Column) const   ( Windows only)

static void HOperatorSet.GetMetrologyObjectMeasures(out HObject contours, HTuple metrologyHandle, HTuple index, HTuple transition, out HTuple row, out HTuple column)

HXLDCont HMetrologyModel.GetMetrologyObjectMeasures(HTuple index, string transition, out HTuple row, out HTuple column)

HXLDCont HMetrologyModel.GetMetrologyObjectMeasures(string index, string transition, out HTuple row, out HTuple column)

def get_metrology_object_measures(metrology_handle: HHandle, index: MaybeSequence[Union[str, int]], transition: str) -> Tuple[HObject, Sequence[float], Sequence[float]]

Description

get_metrology_object_measuresget_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresget_metrology_object_measures allows to access the measure regions of the metrology objects that were created with add_metrology_object_genericadd_metrology_object_genericAddMetrologyObjectGenericAddMetrologyObjectGenericadd_metrology_object_generic, add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure, etc. as XLD contours and the results of the edge location in image coordinates that was performed by apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model.

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 determines for which metrology objects the information is accessed. With IndexIndexIndexindexindex set to 'all'"all""all""all""all", the measure regions and the results of the edge location for all metrology objects are accessed.

If positive and negative edges are available in the measure regions (see the generic parameter value 'measure_transition'"measure_transition""measure_transition""measure_transition""measure_transition" of the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param), with the parameter TransitionTransitionTransitiontransitiontransition the desired edges (positive or negative) can be selected. If TransitionTransitionTransitiontransitiontransition is set to 'positive'"positive""positive""positive""positive", only positive edges are returned. If TransitionTransitionTransitiontransitiontransition is set to 'negative'"negative""negative""negative""negative", only negative edges are returned. All edges are returned if the parameter TransitionTransitionTransitiontransitiontransition is set to 'all'"all""all""all""all".

The operator get_metrology_object_measuresget_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresget_metrology_object_measures returns for each measure region one rectangular XLD contour with the boundary of the measure region in the parameter ContoursContoursContourscontourscontours. After calling apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model, additionally the image coordinates of the results of the edge location are returned as single points in the parameters RowRowRowrowrow and ColumnColumnColumncolumncolumn. Note that the order for the values of these points is not defined. Furthermore, there is no possibility to assign the results of the edge location to specific measure regions. If get_metrology_object_measuresget_metrology_object_measuresGetMetrologyObjectMeasuresGetMetrologyObjectMeasuresget_metrology_object_measures is called before apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model, the parameters RowRowRowrowrow and ColumnColumnColumncolumncolumn remain empty.

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

ContoursContoursContourscontourscontours (output_object)  xld_cont-array objectHXLDContHObjectHObjectHobject *

Rectangular XLD Contours of measure regions.

MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (input_control)  metrology_model HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the metrology model.

IndexIndexIndexindexindex (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"

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

TransitionTransitionTransitiontransitiontransition (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Select light/dark or dark/light edges.

Default: 'all' "all" "all" "all" "all"

List of values: 'all'"all""all""all""all", 'negative'"negative""negative""negative""negative", 'positive'"positive""positive""positive""positive"

RowRowRowrowrow (output_control)  point.y-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Row coordinates of the measured edges.

ColumnColumnColumncolumncolumn (output_control)  point.x-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Column coordinates of the measured edges.

Result

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

Possible Predecessors

apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model

See also

add_metrology_object_genericadd_metrology_object_genericAddMetrologyObjectGenericAddMetrologyObjectGenericadd_metrology_object_generic, add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure, add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure, add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure, add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure

Module

2D Metrology