MmetSetPosition

MIL_ID ContextId,	//in
MIL_INT FeatureLabelOrIndex,	//in
MIL_INT64 TransformationType,	//in
MIL_DOUBLE Param1,	//in
MIL_DOUBLE Param2,	//in
MIL_DOUBLE Param3,	//in
MIL_DOUBLE Param4,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function moves the specified feature's position in the metrology template of a metrology context.

This function is valid for all measured (MmetAddFeature() with M_MEASURED) and parametrically constructed (MmetAddFeature() with M_CONSTRUCTED and M_PARAMETRIC) features, unless otherwise specified. Typically this function is used to move the position of the global frame or a parametrically constructed local frame (each of which is considered a feature). When specifying a frame, all features and metrology regions that use that frame as their reference frame are moved accordingly. Note that you can also position features using MmetControl() with M_POSITION_X and M_POSITION_Y. However, in this case you must enter exact values; you cannot, for example, position features based on the results of another module, as you can using MmetSetPosition() with M_RESULT.

MIL moves the specified feature relative to its reference frame, except for the global frame, which MIL moves relative to its default origin (0,0). If the target image is not calibrated, the global frame's default origin is aligned with the center of the top-left corner pixel of the target image. If the target image is calibrated, the global frame's default origin is aligned with the origin of the relative (world) coordinate system.

If a camera calibration context is associated with the target image, set positional and dimensional values in real-world units. Otherwise, use pixel units.

Note that when using a C compiler (not a C++ or other compiler) in 64-bit mode, MmetSetPosition() internally calls the MIL_DOUBLE version of this function (MmetSetPositionDouble()). If you need to pass integer values, call the MIL_INT64 version of this function (MmetSetPositionInt64()).

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

ContextId

Specifies the identifier of the metrology context. The metrology context must have been previously allocated on the required system using MmetAlloc().

FeatureLabelOrIndex

Specifies the label or index of the feature you want to position. Set this parameter to one of the following values.

For specifying a feature

Value

Description

M_DEFAULT

Specifies the global frame.

M_FEATURE_INDEX(

MIL_INT FeatureIndex

)

Specifies the index value of an existing individual feature.

(summarize)

Specifies the index value of an existing individual feature.

(more details...)

Parameters

FeatureIndex

This parameter specifies the index of the feature to position. You can set this parameter to the following:

Value >= 0

Specifies the index. Note that the index of the global frame is 0.

M_FEATURE_LABEL(

MIL_INT FeatureLabel

)

Specifies the label value of an existing individual feature.

(summarize)

Specifies the label value of an existing individual feature.

(more details...)

Parameters

FeatureLabel

This parameter specifies the label of the feature to position. You can set this parameter to the following:

Value > 0

Specifies the label.

TransformationType

Specifies the type of transformation that will be used to set the new position of the feature.