add_metrology_object_generic — Add a metrology object to a metrology model.
add_metrology_object_generic( : : MetrologyHandle, Shape, ShapeParam, MeasureLength1, MeasureLength2, MeasureSigma, MeasureThreshold, GenParamName, GenParamValue : Index)
add_metrology_object_generic adds a metrology object
of type Shape to a metrology model and prepares the
rectangular measure regions.
For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.
The handle of the model is
passed in MetrologyHandle.
Shape specifies which type of object is added to the
metrology model. The operator add_metrology_object_generic
returns the index of the added metrology object in the parameter
Index.
Note that add_metrology_object_generic provides the
functionality of the operators add_metrology_object_circle_measure,
add_metrology_object_ellipse_measure,
add_metrology_object_rectangle2_measure and
add_metrology_object_line_measure in one operator.
Depending on the object specified in Shape the following values
are expected:
The geometric shape of the metrology object of type circle is specified by its center (Row, Column) and radius.
ShapeParam=[Row, Column, Radius]
The geometric shape of the metrology object of type rectangle is specified by its center (Row, Column), the orientation of the main axis Phi, and the half edge lengths Length1 and Length2. The input value for Phi is mapped automatically to the interval .
ShapeParam=[Row, Column, Phi, Length1, Length2]
The geometric shape of the metrology object of type ellipse is specified by its center (Row, Column), the orientation of the main axis Phi, the length of the larger half axis Radius1, and the length of the smaller half axis Radius2. The input value for Phi is mapped automatically to the interval .
ShapeParam=[Row, Column, Phi, Radius1, Radius2]
The geometric shape of the metrology object of type line is described by the coordinates of its start point (RowBegin, ColumnBegin) and the coordinates of its end point (RowEnd, ColumnEnd).
ShapeParam=[RowBegin, ColumnBegin, RowEnd, ColumnEnd]
add_metrology_object_generic also prepares the
rectangular measure regions. The rectangular measure regions lie
perpendicular to the boundary of the object. The half edge lengths of
the measure regions perpendicular and tangential to the boundary of the
object are set in MeasureLength1 and
MeasureLength2. The centers of the measure regions lie on
the boundary of the object. The parameter MeasureSigma
specifies a standard deviation that is used by the operator
apply_metrology_model to smooth the gray values of the
image. Salient edges can be selected with the parameter
MeasureThreshold, which constitutes a threshold on the
amplitude, i.e., the absolute value of the first derivative of
the edge.
Generic parameters and their values can be specified using
GenParamName und GenParamValue.
All generic parameters that are available in the operator
set_metrology_object_param can also be set in
add_metrology_object_generic. But note that
for a lot of applications the default values are sufficient and
no adjustment is necessary. Furthermore, the following values for
GenParamName and GenParamValue are
available only for Shape =
'circle' and 'ellipse':
The parameter specifies the angle at the start point of a circular or elliptic arc. For an ellipse, the angle at the start point is measured relative to the positive main axis 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. To create a closed circle or ellipse the value of the parameter 'start_phi' is set to 0 and the value of the parameter '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: 0.0
The parameter specifies the angle at the end point of a circular or elliptic arc. For an ellipse, the angle at the end point is measured relative to the positive main axis 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. To create a closed circle or ellipse the value of the parameter 'start_phi' is set to 0 and the value of the parameter '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: 6.28318
The parameter specifies the direction of the circular or elliptic arc. For the value 'positive', the arc is defined between 'start_phi' and 'end_phi' in mathematically positive direction (counterclockwise). For the value 'negative', the arc is defined between 'start_phi' and 'end_phi' in mathematically negative direction (clockwise).
List of values: 'positive', 'negative'
Default value: 'positive'
This operator modifies the state of the following input parameter:
The value of this parameter may not be shared across multiple threads without external synchronization.
MetrologyHandle (input_control, state is modified) metrology_model → (handle)
Handle of the metrology model.
Shape (input_control) attribute.name(-array) → (string)
Type of the metrology object to be added.
Default value: 'circle'
List of values: 'circle', 'ellipse', 'line', 'rectangle2'
ShapeParam (input_control) attribute.value-array → (real / integer)
Parameters of the metrology object to be added.
MeasureLength1 (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
≤
511.0 (lin)
Minimum increment: 1.0
Recommended increment: 10.0
MeasureLength2 (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
≤
511.0 (lin)
Minimum increment: 1.0
Recommended increment: 10.0
MeasureSigma (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
≤
100 (lin)
Minimum increment: 0.01
Recommended increment: 0.1
Restriction: 0.4 <= MeasureSigma && MeasureSigma <= 100
MeasureThreshold (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
≤
255 (lin)
Minimum increment: 0.5
Recommended increment: 2
GenParamName (input_control) attribute.name-array → (string)
Names of the generic parameters.
Default value: []
List of values: 'distance_threshold', 'end_phi', 'instances_outside_measure_regions', 'max_num_iterations', 'measure_distance', 'measure_interpolation', 'measure_select', 'measure_transition', 'min_score', 'num_instances', 'num_measures', 'point_order', 'rand_seed', 'start_phi'
GenParamValue (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', 'true', 'false', 'first', 'last', 'positive', 'negative', 'uniform', 'nearest_neighbor', 'bilinear', 'bicubic'
Index (output_control) integer → (integer)
Index of the created metrology object.
create_metrology_model (MetrologyHandle)
read_image (Image, 'fabrik')
get_image_size (Image, Width, Height)
set_metrology_model_image_size (MetrologyHandle, Width, Height)
LinePar := [45,360,415,360]
RectPar1 := [270,232,rad(0),30,25]
RectPar2 := [360,230,rad(0),30,25]
LinePar := [45,360,415,360]
RectPar3 := [245,320,rad(-90),70,35]
* Add two rectangles
add_metrology_object_generic (MetrologyHandle, 'rectangle2', [RectPar1,RectPar2], \
20, 5, 1, 30, [], [], Indices)
* Add a rectangle and a line
add_metrology_object_generic (MetrologyHandle, ['rectangle2','line'], \
[RectPar3,LinePar], 20, 5, 1, 30, [], [], Index)
get_metrology_object_model_contour (Contour, MetrologyHandle, 'all', 1.5)
apply_metrology_model (Image, MetrologyHandle)
get_metrology_object_result_contour (Contour1, MetrologyHandle, 'all', \
'all', 1.5)
If the parameters are valid, the operator
add_metrology_object_generic returns the value 2 (H_MSG_TRUE).
If necessary, an exception is raised.
set_metrology_model_image_size,
set_metrology_model_param
align_metrology_model,
apply_metrology_model,
set_metrology_model_param
get_metrology_object_model_contour
2D Metrology