transform_metrology_objectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_objectT_transform_metrology_object

HALCON ScriptCpp++.NETPythonC

Short description

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

Warning

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

Signature

transform_metrology_object( metrology_model MetrologyHandle, integer Index, real Row, real Column, real Phi, string Mode )void TransformMetrologyObject( const HTuple& MetrologyHandle, const HTuple& Index, const HTuple& Row, const HTuple& Column, const HTuple& Phi, const HTuple& Mode )static void HOperatorSet.TransformMetrologyObject( HTuple metrologyHandle, HTuple index, HTuple row, HTuple column, HTuple phi, HTuple mode )def transform_metrology_object( metrology_handle: HHandle, index: MaybeSequence[Union[str, int]], row: MaybeSequence[Union[int, float]], column: MaybeSequence[Union[int, float]], phi: MaybeSequence[Union[int, float]], mode: MaybeSequence[str] ) -> None

Herror T_transform_metrology_object( const Htuple MetrologyHandle, const Htuple Index, const Htuple Row, const Htuple Column, const Htuple Phi, const Htuple Mode )

void HMetrologyModel::TransformMetrologyObject( const HTuple& Index, const HTuple& Row, const HTuple& Column, const HTuple& Phi, const HTuple& Mode ) const

void HMetrologyModel::TransformMetrologyObject( const HString& Index, double Row, double Column, double Phi, const HString& Mode ) const

void HMetrologyModel::TransformMetrologyObject( const char* Index, double Row, double Column, double Phi, const char* Mode ) const

void HMetrologyModel::TransformMetrologyObject( const wchar_t* Index, double Row, double Column, double Phi, const wchar_t* Mode ) const (Windows only)

void HMetrologyModel.TransformMetrologyObject( HTuple index, HTuple row, HTuple column, HTuple phi, HTuple mode )

void HMetrologyModel.TransformMetrologyObject( string index, double row, double column, double phi, string mode )

Description

transform_metrology_objectTransformMetrologyObject translates and rotates the metrology objects contained in MetrologyHandlemetrologyHandlemetrology_handle specified by the index Indexindexindex according to the parameters Rowrowrow, Columncolumncolumn, and Phiphiphi.

For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.

The index Indexindexindex refer to the index returned by the operators add_metrology_object_circle_measureAddMetrologyObjectCircleMeasure, add_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasure, add_metrology_object_line_measureAddMetrologyObjectLineMeasure, or add_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measure. Indexindexindex may contain a single value or a tuple of values. If all metrology objects shall be transformed, Indexindexindex can be set to 'all'"all".

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

• Modemodemode = 'absolute'"absolute":

  The metrology objects are translated to the image coordinates Rowrowrow and Columncolumncolumn and rotated by Phiphiphi 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_measureAddMetrologyObjectEllipseMeasure or add_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measure. For lines and circles, Phiphiphi is ignored.

• Modemodemode = '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_measureAddMetrologyObjectEllipseMeasure, or add_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2Measure. For lines, the starting point of the line is used as origin of the rotation. For circles, Phiphiphi is ignored.

transform_metrology_objectTransformMetrologyObject 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_modelApplyMetrologyModel before calling transform_metrology_objectTransformMetrologyObject are discarded during the transformation.

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:

• MetrologyHandlemetrologyHandlemetrology_handle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

MetrologyHandlemetrologyHandlemetrology_handle (input_control, state is modified) metrology_model → (handle)HTuple (HHandle)HMetrologyModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the metrology model.

Indexindexindex (input_control) integer(-array) → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)MaybeSequence[Union[str, int]]Htuple (char* / Hlong)

Index of the metrology objects.

Default: 'all'"all"
Suggested values: 'all', 0, 1, 2"all", 0, 1, 2

Rowrowrow (input_control) real(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Translation in row direction.

Columncolumncolumn (input_control) real(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Translation in column direction.

Phiphiphi (input_control) real(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Rotation angle.

Modemodemode (input_control) string(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Mode of the transformation.

Default: 'absolute'"absolute"
Suggested values: 'absolute', 'relative'"absolute", "relative"

Result

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

Module

2D Metrology