transform_metrology_objectT_transform_metrology_objectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_object (Operator)
Name
transform_metrology_objectT_transform_metrology_objectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_object
— Transform metrology objects of a metrology model, e.g., for alignment.
Warning
transform_metrology_objecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_object
is obsolete and is only provided for
reasons of backward compatibility. New applications should use the
operator align_metrology_modelalign_metrology_modelAlignMetrologyModelAlignMetrologyModelAlignMetrologyModelalign_metrology_model
instead.
Signature
void TransformMetrologyObject(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)
static void HOperatorSet.TransformMetrologyObject(HTuple metrologyHandle, HTuple index, HTuple row, HTuple column, HTuple phi, HTuple mode)
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)
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
Description
transform_metrology_objecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_object
translates and rotates the
metrology objects contained in MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle
specified
by the index IndexIndexIndexIndexindexindex
according to the parameters
RowRowRowRowrowrow
, ColumnColumnColumnColumncolumncolumn
, and PhiPhiPhiPhiphiphi
.
For an explanation of the concept of 2D metrology see the
introduction of chapter 2D Metrology.
The index IndexIndexIndexIndexindexindex
refer to the index returned by the
operators add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureadd_metrology_object_circle_measure
,
add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure
,
add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureadd_metrology_object_line_measure
, or
add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure
.
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_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure
or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure
.
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_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureadd_metrology_object_ellipse_measure
,
or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measureadd_metrology_object_rectangle2_measure
.
For lines, the starting point of the line is used as origin of
the rotation. For circles, PhiPhiPhiPhiphiphi
is ignored.
transform_metrology_objecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_object
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_modelApplyMetrologyModelApplyMetrologyModelApplyMetrologyModelapply_metrology_model
before calling
transform_metrology_objecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_object
are discarded during the
transformation.
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
MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandlemetrology_handle
(input_control, state is modified) metrology_model →
HMetrologyModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the metrology model.
IndexIndexIndexIndexindexindex
(input_control) integer(-array) →
HTupleMaybeSequence[Union[str, int]]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)
Index of the metrology objects.
Default:
'all'
"all"
"all"
"all"
"all"
"all"
Suggested values:
'all'"all""all""all""all""all", 0, 1, 2
RowRowRowRowrowrow
(input_control) real(-array) →
HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Translation in row direction.
ColumnColumnColumnColumncolumncolumn
(input_control) real(-array) →
HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Translation in column direction.
PhiPhiPhiPhiphiphi
(input_control) real(-array) →
HTupleMaybeSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Rotation angle.
ModeModeModeModemodemode
(input_control) string(-array) →
HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Mode of the transformation.
Default:
'absolute'
"absolute"
"absolute"
"absolute"
"absolute"
"absolute"
Suggested values:
'absolute'"absolute""absolute""absolute""absolute""absolute", 'relative'"relative""relative""relative""relative""relative"
Result
If the parameters are valid, the operator
transform_metrology_objecttransform_metrology_objectTransformMetrologyObjectTransformMetrologyObjectTransformMetrologyObjecttransform_metrology_object
returns the value 2 (
H_MSG_TRUE)
. If
necessary, an exception is raised.
Module
2D Metrology