| MIL 10 Reference
| Customize Help
| Save Settings

MmetInquire


See also
Availability
Not available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MmetGetResult
MmetName
Synopsis
Inquire information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer.
Syntax
MIL_INT MmetInquire(
MIL_ID MetId, //in
MIL_INT LabelOrIndex, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a metrology context, a derived metrology region object, features, tolerances, or a result buffer. To obtain metrology result buffer values, use MmetGetResult().

If the inquired setting is set to M_DEFAULT (for example, in MmetControl()), MmetInquire() will return M_DEFAULT. To inquire the actual default value, add M_DEFAULT to the InquireType parameter.

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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
MetId

Specifies the identifier of the metrology context, the derived metrology region object, or the result buffer about which to inquire information. The metrology context or derived metrology region object must have been previously allocated on the required system using MmetAlloc(). The metrology result buffer must have been previously allocated on the required system using MmetAllocResult().

LabelOrIndex

Specifies that information will be inquired about the metrology context, the derived metrology region object, features, tolerances, or the result buffer. This parameter should be set to one of the following values.

function map For specifying what to inquire
CollapseValue Description
Collapse M_DEFAULT

Same as M_CONTEXT.
Collapse

Specifies the index value of an existing individual feature.

(summarize)
Parameters

This parameter specifies the index of the individual feature about which to inquire. You can set this parameter to the following:
Value >= 0

Specifies the index of the individual feature. Note that 0 is the index of the global frame.
Collapse

Specifies the label value of an existing individual feature about which to inquire.

(summarize)
Parameters

This parameter specifies the label of the individual feature about which to inquire. You can set this parameter to the following:
Value > 0

Specifies the label of the individual feature.
Collapse

Specifies the index value of an existing individual tolerance.

(summarize)
Parameters

This parameter specifies the index of the individual tolerance about which to inquire. You can set this parameter to the following:
Value >= 0

Specifies the index of the individual tolerance.
Collapse

Specifies the label value of an existing individual tolerance.

(summarize)
Parameters

This parameter specifies the label of the individual tolerance about which to inquire. You can set this parameter to the following:
Value > 0

Specifies the label of the individual tolerance.
Collapse M_CONTEXT

Inquires information about the metrology context, which has been set using the MetId parameter.
Collapse M_DERIVED_GEOMETRY_REGION

Inquires information about the derived metrology region object, which has been set using the MetId parameter.
Collapse M_GENERAL

Inquires information about a setting of a metrology result buffer. This setting applies to all features and tolerances in the metrology result buffer. When using M_GENERAL, MetId must specify a metrology result buffer.

(summarize)
Collapse M_GLOBAL_FRAME

Inquires information about the global frame of the metrology template.
InquireType

Specifies the type of setting about which to inquire.

See the Parameter associations section for possible values that can be specified.

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

To inquire about general metrology context settings, set the InquireType parameter to one of the following values. To inquire general context settings, the LabelOrIndex parameter must be set to M_CONTEXT.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring general context settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_ASSOCIATED_CALIBRATION +

Inquires the calibration context associated with the template reference of the metrology context. SET

(summarize)
Collapse M_NULL

Specifies that there is no calibration context associated with the template reference.
Collapse MIL Calibration context identifier

Specifies the identifier of the calibration context that is associated with the template reference of the metrology context.
Collapse M_MODIFICATION_COUNT +

Inquires the current value of the modification counter. The modification counter is increased by one each time settings for the context are modified.

Although you cannot identify the modification counter's contents, you can compare them throughout your application to know if the context has been altered. If the modification counter has changed you can, for example, prompt the user to save before closing the application.

(summarize)
Collapse Value

Specifies the object modification count.
Collapse M_NUMBER_OF_CONSTRUCTED_FEATURES +

Inquires the number of constructed features in the template of the metrology context.

(summarize)
Collapse Value

Specifies the number of constructed features.
Collapse M_NUMBER_OF_FEATURES +

Inquires the total number of features in the template of the metrology context. This total includes both measured features and constructed features.

(summarize)
Collapse Value

Specifies the total number of features.
Collapse M_NUMBER_OF_MEASURED_FEATURES +

Inquires the number of measured features in the template of the metrology context.

(summarize)
Collapse Value

Specifies the number of measured features.
Collapse M_NUMBER_OF_TOLERANCES +

Inquires the number of geometric tolerances in the template of the metrology context.

(summarize)
Collapse Value

Specifies the number of geometric tolerances.
Collapse M_TEMPLATE_REFERENCE_ID +

Inquires the identifier of the template reference (image) that was added to the context. SET

(summarize)
Collapse M_NULL

Specifies that there is no template reference image associated with the context.
Collapse MIL image identifier

Specifies the identifier of the buffer.
Collapse M_TEMPLATE_REFERENCE_SIZE_BAND +

Inquires the number of bands in the template reference image.

(summarize)
Collapse Value

Specifies the number of bands.
Collapse M_TEMPLATE_REFERENCE_SIZE_X +

Inquires the width of the template reference.

(summarize)
Collapse Value

Specifies the template reference's width. This value must be in pixel units.

(summarize)
Collapse M_TEMPLATE_REFERENCE_SIZE_Y +

Inquires the height of the template reference.

(summarize)
Collapse Value

Specifies the template reference's height. This value must be in pixel units.

(summarize)
Collapse M_TEMPLATE_REFERENCE_TYPE +

Inquires the data type and the data depth (per band) of the template reference.

(summarize)
Collapse Value

Specifies the template reference's data type and data depth.
Collapse M_TIMEOUT +

Inquires the maximum measurement-and-validation time for MmetCalculate(), in msec. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies an infinite amount of measurement and validation time.
Collapse Value > 0.0

Specifies the maximum measurement and validation time, in msec.

To inquire about the system on which either the metrology context or metrology result buffer has been allocated, set the InquireType parameter to the value below.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring about the system
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_OWNER_SYSTEM +

Inquires the identifier of the system on which either the metrology context or metrology result buffer has been allocated. SET

(summarize)
Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Collapse MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

To inquire about the processing settings for a measured feature, set the InquireType parameter to one of the following values. To inquire global processing settings, the LabelOrIndex parameter must be set to an existing measured feature label or index using M_FEATURE_LABEL() or M_FEATURE_INDEX().

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring global processing settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_CHAIN_ALL_NEIGHBORS +

Inquires whether edge chains are built with as much edgel information as possible. SET

(summarize)
Collapse M_DEFAULT

Same as M_ENABLE.
Collapse M_DISABLE

Specifies that edge chains are built with the least amount of edgel information possible. INFO
Collapse M_ENABLE

Specifies that edge chains are built with as much edgel information as possible. INFO
Collapse M_EXTRACTION_SCALE +

Inquires the image scale at which to extract the edges. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.0.
Collapse Value > 0.0

Specifies the extraction scale.
Collapse M_FILTER_SMOOTHNESS +

Inquires the degree of smoothness (strength of denoising) of the edge extraction filter. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 50.0.
Collapse 0.0 <= Value <= 100.0

Specifies the smoothness value. INFO
Collapse M_FILTER_TYPE +

Inquires the type of filter used when performing the edge extraction. SET

(summarize)
Collapse M_DEFAULT

Same as M_SHEN.
Collapse M_DERICHE

Specifies a Canny-Deriche infinite support filter.
Collapse M_FREI_CHEN

Specifies a Frei Chen filter.
Collapse M_PREWITT

Specifies a Prewitt filter.
Collapse M_SHEN

Specifies a Shen-Castan infinite support exponential filter.
Collapse M_SOBEL

Specifies a Sobel filter.
Collapse M_FLOAT_MODE +

Inquires the mode in which to perform the edge extraction filter. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that all edge extractions are not forced to be performed using floating-point precision calculations.
Collapse M_ENABLE

Specifies that all edge extractions are forced to be performed using floating-point precision calculations.
Collapse M_MAGNITUDE_TYPE +

Inquires the type of magnitude value used to calculate the magnitude of the edge at each edgel position. SET

(summarize)
Collapse M_DEFAULT

Same as M_SQR_NORM.
Collapse M_NORM

Specifies that the magnitude will be used.
Collapse M_SQR_NORM

Specifies that the square of the magnitude will be used.
Collapse M_REGION_ACCURACY_HIGH +

Inquires the accuracy with which you define the metrology region associated with a feature when dealing with a calibrated image. SET

(summarize)
Collapse M_DEFAULT

Same as M_ENABLE.
Collapse M_DISABLE

Specifies that high accuracy is not used when defining a metrology region. INFO
Collapse M_ENABLE

Specifies that high accuracy is used when defining a metrology region.
Collapse M_THRESHOLD_MODE +

Inquires the threshold mode of the edge extraction. Note that lower threshold values result in a more sensitive edgel detection. SET

(summarize)
Collapse M_DEFAULT

Same as M_HIGH.
Collapse M_DISABLE

Specifies no threshold. INFO
Collapse M_HIGH

Specifies a high threshold. INFO
Collapse M_LOW

Specifies a low threshold. INFO
Collapse M_MEDIUM

Specifies a medium threshold. INFO
Collapse M_USER_DEFINED

Specifies that the threshold values will be user-defined. INFO
Collapse M_VERY_HIGH

Specifies a very high threshold. INFO
Collapse M_THRESHOLD_TYPE +

Inquires the type of the hysteresis threshold used when performing the edge extraction. SET

(summarize)
Collapse M_DEFAULT

Same as M_HYSTERESIS.
Collapse M_FULL_HYSTERESIS

Specifies that the lower bound threshold value is 0.0.
Collapse M_HYSTERESIS

Specifies that both the lower bound threshold value and the upper bound threshold value will be used.
Collapse M_NO_HYSTERESIS

Specifies that the lower bound threshold value is equal to the upper bound threshold value.
Collapse M_THRESHOLD_VALUE_HIGH +

Inquires the user-defined upper bound of the hysteresis threshold. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the upper bound of the hysteresis threshold.
Collapse M_THRESHOLD_VALUE_LOW +

Inquires the user-defined lower bound of the hysteresis threshold. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the lower bound of the hysteresis threshold.

To inquire about the feature settings for a metrology context, set the InquireType parameter to one of the following values. For inquiring feature settings, the LabelOrIndex parameter can be set to one of the following: an existing feature label or index using M_FEATURE_LABEL() or M_FEATURE_INDEX(), or M_GLOBAL_FRAME.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring feature settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_ANGLE_END +

Inquires the end angle of a constructed arc. The angle is relative to the reference frame's axis. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 360.0°.
Collapse 0.0 <= Value <= 360.0

Specifies the angle, in degrees.
Collapse M_ANGLE_START +

Inquires the start angle of a constructed arc. The angle is relative to the reference frame's axis. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0°.
Collapse 0.0 <= Value <= 360.0

Specifies the angle, in degrees.
Collapse M_DEPENDENCIES +

Inquires whether other features or tolerances have been constructed or verified based on the specified feature.

(summarize)
Collapse M_FALSE

Specifies that other features or tolerances have not been constructed or verified based on the specified feature.
Collapse M_TRUE

Specifies that other features or tolerances have been constructed or verified based on the specified feature.
Collapse M_EDGEL_ANGLE_RANGE +

Inquires the angular range within which an edgel's gradient angle must fall for MIL to consider it an active edgel. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 180.0°.
Collapse 0.0 <= Value <= 360.0

Specifies the angular range, in degrees.
Collapse M_EDGEL_RELATIVE_ANGLE +

Inquires the relative angle from which to measure the gradient angle range (M_EDGEL_ANGLE_RANGE). SET

(summarize)
Collapse M_DEFAULT

Same as M_SAME.
Collapse M_REVERSE

Specifies that the gradient angle range is measured relative to the reverse angle (orientation) of the region of interest (+ 180°).
Collapse M_SAME

Specifies that the gradient angle range is measured relative to the same angle (orientation) as the region of interest.
Collapse M_SAME_OR_REVERSE

Specifies that the gradient angle range is measured relative to either the same or the reverse angle (orientation) of the region of interest.
Collapse M_EDGEL_SELECTION_RANK +

Inquires which edgels to select in each column of the metrology region. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that all edgels are selected.
Collapse M_LAST

Specifies the last edgel in each column, relative to the metrology region.
Collapse Value > 0

Specifies which edgels are selected , based on their rank, relative to the metrology region.
Collapse M_EDGEL_TYPE +

Inquires the type of edgels that will be used for constructed edgel features. SET

(summarize)
Collapse M_DEFAULT

Same as M_ACTIVE_EDGELS.
Collapse M_ACTIVE_EDGELS

Specifies to use the active edgels of the measured feature's metrology region. INFO
Collapse M_ALL_EDGELS

Specifies to use all the edgels of the measured feature's metrology region.
Collapse M_FITTED_EDGELS

Specifies to use the fitted edgels of the measured feature's metrology region. INFO
Collapse M_FEATURE_GEOMETRY +

Inquires the geometry of the specified feature. SET SET

(summarize)
Collapse M_ARC

This value can have multiple meanings, as indicated below.

(summarize)
//For constructed features

Specifies a constructed arc feature.
//For measured features

Specifies a physically measured arc feature. INFO
Collapse M_CIRCLE

This value can have multiple meanings, as indicated below.

(summarize)
//For constructed features

Specifies a constructed circle feature.
//For measured features

Specifies a physically measured circle feature. INFO
Collapse M_EDGEL

This value can have multiple meanings, as indicated below.

(summarize)
//For constructed features

Specifies a constructed edgel feature.
//For measured features

Specifies a physically measured edgel feature. INFO
Collapse M_LINE
//For constructed features

Specifies a constructed line feature.
Collapse M_LOCAL_FRAME
//For constructed features

Specifies a constructed local frame feature.
Collapse M_POINT

This value can have multiple meanings, as indicated below.

(summarize)
//For constructed features

Specifies a constructed point feature.
//For measured features

Specifies a physically measured point feature. INFO
Collapse M_SEGMENT

This value can have multiple meanings, as indicated below.

(summarize)
//For constructed features

Specifies a constructed segment feature.
//For measured features

Specifies a physically measured segment feature. INFO
Collapse M_FEATURE_TYPE +

Inquires the type of the specified feature. SET

(summarize)
Collapse M_CONSTRUCTED

Specifies a constructed feature. INFO
Collapse M_MEASURED

Specifies a physically measured feature. INFO
Collapse M_FIT_COVERAGE_MIN +

Inquires the approximate portion of the feature that must be covered by fitted edgels for a successful fit. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0%.
Collapse 0.0 <= Value <= 100.0

Specifies the minimum coverage, as a percentage.
Collapse M_FIT_DISTANCE_MAX +

Inquires the greatest possible gap between an active edgel and an iterative fit for the active edgel to be considered during the next iteration. SET

(summarize)
Collapse M_DEFAULT

Same as M_INFINITE.
Collapse M_INFINITE

Specifies no maximum distance.
Collapse Value

Specifies the maximum distance, in pixel units.
Collapse M_FIT_ITERATIONS_MAX +

Inquires the maximum number of fit iterations used to compute the feature. SET

(summarize)
Collapse M_DEFAULT

Same as M_AUTO.
Collapse M_AUTO

Specifies that the maximum number of fit iterations will be automatically determined.
Collapse Value >= 1

Specifies the maximum number of fit iterations. INFO
Collapse M_FIT_VARIATION_MAX +

Inquires the maximum allowable difference in the value of the feature's underlying coefficients, from one fit iteration to the next. SET

(summarize)
Collapse M_DEFAULT

Same as M_AUTO.
Collapse M_AUTO

Specifies that the maximum variation will be determined automatically.
Collapse 0.0 <= Value <= 100.0

Specifies the maximum variation, as a percentage.
Collapse M_LINE_A +

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

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

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the coefficient's value.
Collapse M_LINE_B +

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

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

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.0.
Collapse Value

Specifies the coefficient's value.
Collapse M_LINE_C +

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

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

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the coefficient's value.
Collapse M_NUMBER_MAX +

Inquires the maximum number of subfeatures to calculate in a multiple feature (for point features only). SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.
Collapse Value

Specifies the maximum number of subfeatures. INFO
Collapse M_NUMBER_MIN +

Inquires the minimum number of subfeatures to calculate in a multiple feature (for point features only). SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.
Collapse Value

Specifies the minimum number of subfeatures. INFO
Collapse M_OCCURRENCE +

Inquires 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). SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.
Collapse Index

Specifies the index value.
Collapse M_OPERATION +

Inquires the operation used to build the specified feature. SET

(summarize)
Collapse M_DEFAULT

This value can have multiple meanings, as indicated below.

(summarize)
//For a constructed feature

Same as M_PARAMETRIC.
//For a measured feature

Same as M_FIT.
//For a measured feature

Specifies a measured edgel feature built by extracting all the edgels in the metrology region.
Collapse M_ANGLE
//For a constructed feature

Specifies a line feature built at a specified angle from the specified linear base feature (segment or line), and passing through the specified point base feature. INFO
Collapse M_ANGLE_ABSOLUTE
//For a constructed feature

Specifies a point feature built at the specified absolute angle, on the contour of the specified base feature. INFO
Collapse M_ANGLE_RELATIVE
//For a constructed feature

Specifies a point feature built at the specified relative angle, on the contour of the specified base feature. INFO
Collapse M_BISECTOR
//For a constructed feature

Specifies a line feature built where it divides, in two equal parts, an angle formed by the specified base features. INFO
Collapse M_CENTER
//For a constructed feature

Specifies a point feature built at the center of the specified base feature(s). INFO
Collapse M_CLONE_FEATURE

This value can have multiple meanings, as indicated below.

(summarize)
//For a constructed feature

Specifies an arc feature cloned from the specified base feature.
//For a constructed feature

Specifies a circle feature cloned from the specified base feature.
//For a constructed feature

Specifies an edgel feature cloned from the specified base feature.
//For a constructed feature

Specifies a line feature cloned from the specified base feature.
//For a constructed feature

Specifies a local frame feature cloned from the specified base feature.
//For a constructed feature

Specifies a point feature cloned from the specified base feature.
//For a constructed feature

Specifies a segment feature cloned from the specified base feature.
Collapse M_CLOSEST
//For a constructed feature

Specifies a point feature built at the point on the first specified base feature that is closest to the second specified base feature. INFO
Collapse M_CONSTRUCTION

This value can have multiple meanings, as indicated below.

(summarize)
//For a constructed feature

Specifies an arc feature built from a geometric construction using the specified base features. INFO
//For a constructed feature

Specifies a circle feature built from a geometric construction using the specified base features. INFO
//For a constructed feature

Specifies a line feature built from a geometric construction using the specified base features. INFO
//For a constructed feature

Specifies a local frame feature built from a geometric construction using the specified base features. INFO
//For a constructed feature

Specifies a segment feature built from a geometric construction using the specified base features. INFO
Collapse M_COPY_FEATURE_EDGELS
//For a constructed feature

Specifies an edgel feature constructed by copying the edgels of the specified base features. INFO
Collapse M_EXTENDED_INTERSECTION
//For a constructed feature

Specifies a point feature built at the point of intersection between the extension of the first and second specified base features. INFO
Collapse M_FIT

This value can have multiple meanings, as indicated below.

(summarize)
//For a constructed feature

Specifies an arc feature built from the arc that best fits the specified base features. INFO
//For a constructed feature

Specifies a circle feature built from the circle that best fits the specified base features. INFO
//For a constructed feature

Specifies a line feature built from the resulting best fit of the specified base feature. INFO
//For a constructed feature

Specifies a segment feature built from the line that best fits the specified base features. INFO
//For a measured feature

Specifies a measured arc feature built using a best fit operation applied to the data (edgels) extracted from the metrology region. INFO
//For a measured feature

Specifies a measured circle feature built using a best fit operation applied to the data (edgels) extracted from the metrology region. INFO
//For a measured feature

Specifies a measured point feature built using a best fit operation applied to the data (edgels) extracted from the metrology region.
//For a measured feature

Specifies a measured segment feature built from the line that best fits the data (edgels) extracted from the metrology region. INFO
Collapse M_INNER_FIT

This value can have multiple meanings, as indicated below.

(summarize)
//For a constructed feature

Specifies a circle feature built from the best inner fit of a circle around the specified base features. INFO
//For a constructed feature

Specifies a segment feature built from the segment that has the best inner fit in the specified base features. INFO
//For a measured feature

Specifies a measured circle feature built using the best inner fit operation applied to the data (edgels) extracted from the metrology region. INFO
//For a measured feature

Specifies a measured segment feature built from the segment that has the best inner fit applied to the data (edgels) extracted from the metrology region. INFO
Collapse M_INTERSECTION
//For a constructed feature

Specifies a point feature built at the point of intersection between the first and second specified base features. INFO
Collapse M_MAX_DISTANCE_POINT
//For a constructed feature

Specifies a point feature built at the point on the first specified base feature that is farthest from any point on the second specified base feature. INFO
Collapse M_MIDDLE
//For a constructed feature

Specifies a point feature built at the midpoint of the contour (edge) of the specified base feature. INFO
Collapse M_OUTER_FIT

This value can have multiple meanings, as indicated below.

(summarize)
//For a constructed feature

Specifies a circle feature built from the best outer fit of a circle around the specified base features. INFO
//For a constructed feature

Specifies a segment feature built from the outer fit of the specified base features. INFO
//For a measured feature

Specifies a measured circle feature built using the best outer fit operation applied to the data (edgels) extracted from the metrology region. INFO
//For a measured feature

Specifies a measured segment feature built from the segment that has the best outer fit applied to the data (edgels) extracted from the metrology region. INFO
Collapse M_PARALLEL
//For a constructed feature

Specifies a line feature built parallel to the specified linear base feature (segment or line), and passing through the specified point base feature. INFO
Collapse M_PARAMETRIC

This value can have multiple meanings, as indicated below.

(summarize)
//For a constructed feature

Specifies an arc feature built from the following MmetControl() parametric controls: M_POSITION_X, M_POSITION_Y, M_ANGLE_START, M_ANGLE_END, and M_RADIUS.
//For a constructed feature

Specifies a circle feature built from the following MmetControl() parametric controls: M_POSITION_X, M_POSITION_Y, and M_RADIUS.
//For a constructed feature

Specifies a line feature built from the following MmetControl() parametric controls: M_LINE_A, M_LINE_B, and M_LINE_C.
//For a constructed feature

Specifies a local frame feature built from the following MmetControl() parametric controls: M_POSITION_X, M_POSITION_Y, and M_ANGLE. INFO
//For a constructed feature

Specifies a point feature built from the following MmetControl() parametric controls: M_POSITION_X and M_POSITION_Y.
//For a constructed feature

Specifies a segment feature built from the following MmetControl() parametric controls: M_POSITION_START_X, M_POSITION_START_Y, M_POSITION_END_X, and M_POSITION_END_Y.
Collapse M_PERPENDICULAR
//For a constructed feature

Specifies a line feature built perpendicular to the specified linear base feature (segment or line), and passing through the specified point base feature. INFO
Collapse M_POSITION_ABSOLUTE
//For a constructed feature

Specifies a point feature built at the specified position on the contour of the specified base feature. INFO
Collapse M_POSITION_END
//For a constructed feature

Specifies a point feature built at the end of the contour of the specified base feature. INFO
Collapse M_POSITION_RELATIVE
//For a constructed feature

Specifies a point feature built at the specified relative position on the contour of the specified base feature. INFO
Collapse M_POSITION_START
//For a constructed feature

Specifies a point feature built at the start position of the contour of the specified base feature. INFO
Collapse M_SECTOR_RELATIVE
//For a constructed feature

Specifies a line feature built where it divides, in two parts, an angle formed by the specified base features. INFO
Collapse M_POSITION +

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

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.
Collapse Value

Specifies the position value. INFO
Collapse M_POSITION_END_X +

Inquires the X-coordinate of the end point of a parametrically constructed segment. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.0.
Collapse Value

Specifies the X-coordinate, in pixel or world units.
Collapse M_POSITION_END_Y +

Inquires the Y-coordinate of the end point of a parametrically constructed segment. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the Y-coordinate, in pixel or world units.
Collapse M_POSITION_START_X +

Inquires the X-coordinate of the start point of a parametrically constructed segment. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is -1.0.
Collapse Value

Specifies the X-coordinate, in pixel or world units.
Collapse M_POSITION_START_Y +

Inquires the Y-coordinate of the start point of a parametrically constructed segment. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the Y-coordinate, in pixel or world units.
Collapse M_POSITION_X +

Inquires the X-coordinate of the center of a constructed circle or arc, or the X-coordinate position of a constructed local frame or point. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the X-coordinate, in pixel or world units.
Collapse M_POSITION_Y +

Inquires the Y-coordinate of the center of a constructed circle or arc, or the Y-coordinate position of a constructed local frame or point. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the Y-coordinate, in pixel or world units.
Collapse M_RADIUS +

Inquires the radius of a constructed circle or arc. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the radius, in pixel or world units.
Collapse M_REFERENCE_FRAME +

Inquires the reference frame for any feature. SET

(summarize)
Collapse M_DEFAULT

Specifies that the reference frame is the global frame.
Collapse Label

Specifies the label of the reference frame.
Collapse M_SORT +

Inquires the sorting order that MIL applies to the index of subpoints, when retrieving results of multiple point features. SET

(summarize)
Collapse M_DEFAULT

Same as M_SORT_UP.
Collapse M_SORT_DOWN

Specifies that results of multiple point features are sorted in descending order, according to the subpoint's index.
Collapse M_SORT_UP

Specifies that results of multiple point features are sorted in ascending order, according to the subpoint's index.

To inquire the geometry of the metrology region, set the InquireType parameter to the following value. In this case, the LabelOrIndex parameter can be set to an existing measured feature label or index using M_FEATURE_LABEL() or M_FEATURE_INDEX() (for an explicitly-defined or graphics list metrology region) or M_DERIVED_GEOMETRY_REGION (for a derived metrology region), and the MetId parameter can be set to a metrology context or a derived metrology region object.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring the geometry of the metrology region
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_REGION_GEOMETRY

Inquires the geometry of the metrology region. SET SET

(summarize)
Collapse M_DEFAULT

Same as M_INFINITE.
Collapse M_ARC

Specifies an arc region.
Collapse M_INFINITE

Specifies an infinite region.
Collapse M_RECTANGLE

Specifies a rectangle region.
Collapse M_RING

Specifies a ring-shaped region.
Collapse M_RING_SECTOR

Specifies a ring-sector region.
Collapse M_SEGMENT

Specifies a linear segment region.

To inquire the geometry data required to define a metrology region, set the InquireType parameter to one of the following values. In this case, the LabelOrIndex parameter can be set to an existing measured feature label or index using M_FEATURE_LABEL() or M_FEATURE_INDEX() (for an explicitly-defined or graphics list metrology region) or M_DERIVED_GEOMETRY_REGION (for a derived metrology region), and the MetId parameter can be set to a metrology context or a derived metrology region object, unless otherwise specified.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring the geometry data of the metrology region
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_REGION_ANGLE

Inquires the angle of the metrology region. M_REGION_ANGLE applies to M_INFINITE and M_RECTANGLE metrology regions. SET SET SET SET

(summarize)
Collapse Value

Specifies the angle.

For an explicitly-defined or graphics list metrology region, M_REGION_ANGLE returns an explicit angle value, in degrees.

For a derived metrology region, use M_REGION_ANGLE_TYPE to determine whether M_REGION_ANGLE returns the label of the feature used to establish the angle, or an explicit angle value, in degrees.

(summarize)
Collapse M_REGION_ANGLE_END

Inquires the end angle of the metrology region. M_REGION_ANGLE_END applies to M_ARC and M_RING_SECTOR metrology regions. SET SET SET SET

(summarize)
Collapse Value

Specifies the end angle.

For an explicitly-defined or graphics list metrology region, M_REGION_ANGLE_END returns an explicit angle value, in degrees.

For a derived metrology region, use M_REGION_ANGLE_END_TYPE to determine whether M_REGION_ANGLE_END returns the label of the feature used to establish the angle, or an explicit angle value, in degrees.

(summarize)
Collapse M_REGION_ANGLE_END_TYPE

Inquires whether the end angle of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_ANGLE_END). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_ANGLE_START

Inquires the start angle of the metrology region. M_REGION_ANGLE_START applies to M_ARC and M_RING_SECTOR metrology regions. SET SET SET SET

(summarize)
Collapse Value

Specifies the start angle.

For an explicitly-defined or graphics list metrology region, M_REGION_ANGLE_START returns an explicit angle value, in degrees.

For a derived metrology region, use M_REGION_ANGLE_START_TYPE to determine whether M_REGION_ANGLE_START returns the label of the feature used to establish the angle, or an explicit angle value, in degrees.

(summarize)
Collapse M_REGION_ANGLE_START_TYPE

Inquires whether the start angle of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_ANGLE_START). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_ANGLE_TYPE

Inquires whether the angle of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_ANGLE). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_END

Inquires the derived metrology region's end point according to the specified feature. M_REGION_END applies to derived metrology regions with an M_SEGMENT geometry. SET

(summarize)
Collapse Label

Specifies the label of a point feature, which metrology uses to set the end point of the metrology region.
Collapse M_REGION_END_TYPE

Inquires whether the end point of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_END or M_REGION_END_X and M_REGION_END_Y). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_END_X

Inquires the X-coordinate of the metrology region's end point. M_REGION_END_X applies to M_SEGMENT metrology regions. SET SET SET

(summarize)
Collapse Value

Specifies the end point's X-coordinate.

For an explicitly-defined or graphics list metrology region, M_REGION_END_X returns an explicit coordinate value, in pixel or world units.

For a derived metrology region, use M_REGION_END_TYPE to determine whether M_REGION_END_X returns the label of the feature used to establish the end point, or an explicit coordinate value, in pixel or world units.

(summarize)
Collapse M_REGION_END_Y

Inquires the Y-coordinate of the metrology region's end point. M_REGION_END_Y applies to M_SEGMENT metrology regions. SET SET SET

(summarize)
Collapse Value

Specifies the end point's Y-coordinate.

For an explicitly-defined or graphics list metrology region, M_REGION_END_Y returns an explicit coordinate value, in pixel or world units.

For a derived metrology region, use M_REGION_END_TYPE to determine whether M_REGION_END_Y returns the label of the feature used to establish the end point, or an explicit coordinate value, in pixel or world units.

(summarize)
Collapse M_REGION_HEIGHT

Inquires the height of the metrology region. M_REGION_HEIGHT applies to M_RECTANGLE metrology regions. SET SET SET

(summarize)
Collapse Value

Specifies the height.

For an explicitly-defined or graphics list metrology region, M_REGION_HEIGHT returns an explicit height value, in pixel or world units.

For a derived metrology region, use M_REGION_HEIGHT_TYPE to determine whether M_REGION_HEIGHT returns the label of the feature used to establish the height, or an explicit height value, in pixel or world units.

(summarize)
Collapse M_REGION_HEIGHT_TYPE

Inquires whether the height of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_HEIGHT). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_POSITION

Inquires the derived metrology region's position according to the specified feature. M_REGION_POSITION applies to derived metrology regions with any geometry except M_SEGMENT. SET

(summarize)
Collapse Label

Specifies the label of a point feature, which metrology uses to set the position of the metrology region.
Collapse M_REGION_POSITION_TYPE

Inquires whether the position of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_POSITION or M_REGION_POSITION_X and M_REGION_POSITION_Y). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_POSITION_X

Inquires the X-coordinate of the metrology region's position. M_REGION_POSITION_X applies to any geometry except M_SEGMENT, unless otherwise specified. SET SET SET SET SET SET SET

(summarize)
Collapse Value

Specifies the position's X-coordinate.

For an explicitly-defined or graphics list metrology region, M_REGION_POSITION_X returns an explicit coordinate value, in pixel or world units.

For a derived metrology region, use M_REGION_POSITION_TYPE to determine whether M_REGION_POSITION_X returns the label of the feature used to establish the position, or an explicit coordinate value, in pixel or world units.

(summarize)
Collapse M_REGION_POSITION_Y

Inquires the Y-coordinate of the metrology region's position. M_REGION_POSITION_Y applies to any geometry except M_SEGMENT, unless otherwise specified. SET SET SET SET SET SET SET

(summarize)
Collapse Value

Specifies the position's Y-coordinate.

For an explicitly-defined or graphics list metrology region, M_REGION_POSITION_Y returns an explicit coordinate value, in pixel or world units.

For a derived metrology region, use M_REGION_POSITION_TYPE to determine whether M_REGION_POSITION_Y returns the label of the feature used to establish the position, or an explicit coordinate value, in pixel or world units.

(summarize)
Collapse M_REGION_RADIUS

Inquires the radius of the metrology region. M_REGION_RADIUS applies to M_ARC. SET SET SET

(summarize)
Collapse Value

Specifies the radius.

For an explicitly-defined or graphics list metrology region, M_REGION_RADIUS returns an explicit radius value, in pixel or world units.

For a derived metrology region, use M_REGION_RADIUS_TYPE to determine whether M_REGION_RADIUS returns the label of the feature used to establish the radius, or an explicit radius value, in pixel or world units.

(summarize)
Collapse M_REGION_RADIUS_END

Inquires the end radius defining the metrology region. M_REGION_RADIUS_END applies to M_RING or M_RING_SECTOR. SET SET SET

(summarize)
Collapse Value

Specifies the end radius.

For an explicitly-defined metrology region, M_REGION_RADIUS_END returns an explicit radius value, in pixel or world units.

For a derived metrology region, use M_REGION_RADIUS_END_TYPE to determine whether M_REGION_RADIUS_END returns the label of the feature used to establish the end radius, or an explicit radius value, in pixel or world units.

(summarize)
Collapse M_REGION_RADIUS_END_TYPE

Inquires whether the end radius of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_RADIUS_END). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_RADIUS_START

Inquires the start radius defining the metrology region. M_REGION_RADIUS_START applies to M_RING or M_RING_SECTOR. SET SET SET

(summarize)
Collapse Value

Specifies the start radius.

For an explicitly-defined metrology region, M_REGION_RADIUS_START returns an explicit radius value, in pixel or world units.

For a derived metrology region, use M_REGION_RADIUS_START_TYPE to determine whether M_REGION_RADIUS_START returns the label of the feature used to establish the start radius, or an explicit radius value, in pixel or world units.

(summarize)
Collapse M_REGION_RADIUS_START_TYPE

Inquires whether the start radius of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_RADIUS_START). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_RADIUS_TYPE

Inquires whether the radius of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_RADIUS). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_START

Inquires the derived metrology region's start point according to the specified feature. M_REGION_START applies to derived metrology regions with an M_SEGMENT geometry. SET

(summarize)
Collapse Label

Specifies the label of a point feature, which metrology uses to set the start point of the metrology region.
Collapse M_REGION_START_TYPE

Inquires whether the start point of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_START or M_REGION_START_X and M_REGION_START_Y). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.
Collapse M_REGION_START_X

Inquires the X-coordinate of the metrology region's start point. M_REGION_START_X applies to M_SEGMENT. SET SET SET

(summarize)
Collapse Value

Specifies the start point's X-coordinate.

For an explicitly-defined or graphics list metrology region, M_REGION_START_X returns an explicit coordinate value, in pixel or world units.

For a derived metrology region, use M_REGION_START_TYPE to determine whether M_REGION_START_X returns the label of the feature used to establish the start point, or an explicit coordinate value, in pixel or world units.

(summarize)
Collapse M_REGION_START_Y

Inquires the Y-coordinate of the metrology region's start point. M_REGION_START_Y applies to M_SEGMENT. SET SET SET

(summarize)
Collapse Value

Specifies the start point's Y-coordinate.

For an explicitly-defined or graphics list metrology region, M_REGION_START_Y returns an explicit coordinate value, in pixel or world units.

For a derived metrology region, use M_REGION_START_TYPE to determine whether M_REGION_START_Y returns the label of the feature used to establish the start point, or an explicit coordinate value, in pixel or world units.

(summarize)
Collapse M_REGION_WIDTH

Inquires the width of the metrology region. M_REGION_WIDTH applies to M_RECTANGLE. SET SET SET

(summarize)
Collapse Value

Specifies the width.

For an explicitly-defined or graphics list metrology region, M_REGION_WIDTH returns an explicit width value, in pixel or world units.

For a derived metrology region, use M_REGION_WIDTH_TYPE to determine whether M_REGION_WIDTH returns the label of the feature used to establish the width, or an explicit width value, in pixel or world units.

(summarize)
Collapse M_REGION_WIDTH_TYPE

Inquires whether the width of the derived metrology region was specified with the label of a feature or an explicit value (M_REGION_WIDTH). SET

(summarize)
Collapse M_DEFAULT

Same as M_PARAMETRIC.
Collapse M_FEATURE_LABEL_VALUE

Specifies a feature.
Collapse M_PARAMETRIC

Specifies an explicit value.

To inquire about the geometric tolerance settings of a metrology context, set the InquireType parameter to one of the following values. For inquiring geometric tolerances, the LabelOrIndex parameter can be set to an existing tolerance label or index using M_TOLERANCE_LABEL() or M_TOLERANCE_INDEX().

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring geometric tolerance settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_GAIN +

Inquires the gain MIL uses to correct systematic bias between multiple imaging vision set-ups. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.0.
Collapse Value

Specifies the gain.
Collapse M_OFFSET +

Inquires the offset MIL uses to correct systematic bias between multiple imaging vision set-ups. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the offset.
Collapse M_TOLERANCE_TYPE +

Inquires the type of the geometric tolerance. SET

(summarize)
Collapse M_ANGULARITY

Specifies an angularity tolerance. INFO
Collapse M_CONCENTRICITY

Specifies a concentricity tolerance. INFO
Collapse M_DISTANCE_MAX

Specifies a maximum distance tolerance. INFO
Collapse M_DISTANCE_MIN

Specifies a minimum distance tolerance. INFO
Collapse M_LENGTH

Specifies a length tolerance. INFO
Collapse M_PARALLELISM

Specifies a parallelism tolerance. INFO
Collapse M_PERPENDICULARITY

Specifies a perpendicularity tolerance. INFO
Collapse M_POSITION_X

Specifies a positioning tolerance, along the X-direction of the specified reference frame. INFO
Collapse M_POSITION_Y

Specifies a positioning tolerance, along the Y-direction of the specified reference frame. INFO
Collapse M_RADIUS

Specifies a radius tolerance. INFO
Collapse M_ROUNDNESS

Specifies a roundness tolerance. INFO
Collapse M_STRAIGHTNESS

Specifies a straightness tolerance. INFO
Collapse M_VALUE_MAX +

Inquires the maximum possible value for a geometric tolerance. If a geometric tolerance value exceeds this maximum threshold, the calculation operation will fail and its status will be M_FAIL. The status of the calculation of a tolerance is found using MmetGetResult() with M_STATUS. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the maximum value.
Collapse M_VALUE_MIN +

Inquires the minimum required value for a geometric tolerance. If a geometric tolerance value does not meet this minimum requirement, the calculation operation will fail and its status will be M_FAIL. The status of the calculation of a tolerance is found using MmetGetResult() with M_STATUS. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the minimum value.
Collapse M_VALUE_WARNING_MAX +

Inquires the maximum warning value for a geometric tolerance. Geometric tolerance values that are greater or equal to M_VALUE_MIN and lower than M_VALUE_WARNING_MIN will result in a warning. Geometric tolerance values that are lower or equal to M_VALUE_MAX and greater than M_VALUE_WARNING_MAX will also result in a warning. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the maximum warning value.
Collapse M_VALUE_WARNING_MIN +

Inquires the minimum warning value for a geometric tolerance. Geometric tolerance values that are greater or equal to M_VALUE_MIN and lower than M_VALUE_WARNING_MIN will result in a warning. Geometric tolerance values that are lower or equal to M_VALUE_MAX and greater than M_VALUE_WARNING_MAX will also result in a warning. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0.
Collapse Value

Specifies the minimum warning value.

To inquire the label or index of a feature or geometric tolerance, set the InquireType parameter to the following value.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring the label or index of a feature or geometric tolerance
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_BASE_FEATURE_LABEL(n) +

Inquires the label value of the n th feature used to build the selected constructed feature or tolerance; n is between 0 and M_BASE_FEATURES_ARRAY_SIZE minus one. SET

(summarize)
Collapse Value

Specifies the label.
Collapse M_BASE_FEATURES_ARRAY_SIZE +

Inquires the number of elements in the feature array, specified using MmetAddFeature() with FeatureLabelArrayPtr.

(summarize)
Collapse Value

Specifies the number of elements in the feature array.
Collapse M_BASE_SUBFEATURE_INDEX(n) +

Inquires the index of the n th subfeature used to build the selected constructed feature or tolerance; n is between 0 and M_BASE_SUBFEATURES_ARRAY_SIZE minus one. SET

(summarize)
Collapse Value

Specifies the index.
Collapse M_BASE_SUBFEATURES_ARRAY_SIZE +

Inquires the number of elements in the subfeature array, specified using MmetAddFeature() with SubFeatureIndexArrayPtr.

(summarize)
Collapse Value

Specifies the number of elements in the subfeature array.
Collapse M_INDEX_FROM_LABEL +

Inquires the index associated with the specified label, if the label is used. Pass the label of either a feature or tolerance using the LabelOrIndex parameter set to M_FEATURE_LABEL() or M_TOLERANCE_LABEL(), respectively.

(summarize)
Collapse M_INVALID

Specifies that the label is not associated with any feature (M_FEATURE_LABEL()) or any tolerance (M_TOLERANCE_LABEL()).
Collapse Value

Specifies the index that is associated with the specified label.
Collapse M_LABEL_VALUE +

Inquires the label value of a specified feature or tolerance. For inquiring the feature's label, the LabelOrIndex parameter can be set to M_FEATURE_INDEX() or M_GLOBAL_FRAME. For inquiring the tolerance's label, the LabelOrIndex parameter can be set to M_TOLERANCE_INDEX().

(summarize)
Collapse Value

Specifies the label value of the specified feature or tolerance.

To inquire about features or geometric tolerances of a metrology context, you can set the InquireType parameter to one of the following values. In this case, the LabelOrIndex parameter must be set to M_CONTEXT and the MetId parameter must be set to a metrology context.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring about features or geometric tolerances
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_ANGLE

Inquires the angle used to construct a feature or define a tolerance, when applicable. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0°.
Collapse Value

Specifies the angle. INFO
Collapse M_DRAWABLE

Inquires whether the feature or tolerance will be drawn using MmetDraw(). SET

(summarize)
Collapse M_DISABLE

Specifies that the feature or tolerance will not be drawn. INFO
Collapse M_ENABLE

Specifies that the feature or tolerance will be drawn.

To inquire about the clone transformation settings used for a cloned feature in a metrology result buffer, set the InquireType parameter to one of the following values. For inquiring clone transformations, the LabelOrIndex parameter must be set to an existing feature label or index using M_FEATURE_LABEL() or M_FEATURE_INDEX().

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring clone transformations settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_CLONE_ANGLE +

Inquires the rotation angle of the cloned feature in the counterclockwise direction. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0°.
Collapse 0.0 <= Value <= 360.0

Specifies the angle, in degrees.
Collapse M_CLONE_OFFSET_X +

Inquires the translation value of the cloned feature, in the X-direction. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0pixels.
Collapse Value

Specifies the X-offset for the cloned feature, in pixel or world units.
Collapse M_CLONE_OFFSET_Y +

Inquires the translation value of the cloned feature, in the Y-direction. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.0pixels.
Collapse Value

Specifies the Y-offset for the cloned feature, in pixel or world units.
Collapse M_CLONE_SCALE +

Inquires the scale factor of the cloned feature. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.0.
Collapse Value > 0.0

Specifies the scale factor.

To inquire about the results calculated for a metrology result buffer, set the InquireType parameter to one of the following values. For inquiring result buffer settings, the LabelOrIndex parameter must be set to M_GENERAL.

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.

function map For inquiring result buffer settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_OUTPUT_FRAME +

Inquires the output reference frame that will be used to return the feature results. SET

(summarize)
Collapse M_DEFAULT

Same as M_GLOBAL_FRAME.
Collapse M_GLOBAL_FRAME

Specifies that MIL returns feature results relative to the origin of the global frame. INFO
Collapse M_IMAGE_FRAME

Specifies that MIL returns feature results relative to the origin of the target image's reference frame. INFO
Collapse M_REFERENCE_FRAME

Specifies that MIL returns feature results relative to the reference frame of each feature. INFO
Collapse Label

Specifies the label of an existing local frame feature to use to return feature results.
Collapse M_RESULT_OUTPUT_UNITS +

Inquires whether results are returned in pixel or world units. SET

(summarize)
Collapse M_DEFAULT

Same as M_ACCORDING_TO_CALIBRATION.
Collapse M_ACCORDING_TO_CALIBRATION

Specifies that results are returned in world units if the result was calculated on an image associated with a calibration context; otherwise, specifies that results are returned in pixel units.
Collapse M_PIXEL

Specifies that results are returned in pixel units, with respect to the pixel coordinate system.
Collapse M_WORLD

Specifies that results are returned in world units, with respect to the relative coordinate system. INFO
Combination constant for the values listed in all the parameter association tables except For inquiring the geometry of the metrology region, For inquiring the geometry data of the metrology region, For inquiring about features or geometric tolerances.

You can add the following value to the above-mentioned values to determine the default value of an inquire type, regardless of the current value of the inquire type.

function map For inquiring the default value of an inquire type
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_DEFAULT

Inquires the default value of the specified inquire type.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Combination constant for the values listed in all the parameter association tables except For inquiring the geometry of the metrology region, For inquiring the geometry data of the metrology region, For inquiring about features or geometric tolerances.

You can add the following value to the above-mentioned values to determine whether a result is supported.

function map For inquiring whether an inquire type is supported
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_SUPPORTED

Inquires whether the specified inquire type is supported for the metrology context.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_NULL

Specifies that the inquire type is not supported.
Collapse Value != 0

Specifies that the inquire type is supported.
Combination constants for the values listed in all the parameter association tables except For inquiring the geometry of the metrology region, For inquiring the geometry data of the metrology region, For inquiring about features or geometric tolerances.

You can add one of the following values to the above-mentioned values to cast the requested information to a required data type.

function map For specifying the data type
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse M_TYPE_MIL_ID

Casts the requested information to a MIL_ID. Note that M_TYPE_MIL_ID should only be used with M_OWNER_SYSTEM.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_ID

Collapse M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT

Collapse M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT32

Collapse M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_INT64

Return value
The returned value is the requested information, cast to a MIL_INT.
Compilation information
Header Include mil.h.
Library Use mil.lib; milmetrol.lib.
DLL Requires mil.dll; milmetrol.dll.
DEFAULT CONTEXT DERIVED GEOMETRY REGION GENERAL GLOBAL FRAME ASSOCIATED CALIBRATION NULL MODIFICATION COUNT NUMBER OF CONSTRUCTED FEATURES NUMBER OF FEATURES NUMBER OF MEASURED FEATURES NUMBER OF TOLERANCES TEMPLATE REFERENCE ID NULL TEMPLATE REFERENCE SIZE BAND TEMPLATE REFERENCE SIZE X TEMPLATE REFERENCE SIZE Y TEMPLATE REFERENCE TYPE TIMEOUT DEFAULT DISABLE OWNER SYSTEM DEFAULT HOST CHAIN ALL NEIGHBORS DEFAULT DISABLE ENABLE EXTRACTION SCALE DEFAULT FILTER SMOOTHNESS DEFAULT FILTER TYPE DEFAULT DERICHE FREI CHEN PREWITT SHEN SOBEL FLOAT MODE DEFAULT DISABLE ENABLE MAGNITUDE TYPE DEFAULT NORM SQR NORM REGION ACCURACY HIGH DEFAULT DISABLE ENABLE THRESHOLD MODE DEFAULT DISABLE HIGH LOW MEDIUM USER DEFINED VERY HIGH THRESHOLD TYPE DEFAULT FULL HYSTERESIS HYSTERESIS NO HYSTERESIS THRESHOLD VALUE HIGH DEFAULT THRESHOLD VALUE LOW DEFAULT ANGLE END DEFAULT ANGLE START DEFAULT DEPENDENCIES FALSE TRUE EDGEL ANGLE RANGE DEFAULT EDGEL RELATIVE ANGLE DEFAULT REVERSE SAME SAME OR REVERSE EDGEL SELECTION RANK DEFAULT DISABLE LAST EDGEL TYPE DEFAULT ACTIVE EDGELS ALL EDGELS FITTED EDGELS FEATURE GEOMETRY ARC ARC CIRCLE CIRCLE EDGEL EDGEL LINE LOCAL FRAME POINT POINT SEGMENT SEGMENT FEATURE TYPE CONSTRUCTED MEASURED FIT COVERAGE MIN DEFAULT FIT DISTANCE MAX DEFAULT INFINITE FIT ITERATIONS MAX DEFAULT AUTO FIT VARIATION MAX DEFAULT AUTO LINE A DEFAULT LINE B DEFAULT LINE C DEFAULT NUMBER MAX DEFAULT NUMBER MIN DEFAULT OCCURRENCE DEFAULT OPERATION DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT DEFAULT ANGLE ANGLE ABSOLUTE ANGLE RELATIVE BISECTOR CENTER CLONE FEATURE CLONE FEATURE CLONE FEATURE CLONE FEATURE CLONE FEATURE CLONE FEATURE CLONE FEATURE CLOSEST CONSTRUCTION CONSTRUCTION CONSTRUCTION CONSTRUCTION CONSTRUCTION COPY FEATURE EDGELS EXTENDED INTERSECTION FIT FIT FIT FIT FIT FIT FIT FIT INNER FIT INNER FIT INNER FIT INNER FIT INTERSECTION MAX DISTANCE POINT MIDDLE OUTER FIT OUTER FIT OUTER FIT OUTER FIT PARALLEL PARAMETRIC PARAMETRIC PARAMETRIC PARAMETRIC PARAMETRIC PARAMETRIC PERPENDICULAR POSITION ABSOLUTE POSITION END POSITION RELATIVE POSITION START SECTOR RELATIVE POSITION DEFAULT POSITION END X DEFAULT POSITION END Y DEFAULT POSITION START X DEFAULT POSITION START Y DEFAULT POSITION X DEFAULT POSITION Y DEFAULT RADIUS DEFAULT REFERENCE FRAME DEFAULT SORT DEFAULT SORT DOWN SORT UP REGION GEOMETRY DEFAULT ARC INFINITE RECTANGLE RING RING SECTOR SEGMENT REGION ANGLE REGION ANGLE END REGION ANGLE END TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION ANGLE START REGION ANGLE START TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION ANGLE TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION END REGION END TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION END X REGION END Y REGION HEIGHT REGION HEIGHT TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION POSITION REGION POSITION TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION POSITION X REGION POSITION Y REGION RADIUS REGION RADIUS END REGION RADIUS END TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION RADIUS START REGION RADIUS START TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION RADIUS TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION START REGION START TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC REGION START X REGION START Y REGION WIDTH REGION WIDTH TYPE DEFAULT FEATURE LABEL VALUE PARAMETRIC GAIN DEFAULT OFFSET DEFAULT TOLERANCE TYPE ANGULARITY CONCENTRICITY DISTANCE MAX DISTANCE MIN LENGTH PARALLELISM PERPENDICULARITY POSITION X POSITION Y RADIUS ROUNDNESS STRAIGHTNESS VALUE MAX DEFAULT VALUE MIN DEFAULT VALUE WARNING MAX DEFAULT VALUE WARNING MIN DEFAULT BASE FEATURE LABEL(n) BASE FEATURES ARRAY SIZE BASE SUBFEATURE INDEX(n) BASE SUBFEATURES ARRAY SIZE INDEX FROM LABEL INVALID LABEL VALUE ANGLE DEFAULT DRAWABLE DISABLE ENABLE CLONE ANGLE DEFAULT CLONE OFFSET X DEFAULT CLONE OFFSET Y DEFAULT CLONE SCALE DEFAULT OUTPUT FRAME DEFAULT GLOBAL FRAME IMAGE FRAME REFERENCE FRAME RESULT OUTPUT UNITS DEFAULT ACCORDING TO CALIBRATION PIXEL WORLD DEFAULT SUPPORTED NULL TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 CONTEXT DEFAULT DERIVED GEOMETRY REGION GENERAL FEATURE INDEX FEATURE LABEL FEATURE INDEX FEATURE LABEL GLOBAL FRAME TOLERANCE INDEX TOLERANCE LABEL