Operator Reference
set_metrology_model_image_size (Operator)
set_metrology_model_image_size — Set the size of the image of metrology objects.
Signature
set_metrology_model_image_size( : : MetrologyHandle, Width, Height : )
Description
set_metrology_model_image_size is used to set or change the
size of the image in which the edge detection that is related to a
metrology model will be performed.
For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.
The metrology model is defined by the handle MetrologyHandle. The
image width must be specified by the parameter Width. The image
height must specified by the parameter Height.
Attention
Note that the operator set_metrology_model_image_size should
be called before adding metrology objects to the metrology model
using the operators add_metrology_object_generic,
add_metrology_object_circle_measure,
add_metrology_object_ellipse_measure,
add_metrology_object_line_measure,
or add_metrology_object_rectangle2_measure. Otherwise, all
measure regions of existing metrology objects will be
recomputed automatically upon calling set_metrology_model_image_size
or apply_metrology_model.
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.
Width (input_control) extent.x → (integer)
Width of the image to be processed.
Default: 640
Suggested values: 128, 192, 256, 512, 640, 768, 1024, 1280, 2048
Value range:
0
≤
Width
(lin)
Minimum increment: 1
Recommended increment: 16
Height (input_control) extent.y → (integer)
Height of the image to be processed.
Default: 480
Suggested values: 128, 192, 256, 512, 640, 768, 1024, 1280, 2048
Value range:
0
≤
Height
(lin)
Minimum increment: 1
Recommended increment: 16
Result
If the parameters are valid, the operator
set_metrology_model_image_size returns the value 2 (
H_MSG_TRUE)
.
If necessary, an exception is raised.
Possible Predecessors
Possible Successors
set_metrology_model_param,
add_metrology_object_circle_measure,
add_metrology_object_ellipse_measure,
add_metrology_object_line_measure,
add_metrology_object_rectangle2_measure,
add_metrology_object_generic
Module
2D Metrology