transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject (Operator)

Name

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

Warning

transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject is obsolete and is only provided for reasons of backward compatibility. New applications should use the operator align_metrology_modelalign_metrology_modelAlignMetrologyModelalign_metrology_modelAlignMetrologyModelAlignMetrologyModel instead.

Signature

Description

transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject translates and rotates the metrology objects contained in MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle specified by the index IndexIndexIndexIndexIndexindex according to the parameters RowRowRowRowRowrow, ColumnColumnColumnColumnColumncolumn, and PhiPhiPhiPhiPhiphi.

The index IndexIndexIndexIndexIndexindex refer to the index 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. IndexIndexIndexIndexIndexindex may contain a single value or a tuple of values. If all metrology objects shall be transformed, IndexIndexIndexIndexIndexindex can be set to 'all'"all""all""all""all""all".

The parameter ModeModeModeModeModemode can be set to 'absolute'"absolute""absolute""absolute""absolute""absolute" or 'relative'"relative""relative""relative""relative""relative" and specifies the effect of the transformation:

ModeModeModeModeModemode = '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.

For metrology objects of the type ellipse, or rectangle, the origin of the rotation is defined in the center of the metrology object 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. For lines and circles, PhiPhiPhiPhiPhiphi is ignored.

ModeModeModeModeModemode = '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 object 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. For lines, the starting point of the line is used as origin of the rotation. For circles, PhiPhiPhiPhiPhiphi is ignored.

transform_metrology_objecttransform_metrology_objectTransformMetrologyObjecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObject is fastest if no rotation is defined, 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.

Parallelization

• 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:

• MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle

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.

Module

2D Metrology