ClassesClassesClassesClasses | | | | Operators

get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParam (Operator)

Name

get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParam — Get one or several parameters of a metroloy model.

Signature

get_metrology_object_param( : : MetrologyHandle, Index, GenParamName : GenParamValue)

Herror get_metrology_object_param(const Hlong MetrologyHandle, const char* Index, const char* GenParamName, char* GenParamValue)

Herror T_get_metrology_object_param(const Htuple MetrologyHandle, const Htuple Index, const Htuple GenParamName, Htuple* GenParamValue)

Herror get_metrology_object_param(const HTuple& MetrologyHandle, const HTuple& Index, const HTuple& GenParamName, char* GenParamValue)

Herror get_metrology_object_param(const HTuple& MetrologyHandle, const HTuple& Index, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HMetrologyModel::GetMetrologyObjectParam(const HTuple& Index, const HTuple& GenParamName) const

void GetMetrologyObjectParam(const HTuple& MetrologyHandle, const HTuple& Index, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HMetrologyModel::GetMetrologyObjectParam(const HTuple& Index, const HTuple& GenParamName) const

HTuple HMetrologyModel::GetMetrologyObjectParam(const HString& Index, const HString& GenParamName) const

HTuple HMetrologyModel::GetMetrologyObjectParam(const char* Index, const char* GenParamName) const

void HOperatorSetX.GetMetrologyObjectParam(
[in] VARIANT MetrologyHandle, [in] VARIANT Index, [in] VARIANT GenParamName, [out] VARIANT* GenParamValue)

VARIANT HMetrologyModelX.GetMetrologyObjectParam(
[in] VARIANT Index, [in] VARIANT GenParamName)

static void HOperatorSet.GetMetrologyObjectParam(HTuple metrologyHandle, HTuple index, HTuple genParamName, out HTuple genParamValue)

HTuple HMetrologyModel.GetMetrologyObjectParam(HTuple index, HTuple genParamName)

HTuple HMetrologyModel.GetMetrologyObjectParam(string index, string genParamName)

Description

get_metrology_object_paramget_metrology_object_paramGetMetrologyObjectParamget_metrology_object_paramGetMetrologyObjectParamGetMetrologyObjectParam allows to access the parameters that are used by a metrology object (see create_metrology_modelcreate_metrology_modelCreateMetrologyModelcreate_metrology_modelCreateMetrologyModelCreateMetrologyModel for the basic principle of 2D metrology). The metrology model is defined by the handle MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle. The parameter IndexIndexIndexIndexIndexindex determines for which metrology objects the information is accessed. With IndexIndexIndexIndexIndexindex set to 'all'"all""all""all""all""all", the parameters of all metrology objects are accessed. The names of the desired parameters are passed in the generic parameter GenParamNameGenParamNameGenParamNameGenParamNameGenParamNamegenParamName, the corresponding values are returned in GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue in the same order. All these general parameters can be set and changed at any time with the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParam. Parameters that describe the geometry of an object can only be set by creating the metrology object with the operators add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasure, add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure, add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasure, or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measure.

The following parameters can be accessed:

Parallelization

Parameters

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control)  metrology_model HMetrologyModel, HTupleHTupleHMetrologyModel, HTupleHMetrologyModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the metrology model.

IndexIndexIndexIndexIndexindex (input_control)  integer(-array) HTupleHTupleHTupleVARIANTHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong) (BSTR / Hlong) (char* / Hlong)

Index of the metrology objects.

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

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

GenParamNameGenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control)  attribute.name(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Names of the generic parameters.

Default value: 'num_measures' "num_measures" "num_measures" "num_measures" "num_measures" "num_measures"

List of values: 'column'"column""column""column""column""column", 'column_begin'"column_begin""column_begin""column_begin""column_begin""column_begin", 'column_end'"column_end""column_end""column_end""column_end""column_end", 'distance_threshold'"distance_threshold""distance_threshold""distance_threshold""distance_threshold""distance_threshold", 'end_phi'"end_phi""end_phi""end_phi""end_phi""end_phi", 'instances_outside_measure_regions'"instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions", 'length1'"length1""length1""length1""length1""length1", 'length2'"length2""length2""length2""length2""length2", 'max_num_iterations'"max_num_iterations""max_num_iterations""max_num_iterations""max_num_iterations""max_num_iterations", 'measure_distance_min'"measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min", 'measure_distance_min'"measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min""measure_distance_min", 'measure_interpolation'"measure_interpolation""measure_interpolation""measure_interpolation""measure_interpolation""measure_interpolation", 'measure_length1'"measure_length1""measure_length1""measure_length1""measure_length1""measure_length1", 'measure_length2'"measure_length2""measure_length2""measure_length2""measure_length2""measure_length2", 'measure_select'"measure_select""measure_select""measure_select""measure_select""measure_select", 'measure_sigma'"measure_sigma""measure_sigma""measure_sigma""measure_sigma""measure_sigma", 'measure_threshold'"measure_threshold""measure_threshold""measure_threshold""measure_threshold""measure_threshold", 'measure_transition'"measure_transition""measure_transition""measure_transition""measure_transition""measure_transition", 'min_score'"min_score""min_score""min_score""min_score""min_score", 'num_instances'"num_instances""num_instances""num_instances""num_instances""num_instances", 'num_measures'"num_measures""num_measures""num_measures""num_measures""num_measures", 'object_params'"object_params""object_params""object_params""object_params""object_params", 'object_type'"object_type""object_type""object_type""object_type""object_type", 'phi'"phi""phi""phi""phi""phi", 'point_order'"point_order""point_order""point_order""point_order""point_order", 'radius'"radius""radius""radius""radius""radius", 'radius1'"radius1""radius1""radius1""radius1""radius1", 'radius2'"radius2""radius2""radius2""radius2""radius2", 'rand_seed'"rand_seed""rand_seed""rand_seed""rand_seed""rand_seed", 'row'"row""row""row""row""row", 'row_begin'"row_begin""row_begin""row_begin""row_begin""row_begin", 'row_end'"row_end""row_end""row_end""row_end""row_end", 'start_phi'"start_phi""start_phi""start_phi""start_phi""start_phi", 'x'"x""x""x""x""x", 'x_begin'"x_begin""x_begin""x_begin""x_begin""x_begin", 'x_end'"x_end""x_end""x_end""x_end""x_end", 'y'"y""y""y""y""y", 'y_begin'"y_begin""y_begin""y_begin""y_begin""y_begin", 'y_end'"y_end""y_end""y_end""y_end""y_end"

GenParamValueGenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (output_control)  attribute.value(-array) HTupleHTupleHTupleVARIANTHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong) (BSTR / double / Hlong) (char* / double / Hlong)

Values of the generic parameters.

Result

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

Possible Predecessors

get_metrology_object_indicesget_metrology_object_indicesGetMetrologyObjectIndicesget_metrology_object_indicesGetMetrologyObjectIndicesGetMetrologyObjectIndices, set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParam

Possible Successors

set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParam

See also

get_metrology_object_fuzzy_paramget_metrology_object_fuzzy_paramGetMetrologyObjectFuzzyParamget_metrology_object_fuzzy_paramGetMetrologyObjectFuzzyParamGetMetrologyObjectFuzzyParam, get_metrology_object_num_instancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesget_metrology_object_num_instancesGetMetrologyObjectNumInstancesGetMetrologyObjectNumInstances

Module

2D Metrology


ClassesClassesClassesClasses | | | | Operators