transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject (Operator)

Name

transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject — Transform of metrology objects of a metrology model, e.g. for alignment.

Signature

Description

transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject translates the metrology objects specified by the indices IndicesIndicesIndicesIndicesIndicesindices to the positions defined in RowRowRowRowRowrow and ColumnColumnColumnColumnColumncolumn and rotates them by PhiPhiPhiPhiPhiphi.

The metrology model is defined by the handle MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle which is returned by create_metrology_modelcreate_metrology_modelCreateMetrologyModelcreate_metrology_modelCreateMetrologyModelCreateMetrologyModel (see there for the basic principle of 2D metrology).

The indices IndicesIndicesIndicesIndicesIndicesindices refer to the indices returned by the operators add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasure, add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure, add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasure, or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measure. IndicesIndicesIndicesIndicesIndicesindices may contain a single value or a tuple of values. If all metrology objects shall be transformed, IndicesIndicesIndicesIndicesIndicesindices can be set to 'all'"all""all""all""all""all".

The parameter ModeModeModeModeModemode specifies the effect of the transformation. If ModeModeModeModeModemode is set to 'absolute'"absolute""absolute""absolute""absolute""absolute", the metrology objects are translated to the image coordinates RowRowRowRowRowrow and ColumnColumnColumnColumnColumncolumn and rotated by PhiPhiPhiPhiPhiphi with respect to the image coordinate system. If ModeModeModeModeModemode is set to 'relative'"relative""relative""relative""relative""relative", the values of the transformation are considered as relative values, i.e., they are specified relative to the previous position and rotation of the metrology object.

For metrology objects of the type ellipse, or rectangle, the origin of the rotation is defined in the center of the metrology model as specified in the operators add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure, or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measure. If the metrology object of the metrology model is a line and ModeModeModeModeModemode = 'relative'"relative""relative""relative""relative""relative", the starting point of the line is used as origin of the rotation. If the metrology object is a line and ModeModeModeModeModemode = 'absolute'"absolute""absolute""absolute""absolute""absolute", or if the metrology object is a circle, the parameter PhiPhiPhiPhiPhiphi is ignored.

transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject is fastest if no rotation is defined and the original and translated measure regions both lie completely within the image. In all other cases, the measure regions have to be newly generated, which is slower.

Attention

Note that any results (fitted geometric shapes) that have been generated by the operator apply_metrology_modelapply_metrology_modelApplyMetrologyModelapply_metrology_modelApplyMetrologyModelApplyMetrologyModel before calling transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject are discarded during the transformation.

A metrology model 'MetrologyHandle'"MetrologyHandle""MetrologyHandle""MetrologyHandle""MetrologyHandle""MetrologyHandle" cannot be shared between two or more user's threads. Different metrology models can be used independently and safely in different threads.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

copy_metrology_objectcopy_metrology_objectCopyMetrologyObjectcopy_metrology_objectCopyMetrologyObjectCopyMetrologyObject

Possible Successors

apply_metrology_modelapply_metrology_modelApplyMetrologyModelapply_metrology_modelApplyMetrologyModelApplyMetrologyModel

Module

2D Metrology