MmetControl

Associates the specified calibration context with the template reference of the metrology context. To specify the template reference, use MmetControl() with M_TEMPLATE_REFERENCE_ID.

When saving the metrology context, if you do not save the calibration context associated with the template reference (MmetSave() or MmetStream() with M_WITH_CALIBRATION), you must re-associate the template reference with its calibration context after restoring the context (MmetRestore() or MmetStream()). Note that you can also associate a calibration context to the template reference using other MIL mechanisms ( Mcal...()); in this case, M_ASSOCIATED_CALIBRATION is ignored.

You cannot associate the template reference with a calibrated context whose Y-axis has been inverted using McalGrid() with M_Y_AXIS_UP.

Associates a template reference to the context. The template reference is a companion buffer (typically an image) useful for training the metrology context and drawing the results on a typical target image. INQ

Sets the maximum measurement and validation time for MmetCalculate(). INQ

Sets whether edge chains are built with as much edgel information as possible. An edge chain refers to the set of connected edgels that form an edge. Edge chains are built using an 8-connected lattice. INQ

Sets the scale of the image at which to do the edge extraction. Once the extraction is complete, the results are scaled to the original scale of the image.

An extraction scale less than one can speed calculations but can be less reliable. The default extraction scale setting is typically sufficient. INQ

Sets the degree of smoothness (strength of denoising) applied by the edge extraction filter during the neighborhood operation.

The smoothing operation evens out rough edges and reduces noise; in effect, the smoothness factor affects which edges are extracted. For more information on smoothing edges, see the Smoothing for IIR filters subsection of the Customizing the edge extraction settings section of Chapter 8: Edge Finder. INQ

Sets the type of filter used to extract edges. The type of filter determines the distribution of the neighborhood's influence. It establishes the contribution of each neighboring pixel to the edge calculation.

For more information on filtering, see the Filter type subsection of the Customizing the edge extraction settings section of Chapter 8: Edge Finder. INQ

Sets whether to perform all edge extraction operations using floating-point precision calculations.

For more information on using floating-point precision when extracting edges, see the Calculating and retrieving results section of Chapter 8: Edge Finder. INQ

Sets how to calculate the magnitude of the edge at each edgel position.

For more information on the magnitude, see the Magnitude type subsection of the Customizing the edge extraction settings section of Chapter 8: Edge Finder. INQ

Sets the accuracy with which you define the metrology region associated with a feature when dealing with a calibrated image. A high accuracy closely follows the image distortion when creating the metrology region, while a low accuracy approximates the distortion. For example, a rectangular metrology region remains a rectangle and a circular metrology region becomes the best approximated elliptic region.

M_REGION_ACCURACY_HIGH also applies when drawing the metrology region, using MmetDraw() with Operation set to M_DRAW_REGION. INQ

Sets the threshold of the edge extraction.

For more information on thresholding edges, see the Thresholding subsection of the Customizing the edge extraction settings section of Chapter 8: Edge Finder. INQ

Sets the type of hysteresis threshold used when performing the edge extraction.

Edge chains are built such that the magnitude values of all connected edgels are stronger than a lower bound threshold value and such that at least one of the edgel's magnitude in each edge chain is stronger than a upper bound threshold value.

Note that M_THRESHOLD_TYPE sets how to use the lower and upper threshold bounds, while M_THRESHOLD_MODE defines what the bounds are.

For more information on thresholding, see the Thresholding subsection of the Customizing the edge extraction settings section of Chapter 8: Edge Finder. INQ

Sets the upper bound of the hysteresis threshold value. M_THRESHOLD_VALUE_HIGH is ignored unless MmetControl() with M_THRESHOLD_MODE is set to M_USER_DEFINED. Note that lower threshold values result in a more sensitive edgel detection; that is, a higher (or equal) number of edgels are detected.

For more information on thresholding, see the Thresholding subsection of the Customizing the edge extraction settings section of Chapter 8: Edge Finder. INQ

Sets the lower bound of the hysteresis threshold value. M_THRESHOLD_VALUE_LOW is ignored unless MmetControl() with M_THRESHOLD_MODE is set to M_USER_DEFINED. Note that lower threshold values result in a more sensitive edgel detection; that is, a higher (or equal) number of edgels are detected.

For more information on thresholding, see the Thresholding subsection of the Customizing the edge extraction settings section of Chapter 8: Edge Finder. INQ

Sets the end angle of a constructed arc. The angle is relative to the reference frame's X-axis and follows the counter-clockwise convention. INQ

Sets the start angle of a constructed arc. The angle is relative to the reference frame's X-axis and follows the counter-clockwise convention. INQ

Sets the angular range within which an edgel's gradient angle must fall for MIL to consider it an active edgel. Active edgels apply to physically measured features and constructed features based on physically measured edgels.

By default, MIL measures the specified angular range, in the counter clockwise direction, relative to the metrology ROI's orientation. To change the relative angle from which to measure the angular range, use M_EDGEL_RELATIVE_ANGLE.

In the following examples, the angular range is 60.0° and the relative angle is the same as the region's orientation. Note that for the ring-sector region, the orientation is radial.

Note that constructed edgel features are not built from a region, but from a specified measured feature. Therefore in this case, the region's orientation refers to the orientation of the region from which its specified measured feature was built. INQ

Sets the relative angle from which to measure the gradient angle range (M_EDGEL_ANGLE_RANGE). You can use M_EDGEL_RELATIVE_ANGLE, along with M_EDGEL_ANGLE_RANGE, to select the active edgels of a measured feature or the active edgels of a constructed feature based on physically measured edgels. Typically, the relative angle is the same as the region's orientation. For an example on how M_EDGEL_RELATIVE_ANGLE is applied, along with the gradient angle range, see M_EDGEL_ANGLE_RANGE.

Note that constructed edgel features are not built from a region, but from a specified measured feature. Therefore in this case, the region's orientation refers to the orientation of the region from which its specified measured feature was built. INQ

Sets the edgels to select relative to the orientation of the metrology region. The metrology region is scanned column by column, and the specified edgel encountered within a column is selected. Note that this control type takes effect after M_EDGEL_RELATIVE_ANGLE and M_EDGEL_ANGLE_RANGE are satisfied. M_EDGEL_SELECTION_RANK applies to M_RECTANGLE derived metrology regions.

In the following example, there are multiple edges in the metrology region. The solid gray line illustrates the edgels selected when M_EDGEL_SELECTION_RANK is set to 1; the dotted gray line illustrates the edgels selected when M_EDGEL_SELECTION_RANK is set to 2. INQ

Sets the type of edgels to use when building constructed edgel features from a measured base feature using MmetAddFeature() with M_COPY_FEATURE_EDGELS. INQ

Sets the approximate portion of the feature that must be covered by fitted edgels. In the following example, about 50.0% of the segment feature covers the edgels.

The actual coverage that results from this setting depends on the scale of the image at which the feature edges were extracted, as specified with M_EXTRACTION_SCALE; a scale of 1 provides the best estimation.

M_FIT_COVERAGE_MIN is valid for all fit operations for physically measured or constructed features. For constructed features using a fit operation performed on multiple physically measured edgel features, the accuracy of the minimum fit coverage is based on the average of each feature's extraction scale. INQ

Sets the greatest possible gap between an active edgel and an iterative fit for the edgel to be considered during the next iteration. The higher the value, the farther away an active edgel can be. M_FIT_DISTANCE_MAX is valid for all fit operations for physically measured or constructed features. INQ

Sets the maximum number of fit iterations used to compute the feature. The more iterations, the better the fit, but the slower the calculation. M_FIT_ITERATIONS_MAX is valid for all fit operations for physically measured or constructed features. INQ

Sets the maximum allowable difference in the value of the feature's underlying coefficients, from one fit iteration to the next. If at least one coefficient of the feature varies more, between two consecutive fit iterations, than the specified value, the iteration process will continue. Note that:

These coefficients are the same as those required when building the corresponding features with a parametric operation.

M_FIT_VARIATION_MAX is valid for all fit operations for physically measured or constructed features. INQ

Sets the coefficient A of the line equation for a parametrically constructed line.

The line equation is: A x + B y + C = 0.

If you use the default for all coefficients (A = 0, B = 1, and C = 0), MIL constructs a line that runs along the Y-axis of the reference frame. INQ

Sets the coefficient B of the line equation for a parametrically constructed line.

The line equation is: A x + B y + C = 0.

If you use the default for all coefficients (A = 0, B = 1, and C = 0), MIL constructs a line that runs along the Y-axis of the reference frame. INQ

Sets the coefficient C of the line equation for a parametrically constructed line.

The line equation is: A x + B y + C = 0.

If you use the default for all coefficients (A = 0, B = 1, and C = 0), MIL constructs a line that runs along the Y-axis of the reference frame. INQ

Sets the maximum number of subfeatures to calculate for a multiple feature. Note that M_NUMBER_MAX is valid for point features only. INQ

Sets the minimum number of subfeatures to calculate for a multiple feature. Note that M_NUMBER_MIN is valid for point features only. INQ

Sets the point to use if there is more than one candidate when adding a constructed point feature built at the intersection of two base features (MmetAddFeature() with M_POINT and M_INTERSECTION or M_EXTENDED_INTERSECTION). INQ

Sets the position, along the contour of the specified base feature, at which to construct the point feature (MmetAddFeature() with M_POINT and M_POSITION_ABSOLUTE or M_POSITION_RELATIVE). INQ

Sets the X-coordinate of the end point of a segment constructed using MmetAddFeature() with M_PARAMETRIC.

If you use the default for all positions (M_POSITION_START_X = -1.0, M_POSITION_START_Y = 0.0, M_POSITION_END_X = 1.0, and M_POSITION_END_Y = 0), MIL constructs a segment with a length of 2 (-1.0 to 1.0); the segment is centered on the origin of the reference frame and runs along the reference frame's Y-axis. INQ

Sets the Y-coordinate of the end point of a segment constructed using MmetAddFeature() with M_PARAMETRIC.

If you use the default for all positions (M_POSITION_START_X = -1.0, M_POSITION_START_Y = 0.0, M_POSITION_END_X = 1.0, and M_POSITION_END_Y = 0), MIL constructs a segment with a length of 2 (-1.0 to 1.0); the segment is centered on the origin of the reference frame and runs along the reference frame's Y-axis. INQ

Sets the X-coordinate of the start point of a segment constructed using MmetAddFeature() with M_PARAMETRIC.

If you use the default for all positions (M_POSITION_START_X = -1.0, M_POSITION_START_Y = 0.0, M_POSITION_END_X = 1.0, and M_POSITION_END_Y = 0), MIL constructs a segment with a length of 2 (-1.0 to 1.0); the segment is centered on the origin of the reference frame and runs along the reference frame's Y-axis. INQ

Sets the Y-coordinate of the start point of a segment constructed using MmetAddFeature() with M_PARAMETRIC.

If you use the default for all positions (M_POSITION_START_X = -1.0, M_POSITION_START_Y = 0.0, M_POSITION_END_X = 1.0, and M_POSITION_END_Y = 0), MIL constructs a segment with a length of 2 (-1.0 to 1.0); the segment is centered on the origin of the reference frame and runs along the reference frame's Y-axis. INQ

Sets the X-coordinate of the center of a constructed circle or arc, or sets the X-coordinate of a constructed local frame or point. INQ

Sets the Y-coordinate of the center of a constructed circle or arc, or sets the Y-coordinate of a constructed local frame or point. INQ

Sets the radius of a constructed circle or arc. INQ

Sets the feature's reference frame. INQ

Sets the sorting order that MIL applies to the index of subpoints, when retrieving results of multiple point features. A multiple point feature is a point feature that contains more than one point. By default, the subpoints (points within the point feature) are sorted in ascending order, from the subpoint with the lowest index to the subpoint with the highest index. INQ

Sets the geometry of the derived metrology region. Each M_REGION_GEOMETRY setting states the required set of M_REGION_... controls that fully define the derived metrology region and its orientation. INQ

Sets the angle of the derived metrology region, relative to the reference frame. M_REGION_ANGLE applies to M_INFINITE and M_RECTANGLE derived metrology regions, unless otherwise specified. INQ

Sets the end angle of the derived metrology region, relative to the reference frame. M_REGION_ANGLE_END applies to M_ARC or M_RING_SECTOR derived metrology regions. INQ

Sets whether you are using a feature or an explicit value to specify the end angle of the derived metrology region (M_REGION_ANGLE_END). INQ

Sets the start angle of the derived metrology region, relative to the reference frame. M_REGION_ANGLE_START applies to M_ARC or M_RING_SECTOR derived metrology regions. INQ

Sets whether you are using a feature or an explicit value to specify the start angle of the derived metrology region (M_REGION_ANGLE_START). INQ

Sets whether you are using a feature or an explicit value to specify the angle of the derived metrology region (M_REGION_ANGLE). INQ

Sets the end point of the derived metrology region. M_REGION_END applies to M_SEGMENT derived metrology regions.

To use M_REGION_END, you must set M_REGION_END_TYPE to M_FEATURE_LABEL_VALUE. INQ

Sets whether you are using a feature or an explicit value to specify the end point of the derived metrology region (M_REGION_END, or M_REGION_END_X and M_REGION_END_Y). INQ

Sets the X-coordinate of the end point of the derived metrology region, relative to the reference frame. M_REGION_END_X applies to M_SEGMENT derived metrology regions.

To use M_REGION_END_X, you must set M_REGION_END_TYPE to M_PARAMETRIC. INQ

Sets the Y-coordinate of the end point of the derived metrology region, relative to the reference frame. M_REGION_END_Y applies to M_SEGMENT derived metrology regions.

To use M_REGION_END_Y, you must set M_REGION_END_TYPE to M_PARAMETRIC. INQ

Sets the height of the derived metrology region. M_REGION_HEIGHT applies to M_RECTANGLE derived metrology regions. INQ

Sets whether you are using a feature or an explicit value to specify the height of the derived metrology region (M_REGION_HEIGHT). INQ

Sets the position of the derived metrology region. M_REGION_POSITION applies to all derived metrology regions except M_SEGMENT.

To use M_REGION_POSITION, you must set M_REGION_POSITION_TYPE to M_FEATURE_LABEL_VALUE. INQ

Sets whether you are using a feature or an explicit value to specify the position of the derived metrology region (M_REGION_POSITION, or M_REGION_POSITION_X and M_REGION_POSITION_Y). INQ

Sets the X-coordinate of the position of the derived metrology region, relative to the reference frame. M_REGION_POSITION_X applies to all derived metrology regions except M_SEGMENT.

To use M_REGION_POSITION_X, you must set M_REGION_POSITION_TYPE to M_PARAMETRIC. INQ

Sets the Y-coordinate of the position of the derived metrology region, relative to the reference frame. M_REGION_POSITION_Y applies to all derived metrology regions except M_SEGMENT.

To use M_REGION_POSITION_Y, you must set M_REGION_POSITION_TYPE to M_PARAMETRIC. INQ

Sets the radius of the derived metrology region. M_REGION_RADIUS applies to M_ARC derived metrology regions. INQ

Sets the end radius of the derived metrology region. M_REGION_RADIUS_END applies to M_RING or M_RING_SECTOR derived metrology regions. INQ

Sets whether you are using a feature or an explicit value to specify the end radius of the derived metrology region (M_REGION_RADIUS_END). INQ

Sets the start radius of the derived metrology region. M_REGION_RADIUS_START applies to M_RING or M_RING_SECTOR derived metrology regions. INQ

Sets whether you are using a feature or an explicit value to specify the start radius of the derived metrology region (M_REGION_RADIUS_START). INQ

Sets whether you are using a feature or an explicit value to specify the radius of the derived metrology region (M_REGION_RADIUS). INQ

Sets the start point of the derived metrology region. M_REGION_START applies to M_SEGMENT derived metrology regions.

To use M_REGION_START, you must set M_REGION_START_TYPE to M_FEATURE_LABEL_VALUE. INQ

Sets whether you are using a feature or an explicit value to specify the start point of the derived metrology region (M_REGION_START or M_REGION_START_X and M_REGION_START_Y). INQ

Sets the X-coordinate of the start point of the derived metrology region, relative to the reference frame. M_REGION_START_X applies to M_SEGMENT derived metrology regions.

To use M_REGION_START_X, you must set M_REGION_START_TYPE to M_PARAMETRIC. INQ

Sets the Y-coordinate of the start point of the derived metrology region, relative to the reference frame. M_REGION_START_Y applies to M_SEGMENT derived metrology regions.

To use M_REGION_START_Y, you must set M_REGION_START_TYPE to M_PARAMETRIC. INQ

Sets the width of the derived metrology region. M_REGION_WIDTH applies to M_RECTANGLE derived metrology regions. INQ

Sets whether you are using a feature or an explicit value to specify the width of the derived metrology region (M_REGION_WIDTH). INQ

Sets the gain MIL uses to correct systematic bias between multiple imaging vision set-ups. Systematic bias can, for example, exist between two different Coordinate Measuring Machines (CMMs).

Note that tolerance values, which MIL uses to determine the status of features (and the status of tolerances themselves), are a composite of measured value, gain (M_GAIN), and offset (M_OFFSET). INQ

Sets the offset MIL uses to correct systematic bias between multiple imaging vision set-ups. Systematic bias can, for example, exist between two different Coordinate Measuring Machines (CMMs).

Note that tolerance values, which MIL uses to determine the status of features (and the status of tolerances themselves), are a composite of measured value, offset (M_OFFSET), and gain (M_GAIN). INQ

Sets the maximum acceptable value for the geometric tolerance MIL uses to validate the feature or the relationship between multiple features. For example, if you use a length tolerance to validate the linear dimension of a segment feature, and you set M_VALUE_MAX to 100 pixels, the feature (and the tolerance itself) can only be valid if the segment's length is less than 100 pixels. Similarly, if you are using a perpendicularity tolerance to validate the relationship between two segment features, and you set M_VALUE_MAX to 0.05°, the features (and the tolerance itself) can only be valid if the angle between the segments is between 90.0° and 90.05°.

To get the status (M_PASS, M_WARNING, or M_FAIL) of the feature or the geometric tolerance itself, use MmetGetResult() with M_STATUS.

Features can only have a passing status if their geometric tolerance has a passing status. MIL determines the status of geometric tolerances according to the M_VALUE_MAX, M_VALUE_MIN, M_VALUE_WARNING_MAX, and M_VALUE_WARNING_MIN settings. The following is an example of (non-zero) minimum and maximum tolerance values and warning values: INQ

Sets the minimum value for a geometric tolerance to have a valid status. To get the status of the geometric tolerance (M_PASS, M_WARNING, or M_FAIL), use MmetGetResult() with M_STATUS.

The geometric tolerance's status is determined according to the M_VALUE_MAX, M_VALUE_MIN, M_VALUE_WARNING_MAX, and M_VALUE_WARNING_MIN settings. For an example of (non-zero) minimum and maximum tolerance values and warning values, see M_VALUE_MAX. INQ

Sets the maximum warning value for a geometric tolerance to have a valid status. To get the status of the geometric tolerance (M_PASS, M_WARNING, or M_FAIL), use MmetGetResult() with M_STATUS.

The geometric tolerance's status is determined according to the M_VALUE_MAX, M_VALUE_MIN, M_VALUE_WARNING_MAX, and M_VALUE_WARNING_MIN settings. For an example of (non-zero) minimum and maximum tolerance values and warning values, see M_VALUE_MAX. INQ

Sets the minimum warning value for a geometric tolerance to have a valid status. To get the status of the geometric tolerance (M_PASS, M_WARNING, or M_FAIL), use MmetGetResult() with M_STATUS.

The geometric tolerance's status is determined according to the M_VALUE_MAX, M_VALUE_MIN, M_VALUE_WARNING_MAX, and M_VALUE_WARNING_MIN settings. For an example of (non-zero) minimum and maximum tolerance values and warning values, see M_VALUE_MAX. INQ

Sets the angle used to construct a feature or define a tolerance, when applicable. For more information, see MmetAddFeature() with M_ANGLE, M_ANGLE_ABSOLUTE, M_ANGLE_RELATIVE, M_SECTOR_RELATIVE, and M_PARAMETRIC; also see MmetAddTolerance() with M_ANGULARITY. INQ

Sets whether the feature or tolerance will be drawn using MmetDraw(). INQ

Sets the rotation angle, in the counterclockwise direction, that will be used when cloning the feature. INQ

Sets the translation value, in the X-direction, that will be used when cloning the feature. INQ

Sets the translation value, in the Y-direction, that will be used when cloning the feature. INQ

Sets the scale factor, that will be used when cloning the feature. INQ

Sets the output reference frame that MIL uses to return feature results. All results are returned relative to the output reference frame that you set. The output reference frame is reset to M_GLOBAL_FRAME after each call to MmetCalculate(). INQ

Sets whether to return results in pixels or world units. This essentially sets the output coordinate system to use. The setting of this control type will only affect functions within this module which return positional results. This control type can be changed at any time to return results in the required output units. INQ

Deletes a specific feature, a specific tolerance, all features, or all tolerances. To delete all features, the LabelOrIndex parameter needs to be set to M_ALL_FEATURES. When deleting a feature, all its derived features and associated geometric tolerances are also deleted. To delete all tolerances, the LabelOrIndex parameter needs to be set to M_ALL_TOLERANCES.