add_metrology_object_ellipse_measureT_add_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure (Operator)

Name

add_metrology_object_ellipse_measureT_add_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure — Add an ellipse or an elliptic arc to a metrology model.

Signature

add_metrology_object_ellipse_measure( : : MetrologyHandle, Row, Column, Phi, Radius1, Radius2, MeasureLength1, MeasureLength2, MeasureSigma, MeasureThreshold, GenParamName, GenParamValue : Index)

Description

add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure adds a metrology object of type ellipse or elliptic arc to a metrology model and prepares the rectangular measure regions. The handle of the model is passed in MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle.

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 ellipse is specified by its center (RowRowRowRowrow, ColumnColumnColumnColumncolumn), the orientation of the main axis PhiPhiPhiPhiphi, the length of the larger half axis Radius1Radius1Radius1Radius1radius1, and the length of the smaller half axis Radius2Radius2Radius2Radius2radius2. The input value for PhiPhiPhiPhiphi is mapped automatically to the interval . The rectangular measure regions lie perpendicular to the boundary of the ellipse. The half edge lengths of the measure regions perpendicular and tangential to the boundary of the ellipse are set in MeasureLength1MeasureLength1MeasureLength1MeasureLength1measureLength1 and MeasureLength2MeasureLength2MeasureLength2MeasureLength2measureLength2. The centers of the measure regions lie on the boundary of the geometric shape. The parameter MeasureSigmaMeasureSigmaMeasureSigmaMeasureSigmameasureSigma specifies the standard deviation that is used by the operator apply_metrology_modelapply_metrology_modelApplyMetrologyModelApplyMetrologyModelApplyMetrologyModel to smooth the gray values of the image. Salient edges can be selected with the parameter MeasureThresholdMeasureThresholdMeasureThresholdMeasureThresholdmeasureThreshold, which constitutes a threshold on the amplitude, i.e., the absolute value of the first derivative of the edge. The operator add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure returns the index of the added metrology object in the parameter IndexIndexIndexIndexindex.

Furthermore, you can adjust some generic parameters within GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. The following values for GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue are available:

'start_phi'"start_phi""start_phi""start_phi""start_phi":

The parameter specifies the angle at the start point of an elliptic arc. The angle at the start point is measured relative to the positive main axis specified with PhiPhiPhiPhiphi and corresponds to the smallest surrounding circle of the ellipse. The actual start point of the ellipse is the intersection of the ellipse with the orthogonal projection of the corresponding circle point onto the main axis. The angle refers to the coordinate system of the ellipse, i.e., it is specified relative to the main axis and in a mathematical positive direction. Thus, the two main poles correspond to the angles 0 and , the two minor poles to the angle and . To create a closed ellipse the value of the parameter 'start_phi'"start_phi""start_phi""start_phi""start_phi" is set to 0 and the value of the parameter 'end_phi'"end_phi""end_phi""end_phi""end_phi" is set to (with positive point order). The input value is mapped internally automatically to the interval .

List of values: 0.0, 0.78, 6.28318

Default value: 0.0

'end_phi'"end_phi""end_phi""end_phi""end_phi":

The parameter specifies the angle at the end point of an elliptic arc. The angle at the end point are measured relative to the positive main axis specified with PhiPhiPhiPhiphi and corresponds to the smallest surrounding circle of the ellipse. The actual end point of the ellipse is the intersection of the ellipse with the orthogonal projection of the corresponding circle point onto the main axis. The angle refers to the coordinate system of the ellipse, i.e., it is specified relative to the main axis and in a mathematical positive direction. Thus, the two main poles correspond to the angles 0 and , the two minor poles to the angle and . To create a closed ellipse the value of the parameter 'start_phi'"start_phi""start_phi""start_phi""start_phi" is set to 0 and the value of the parameter 'end_phi'"end_phi""end_phi""end_phi""end_phi" is set to (with positive point order). The input value is mapped automatically to the interval .

List of values: 0.0, 0.78, 6.28318

Default value: 6.28318

'point_order'"point_order""point_order""point_order""point_order":

The parameter specifies the direction of the elliptic arc. For the value 'positive'"positive""positive""positive""positive", the elliptic arc is defined between 'start_phi'"start_phi""start_phi""start_phi""start_phi" and 'end_phi'"end_phi""end_phi""end_phi""end_phi" in mathematically positive direction (counterclockwise). For the value 'negative'"negative""negative""negative""negative", the elliptic arc is defined between 'start_phi'"start_phi""start_phi""start_phi""start_phi" and 'end_phi'"end_phi""end_phi""end_phi""end_phi" in mathematically negative direction (clockwise).

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

Default value: 'positive'"positive""positive""positive""positive"

Additionally, all generic parameters that are available for the operator set_metrology_object_paramset_metrology_object_paramSetMetrologyObjectParamSetMetrologyObjectParamSetMetrologyObjectParam can be set. But note that for a lot of applications the default values are sufficient and no adjustment is necessary.

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:

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

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

Handle of the metrology model.

RowRowRowRowrow (input_control) ellipse.center.y(-array) → (real / integer)

Row (or Y) coordinate of the center of the ellipse.

ColumnColumnColumnColumncolumn (input_control) ellipse.center.x(-array) → (real / integer)

Column (or X) coordinate of the center of the ellipse.

PhiPhiPhiPhiphi (input_control) ellipse.angle.rad(-array) → (real / integer)

Orientation of the main axis [rad].

Radius1Radius1Radius1Radius1radius1 (input_control) ellipse.radius1(-array) → (real / integer)

Length of the larger half axis.

Radius2Radius2Radius2Radius2radius2 (input_control) ellipse.radius2(-array) → (real / integer)

Length of the smaller half axis.

MeasureLength1MeasureLength1MeasureLength1MeasureLength1measureLength1 (input_control) number → (real / integer)

Half length of the measure regions perpendicular to the boundary.

Default value: 20.0

Suggested values: 10.0, 20.0, 30.0

Typical range of values: 1.0 ≤ MeasureLength1 MeasureLength1 MeasureLength1 MeasureLength1 measureLength1

Minimum increment: 1.0

Recommended increment: 10.0

Restriction: MeasureLength1 < Radius1 && MeasureLength1 < Radius2

MeasureLength2MeasureLength2MeasureLength2MeasureLength2measureLength2 (input_control) number → (real / integer)

Half length of the measure regions tangetial to the boundary.

Default value: 5.0

Suggested values: 3.0, 5.0, 10.0

Typical range of values: 1.0 ≤ MeasureLength2 MeasureLength2 MeasureLength2 MeasureLength2 measureLength2

Minimum increment: 1.0

Recommended increment: 10.0

MeasureSigmaMeasureSigmaMeasureSigmaMeasureSigmameasureSigma (input_control) number → (real / integer)

Sigma of the Gaussian function for the smoothing.

Default value: 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

Typical range of values: 0.4 ≤ MeasureSigma MeasureSigma MeasureSigma MeasureSigma measureSigma

Minimum increment: 0.01

Recommended increment: 0.1

Restriction: 0.4 <= MeasureSigma && MeasureSigma <= 100

MeasureThresholdMeasureThresholdMeasureThresholdMeasureThresholdmeasureThreshold (input_control) number → (real / integer)

Minimum edge amplitude.

Default value: 30.0

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

Typical range of values: 1 ≤ MeasureThreshold MeasureThreshold MeasureThreshold MeasureThreshold measureThreshold ≤ 255 (lin)

Minimum increment: 0.5

Recommended increment: 2

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

Names of the generic parameters.

Default value: []

List of values: 'distance_threshold'"distance_threshold""distance_threshold""distance_threshold""distance_threshold", '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", '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", 'point_order'"point_order""point_order""point_order""point_order", 'rand_seed'"rand_seed""rand_seed""rand_seed""rand_seed", 'start_phi'"start_phi""start_phi""start_phi""start_phi"

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

Values of the generic parameters.

Default value: []

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_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.