add_metrology_object_line_measureT_add_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure (Operator)

Name

add_metrology_object_line_measureT_add_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure — Add a line to a metrology model.

Signature

add_metrology_object_line_measure( : : MetrologyHandle, RowBegin, ColumnBegin, RowEnd, ColumnEnd, MeasureLength1, MeasureLength2, MeasureSigma, MeasureThreshold, GenParamName, GenParamValue : Index)

Description

add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure adds a metrology object of type line to a metrology model and prepares the rectangular measure regions. The handle of the model is passed in MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle.

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

The geometric shape of the metrology object of type line is described by the coordinates of the start point (RowBeginRowBeginRowBeginrowBeginrow_begin, ColumnBeginColumnBeginColumnBegincolumnBegincolumn_begin) and the coordinates of the end point (RowEndRowEndRowEndrowEndrow_end, ColumnEndColumnEndColumnEndcolumnEndcolumn_end). The rectangular measure regions lie perpendicular to the line. The half edge lengths of the measure regions perpendicular and tangential to the line are set in MeasureLength1MeasureLength1MeasureLength1measureLength1measure_length_1 and MeasureLength2MeasureLength2MeasureLength2measureLength2measure_length_2. The centers of the measure regions lie on the line. The parameter MeasureSigmaMeasureSigmaMeasureSigmameasureSigmameasure_sigma specifies a standard deviation that is used by the operator apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelapply_metrology_model to smooth the gray values of the image. Salient edges can be selected with the parameter MeasureThresholdMeasureThresholdMeasureThresholdmeasureThresholdmeasure_threshold, which constitutes a threshold on the amplitude, i.e., the absolute value of the first derivative of the edge.

Furthermore, you can adjust some generic parameters within GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value. In particular, all generic parameters that are available in the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamset_metrology_object_param can be set. But note that for a lot of applications the default values are sufficient and no adjustment is necessary.

The operator add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure returns the index of the added metrology object in the parameter 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.

This operator modifies the state of the following input parameter:

MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle (input_control, state is modified) metrology_model → (handle)

Handle of the metrology model.

RowBeginRowBeginRowBeginrowBeginrow_begin (input_control) line.begin.y(-array) → (real / integer)

Row (or Y) coordinate of the start of the line.

ColumnBeginColumnBeginColumnBegincolumnBegincolumn_begin (input_control) line.begin.x(-array) → (real / integer)

Column (or X) coordinate of the start of the line.

RowEndRowEndRowEndrowEndrow_end (input_control) line.end.y(-array) → (real / integer)

Row (or Y) coordinate of the end of the line.

ColumnEndColumnEndColumnEndcolumnEndcolumn_end (input_control) line.end.x(-array) → (real / integer)

Column (or X) coordinate of the end of the line.

MeasureLength1MeasureLength1MeasureLength1measureLength1measure_length_1 (input_control) number → (real / integer)

Half length of the measure regions perpendicular to the boundary.

Default: 20.0

Suggested values: 10.0, 20.0, 30.0

Value range: 1.0 ≤ MeasureLength1 MeasureLength1 MeasureLength1 measureLength1 measure_length_1

Minimum increment: 1.0

Recommended increment: 10.0

MeasureLength2MeasureLength2MeasureLength2measureLength2measure_length_2 (input_control) number → (real / integer)

Half length of the measure regions tangential to the boundary.

Default: 5.0

Suggested values: 3.0, 5.0, 10.0

Value range: 1.0 ≤ MeasureLength2 MeasureLength2 MeasureLength2 measureLength2 measure_length_2

Minimum increment: 1.0

Recommended increment: 10.0

MeasureSigmaMeasureSigmaMeasureSigmameasureSigmameasure_sigma (input_control) number → (real / integer)

Sigma of the Gaussian function for the smoothing.

Default: 1.0

Suggested values: 0.4, 0.6, 0.8, 1.0, 1.5, 2.0, 3.0, 4.0, 5.0, 7.0, 10.0

Value range: 0.4 ≤ MeasureSigma MeasureSigma MeasureSigma measureSigma measure_sigma ≤ 100.0

Minimum increment: 0.01

Recommended increment: 0.1

MeasureThresholdMeasureThresholdMeasureThresholdmeasureThresholdmeasure_threshold (input_control) number → (real / integer)

Minimum edge amplitude.

Default: 30.0

Suggested values: 5.0, 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0, 90.0, 110.0

Value range: 1 ≤ MeasureThreshold MeasureThreshold MeasureThreshold measureThreshold measure_threshold ≤ 255 (lin)

Minimum increment: 0.5

Recommended increment: 2

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)

Names of the generic parameters.

Default: []

List of values: 'distance_threshold'"distance_threshold""distance_threshold""distance_threshold""distance_threshold", 'instances_outside_measure_regions'"instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions""instances_outside_measure_regions", 'max_num_iterations'"max_num_iterations""max_num_iterations""max_num_iterations""max_num_iterations", 'measure_distance'"measure_distance""measure_distance""measure_distance""measure_distance", 'measure_interpolation'"measure_interpolation""measure_interpolation""measure_interpolation""measure_interpolation", 'measure_select'"measure_select""measure_select""measure_select""measure_select", 'measure_transition'"measure_transition""measure_transition""measure_transition""measure_transition", 'min_score'"min_score""min_score""min_score""min_score", 'num_instances'"num_instances""num_instances""num_instances""num_instances", 'num_measures'"num_measures""num_measures""num_measures""num_measures", 'rand_seed'"rand_seed""rand_seed""rand_seed""rand_seed"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (real / integer / string)

Values of the generic parameters.

Default: []

Suggested values: 1, 2, 3, 4, 5, 10, 20, 'all'"all""all""all""all", 'true'"true""true""true""true", 'false'"false""false""false""false", 'first'"first""first""first""first", 'last'"last""last""last""last", 'positive'"positive""positive""positive""positive", 'negative'"negative""negative""negative""negative", 'uniform'"uniform""uniform""uniform""uniform", 'nearest_neighbor'"nearest_neighbor""nearest_neighbor""nearest_neighbor""nearest_neighbor", 'bilinear'"bilinear""bilinear""bilinear""bilinear", 'bicubic'"bicubic""bicubic""bicubic""bicubic"

IndexIndexIndexindexindex (output_control) integer → (integer)

Index of the created metrology object.

Result

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