add_metrology_object_circle_measure🔗
Short description🔗
add_metrology_object_circle_measure — Add a circle or a circular arc to a metrology model.
Signature🔗
add_metrology_object_circle_measure( metrology_model MetrologyHandle, circle.center.y Row, circle.center.x Column, circle.radius Radius, number MeasureLength1, number MeasureLength2, number MeasureSigma, number MeasureThreshold, attribute.name GenParamName, attribute.value GenParamValue, out integer Index )
Description🔗
add_metrology_object_circle_measure adds a metrology object
of type circle or circular arc to a metrology model and prepares the
rectangular measure regions. The handle of the model is
passed in MetrologyHandle.
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 circle is
specified by its center (Row, Column) and
Radius. The rectangular measure regions lie
perpendicular to the boundary of the circle. The half edge
lengths of the measure regions are set in MeasureLength1
and MeasureLength2. The centers of the measure regions
lie on the boundary of the circle. The parameter MeasureSigma
specifies the standard deviation that is used by 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. The operator add_metrology_object_circle_measure
returns the index of the added metrology object in parameter
Index.
Furthermore, you can adjust some generic parameters with
GenParamName and GenParamValue. The following
values for GenParamName and GenParamValue are
available:
-
'start_phi': The parameter specifies the angle at the start point of a circular arc. To create a closed circle the value of the parameter 'start_phi' is set to 0 and the value of the parameter 'end_phi' is set to \(2\pi\) (with positive point order). The input value is mapped automatically to the interval \([0,2\pi]\).
Suggested values: 0.0, 0.78, 6.28318
Default: 0.0
-
'end_phi': The parameter specifies the angle at the end point of a circular arc. To create a closed circle the value of the parameter 'start_phi' is set to 0 and the value of the parameter 'end_phi' is set to \(2\pi\) (with positive point order). The input value is mapped internally automatically to the interval \([0,2\pi]\).
Suggested values: 0.0, 0.78, 6.28318
Default: 6.28318
-
'point_order': The parameter specifies the direction of the circular arc. For the value 'positive', the circular arc is defined between 'start_phi' and 'end_phi' in mathematically positive direction (counterclockwise). For the value 'negative', the circular arc is defined between 'start_phi' and 'end_phi' in mathematically negative direction (clockwise).
List of values: 'positive', 'negative'
Default: 'positive'
Additionally all generic parameters, that are available for the
operator set_metrology_object_param can be set. But note
that for a lot of applications the default values are sufficient
and no adjustment is necessary.
Execution information🔗
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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters🔗
MetrologyHandle (input_control, state is modified) metrology_model → (handle)
Handle of the metrology model.
Row (input_control) circle.center.y(-array) → (real / integer)
Row coordinate (or Y) of the center of the circle or circular arc.
Column (input_control) circle.center.x(-array) → (real / integer)
Column (or X) coordinate of the center of the circle or circular arc.
Radius (input_control) circle.radius(-array) → (real / integer)
Radius of the circle or circular arc.
MeasureLength1 (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
Minimum increment: 1.0
Recommended increment: 10.0
Restriction: MeasureLength1 < Radius
MeasureLength2 (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
Minimum increment: 1.0
Recommended increment: 10.0
MeasureSigma (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 ≤ 100.0
Minimum increment: 0.01
Recommended increment: 0.1
MeasureThreshold (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 ≤ 255 (lin)
Minimum increment: 0.5
Recommended increment: 2
GenParamName (input_control) attribute.name-array → (string)
Names of the generic parameters.
Default: []
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: []
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.
Example🔗
(HDevelop)
read_image (Image, 'rings_and_nuts')
create_metrology_model (MetrologyHandle)
get_image_size (Image, Width, Height)
set_metrology_model_image_size (MetrologyHandle, Width, Height)
add_metrology_object_circle_measure (MetrologyHandle, 120, 130, 35, 10, 2, \
1, 30, ['measure_distance'], [40], Index)
apply_metrology_model (Image, MetrologyHandle)
get_metrology_object_result (MetrologyHandle, Index, 'all', 'result_type', \
'all_param', Circle)
get_metrology_object_result_contour (Contour, MetrologyHandle, Index, \
'all', 1.5)
Result🔗
If the parameters are valid, the operator
add_metrology_object_circle_measure
returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.
Combinations with other operators🔗
Combinations
Possible predecessors
set_metrology_model_image_size
Possible successors
align_metrology_model, apply_metrology_model
Alternatives
See also
get_metrology_object_model_contour, set_metrology_model_param, add_metrology_object_ellipse_measure, add_metrology_object_line_measure, add_metrology_object_rectangle2_measure
Module🔗
2D Metrology