| MIL 10 Reference
| Customize Help
| Save Settings

MbeadInquire


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
MbeadGetResult
MbeadRestore
Synopsis
Inquire information about a bead context, template, or result.
Syntax
MIL_INT MbeadInquire(
MIL_ID ContextOrResultBeadId, //in
MIL_INT LabelOrIndex, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a specified bead context, a template contained within the context, or a bead result buffer. You can also use this function to inquire about operations performed with MbeadGetNeighbors(). Values are returned in the unit in which they were set (that is, either pixel or world units), using MbeadControl() and M_..._INPUT_UNITS.

If the inquired setting is set to M_DEFAULT (for example, in MbeadControl()), MbeadInquire() 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
ContextOrResultBeadId

Specifies the identifier of the bead context or the identifier of the bead result buffer about which to inquire. Both the bead context and result buffer must have been previously allocated on the required system using MbeadAlloc() or MbeadAllocResult(), respectively.

LabelOrIndex

Specifies the bead template about which to inquire, or specifies that you are inquiring about a global setting of the bead context or result. Unless otherwise specified, the LabelOrIndex parameter values require that the ContextOrResultBeadId parameter specifies the identifier of a bead context.

This parameter can be set to one of the following values:

function map For specifying what to inquire about
CollapseValue Description
Collapse M_DEFAULT

Specifies the default.

If ContextOrResultBeadId is set to a bead context, the default is the same as M_CONTEXT.

If ContextOrResultBeadId is set to a bead result, the default is the same as M_GENERAL.

(summarize)
Collapse

Specifies the index of an existing template about which to inquire.

(summarize)
Parameters

Specifies the index. The index must be greater than or equal to 0.
Collapse

Specifies the label of an existing template about which to inquire.

(summarize)
Parameters

Specifies the label. The label must be greater than 0.
Collapse M_CONTEXT

Inquires information about a global setting of a bead context.
Collapse M_GENERAL

Inquires information about a setting of a bead result buffer. When using M_GENERAL, ContextOrResultBeadId must specify a bead result buffer.

(summarize)
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):
  • array of type MIL_DOUBLE
  • array of type MIL_ID
  • array of type MIL_INT
  • array of type MIL_INT32
  • array of type MIL_INT64
  • 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 a bead template setting for the training phase, the InquireType parameter can be set to one of the following values. In this case, you must set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to a specific template, using either M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL().

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

function map To inquire about a bead template setting for the training phase
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_INDIVIDUAL_WIDTH_NOMINAL +

Inquires the specified width of the template at the position of each of its vertices. This value applies only to templates whose path follows a polyline. SET

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_DOUBLE
Array size: Use M_SIZE to determine the size of the array necessary to hold the width information.

Collapse Value

Specifies the width.
Collapse M_INTENSITY_NOMINAL_MODE +

Inquires how to establish the nominal pixel intensity of the template. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_AUTO

Specifies to establish the nominal pixel intensity from the training image.
Collapse M_DISABLE

Specifies that M_INTENSITY_NOMINAL_MODE has no effect.
Collapse M_USER_DEFINED

Specifies that you will explicitly set the pixel intensity, using M_INTENSITY_NOMINAL.
Collapse M_POSITION_X +

Inquires the X-coordinates of the vertices in a template whose path follows a polyline. You can add, delete, or modify a template's vertices using MbeadTemplate(). SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_DOUBLE
Array size: Use M_SIZE to determine the size of the array necessary to hold the X-coordinate information.

Collapse Value

Specifies the X-coordinates of the template's vertices.
Collapse M_POSITION_Y +

Inquires the Y-coordinates of the vertices in a template whose path follows a polyline. You can add, delete, or modify a template's vertices using MbeadTemplate(). SET SET

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_DOUBLE
Array size: Use M_SIZE to determine the size of the array necessary to hold the Y-coordinate information.

Collapse Value

Specifies the Y-coordinates of the template's vertices.
Collapse M_SIZE +

Inquires the number of vertices in a template whose path follows a polyline. You can add, delete, or modify a template's vertices using MbeadTemplate(). SET SET

(summarize)
Collapse Value

Specifies the number of points.
Collapse M_TEMPLATE_CIRCLE_CENTER_X +

Inquires the X-coordinate of the center of a template whose path follows a circle. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the center's X-coordinate, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_TEMPLATE_CIRCLE_CENTER_Y +

Inquires the Y-coordinate of the center of a template whose path follows a circle. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the center's Y-coordinate, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_TEMPLATE_CIRCLE_RADIUS +

Inquires the radius of a template whose path follows a circle. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the radius, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_TEMPLATE_INPUT_UNITS +

Inquires the units with which to interpret the M_CLOSEST_POINT_MAX_DISTANCE, M_FAIL_WARNING_OFFSET, M_GAP_MAX_LENGTH, M_OFFSET_MAX, M_TEMPLATE_CIRCLE_CENTER_X, M_TEMPLATE_CIRCLE_CENTER_Y, M_TEMPLATE_CIRCLE_RADIUS, M_TEMPLATE_SEGMENT_END_X, M_TEMPLATE_SEGMENT_END_Y, M_TEMPLATE_SEGMENT_START_X, M_TEMPLATE_SEGMENT_START_Y, M_WIDTH_DELTA_NEG, M_WIDTH_DELTA_POS, and M_WIDTH_NOMINAL inquire types, as well as the units with which to interpret the template's position and dimension values specified using MbeadTemplate(). This essentially inquires the input coordinate system used. SET

(summarize)
Collapse M_DEFAULT

Same as M_PIXEL.
Collapse M_PIXEL

Specifies to interpret the values in pixel units, with respect to the pixel coordinate system.
Collapse M_WORLD

Specifies to interpret the values in world units, with respect to the relative coordinate system. INFO
Collapse M_TEMPLATE_SEGMENT_END_X +

Inquires the X-coordinate of the end of a template whose path follows a segment. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the X-coordinate of the end of the segment, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_TEMPLATE_SEGMENT_END_Y +

Inquires the Y-coordinate of the end of a template whose path follows a segment. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the Y-coordinate of the end of the segment, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_TEMPLATE_SEGMENT_START_X +

Inquires the X-coordinate of the start of a template whose path follows a segment. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the X-coordinate of the start of the segment, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_TEMPLATE_SEGMENT_START_Y +

Inquires the Y-coordinate of the start of a template whose path follows a segment. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the Y-coordinate of the start of the segment, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_TRAINING_BOX_HEIGHT +

Inquires the height of the search boxes. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the height, relative to the input coordinate system specified using M_TRAINING_BOX_INPUT_UNITS.
Collapse M_TRAINING_BOX_INPUT_UNITS +

Inquires the units with which to interpret the M_TRAINING_BOX_HEIGHT, M_TRAINING_BOX_WIDTH, M_TRAINING_BOX_SPACING, and M_TRAINING_WIDTH_NOMINAL inquire types. SET

(summarize)
Collapse M_DEFAULT

Same as M_PIXEL.
Collapse M_PIXEL

Specifies to interpret the values in pixel units, with respect to the pixel coordinate system.
Collapse M_WORLD

Specifies to interpret the values in world units, with respect to the relative coordinate system. INFO
Collapse M_TRAINING_BOX_SPACING +

Inquires the distance between the search boxes. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 10.0.
Collapse M_DISABLE

Specifies that M_TRAINING_BOX_SPACING has no effect. INFO
Collapse Value > 0.0

Specifies the spacing, relative to the input coordinate system specified using M_TRAINING_BOX_INPUT_UNITS.
Collapse M_TRAINING_BOX_WIDTH +

Inquires the width of the search boxes. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the width, relative to the input coordinate system specified using M_TRAINING_BOX_INPUT_UNITS.
Collapse M_TRAINING_PATH +

Inquires how MIL establishes the path of the bead template. SET

(summarize)
Collapse M_DEFAULT

Same as M_POLYLINE_SEED.
Collapse M_CIRCLE

Specifies that the path of the bead template follows a fixed circle defined with M_TEMPLATE_CIRCLE_CENTER_X, M_TEMPLATE_CIRCLE_CENTER_Y, and M_TEMPLATE_CIRCLE_RADIUS. INFO
Collapse M_POLYLINE

Specifies that the path of the bead template follows a fixed polyline. INFO
Collapse M_POLYLINE_SEED

Specifies that the path of the bead template follows a polyline that is refined by the training image set with MbeadTrain(). INFO
Collapse M_SEGMENT

Specifies that the path of the bead template follows a fixed segment defined with M_TEMPLATE_SEGMENT_START_X, M_TEMPLATE_SEGMENT_START_Y, M_TEMPLATE_SEGMENT_END_X, and M_TEMPLATE_SEGMENT_END_Y. INFO
Collapse M_TRAINING_WIDTH_NOMINAL +

Inquires the width with which to validate the template's automatically established nominal width. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that M_TRAINING_WIDTH_NOMINAL has no effect.
Collapse Value > 0.0

Specifies the width, relative to the input coordinate system specified using M_TRAINING_BOX_INPUT_UNITS.
Collapse M_TRAINING_WIDTH_SCALE_MAX +

Inquires the scale factor by which to determine the upper limit (maximum permitted scale) of the bead width. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 1.2.
Collapse M_DISABLE

Specifies that M_TRAINING_WIDTH_SCALE_MAX has no effect.
Collapse Value > 0.0

Specifies the maximum scale factor. INFO
Collapse M_TRAINING_WIDTH_SCALE_MIN +

Inquires the scale factor by which to determine the lower limit (minimum permitted scale) of the bead width. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 0.8.
Collapse M_DISABLE

Specifies that M_TRAINING_WIDTH_SCALE_MIN has no effect.
Collapse Value > 0.0

Specifies the minimum scale factor. INFO
Collapse M_WIDTH_NOMINAL +

Inquires the nominal width to use, when it is explicitly defined. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the nominal width, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_WIDTH_NOMINAL_MODE +

Inquires how to establish the nominal width of the bead template. SET

(summarize)
Collapse M_DEFAULT

Same as M_AUTO_UNIFORM.
Collapse M_AUTO_CONTINUOUS

Specifies that the bead's nominal width is automatically established with MbeadTrain(), where the corresponding width at each vertex in the template can have its own unique value. INFO
Collapse M_AUTO_UNIFORM

Specifies that the bead's nominal width is automatically established with MbeadTrain(), where the corresponding width at all of the template's vertices must have the same value. INFO
Collapse M_USER_DEFINED

Specifies that you must explicitly set the bead's nominal width. INFO

To inquire about a bead template setting for the training and verification phases, the InquireType parameter can be set to one of the following values. In this case, you must set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to a specific template, using either M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL().

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

function map To inquire about a bead template setting for the training and verification phases
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_FOREGROUND_VALUE +

Inquires whether the foreground of the measured bead should be darker or lighter than the background. SET

(summarize)
Collapse M_DEFAULT

Same as M_FOREGROUND_WHITE.
Collapse M_FOREGROUND_BLACK

Specifies that the foreground is darker than the background. INFO
Collapse M_FOREGROUND_WHITE

Specifies that the foreground is lighter than the background. INFO
Collapse M_SMOOTHNESS +

Inquires the degree of noise reduction that MIL uses when performing the edge extraction of the bead from an image. 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_THRESHOLD_MODE +

Inquires how to establish the threshold that MIL must use when performing the edge extraction of the bead from an image. SET

(summarize)
Collapse M_DEFAULT

Same as M_USER_DEFINED.
Collapse M_USER_DEFINED

Specifies that the threshold is explicitly defined with M_THRESHOLD_VALUE.
Collapse M_THRESHOLD_VALUE +

Inquires the value beneath which a grayscale variation within the image is not considered an edge of the bead. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the threshold value. INFO

To inquire about a trained setting of a bead template, the InquireType parameter can be set to one of the following values. In this case, you must set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to a specific template, using either M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL().

MIL typically bases trained values on their related training values and modifies them accordingly when you call MbeadTrain(). For example, MIL adjusts the specified spacing for the search boxes (M_TRAINING_BOX_SPACING) to achieve an even distribution of search boxes along the template's path (M_TRAINED_BOX_SPACING). If you do not retrain the templates, the trained value represents the value MIL uses for verification.

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

function map To inquire about a trained setting of a bead template
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_TRAINED_BOX_HEIGHT +

Inquires the trained height of the search boxes. MIL bases this value on M_TRAINING_BOX_HEIGHT and internally modifies it during the training phase to achieve the best possible trained height.

(summarize)
Collapse Value

Specifies the trained height of the search boxes.
Collapse M_TRAINED_BOX_SPACING +

Inquires the trained distance between the search boxes in which to establish the trained points. MIL bases this value on M_TRAINING_BOX_SPACING and internally modifies it during the training phase to achieve an even distribution of trained search boxes.

(summarize)
Collapse Value

Specifies the trained distance between the search boxes.
Collapse M_TRAINED_BOX_WIDTH +

Inquires the trained width of the search boxes. MIL bases this value on a variety of settings, such as M_TRAINING_BOX_WIDTH, to achieve the best possible trained width.

(summarize)
Collapse Value

Specifies the trained width of the search boxes.
Collapse M_TRAINED_INDIVIDUAL_WIDTH_NOMINAL +

Inquires the trained width of the template at the position of each individual trained point. MIL bases this value on a variety of settings, such as M_WIDTH_..., to achieve the best possible trained widths.

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_DOUBLE
Array size: Use M_TRAINED_SIZE to determine the size of the array necessary to hold the width information.

Collapse Value

Specifies the trained width for each trained point.
Collapse M_TRAINED_POSITION_X +

Inquires the trained X-position of the trained points. MIL bases this value on a variety of settings, such as M_TRAINING_PATH, to achieve the best possible trained positions.

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_DOUBLE
Array size: Use M_TRAINED_SIZE to determine the size of the array necessary to hold the X-coordinate information.

Collapse Value > 0

Specifies the trained X-position for each trained point.
Collapse M_TRAINED_POSITION_Y +

Inquires the trained Y-position of the trained points. MIL bases this value on a variety of settings, such as M_TRAINING_PATH, to achieve the best possible trained positions.

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_DOUBLE
Array size: Use M_TRAINED_SIZE to determine the size of the array necessary to hold the Y-coordinate information.

Collapse Value > 0

Specifies the trained Y-position for each trained point.
Collapse M_TRAINED_SIZE +

Inquires the number of trained points. MIL considers the number of trained points in a template to be its size.

(summarize)
Collapse Value > 0

Specifies the number of trained points.
Collapse M_TRAINED_WIDTH_NOMINAL +

Inquires the trained nominal width of the template. MIL bases this value on a variety of settings, such as M_WIDTH_NOMINAL_MODE, to achieve the best possible trained nominal width.

(summarize)
Collapse Value

Specifies the trained nominal width of the bead.

To inquire about a bead template setting for the verification phase, the InquireType parameter can be set to one of the following values. In this case, you must set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to a specific template, using either M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL().

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

function map To inquire about a bead template setting for the verification phase
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_ACCEPTANCE +

Inquires the acceptance level for the score of the template's corresponding measured bead. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the acceptance level, as a percentage. INFO
Collapse M_ANGLE_ACCURACY_MAX_DEVIATION +

Inquires the maximum angular deviation from the automatically established angle with which to verify the width of the template's measured bead. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the angular deviation, in degrees. INFO
Collapse M_BOX_WIDTH_MARGIN +

Inquires the additional width for the search boxes used to verify the template's measured bead. SET

(summarize)
Collapse M_DEFAULT

Specifies the default value; the default value is 50.0%.
Collapse Value >= 0.0

Specifies the additional width used for verification, as a percentage.
Collapse M_FAIL_WARNING_OFFSET +

Inquires the additional width specified for the search box where a measured point can be found, but will have a failed status. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the width, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_GAP_MAX_LENGTH +

Inquires the maximum allowable length of one single gap, for the template's measured bead to have a passing status. SET

(summarize)
Collapse M_DEFAULT

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

Specifies that M_GAP_MAX_LENGTH has no effect.
Collapse Value >= 0.0

Specifies the maximum gap length, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS. INFO
Collapse M_GAP_TOLERANCE +

Inquires the percentage of the total allowable gaps (all gaps added together), for the template's measured bead to have a passing status. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the total allowable gaps, as a percentage. INFO
Collapse M_INTENSITY_DELTA_NEG +

Inquires the lowest pixel intensity that is considered valid for the template's measured bead, relative to M_INTENSITY_NOMINAL. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the lowest valid pixel intensity.
Collapse M_INTENSITY_DELTA_POS +

Inquires the highest pixel intensity that is considered valid for the template's measured bead, relative to M_INTENSITY_NOMINAL. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the highest valid pixel intensity.
Collapse M_INTENSITY_NOMINAL +

Inquires the nominal pixel intensity of the template's measured bead. SET

(summarize)
Collapse M_DEFAULT

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

Specifies the nominal pixel intensity.
Collapse M_OFFSET_MAX +

Inquires the maximum allowable distance between the position of the trained points in the template, and the position of the measured points in the target, for the measured bead to have a passing status. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that M_OFFSET_MAX has no effect.
Collapse Value > 0.0

Specifies the allowable offset, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_WIDTH_DELTA_NEG +

Inquires the valid delta negative tolerance between the width of the measured bead and the width of the template, for the measured bead to have a passing status. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that M_WIDTH_DELTA_NEG has no effect.
Collapse Value > 0.0

Specifies the tolerance, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.
Collapse M_WIDTH_DELTA_POS +

Inquires the valid delta positive tolerance between the width of the measured bead and the width of the template, for the measured bead to have a passing status. SET

(summarize)
Collapse M_DEFAULT

Same as M_DISABLE.
Collapse M_DISABLE

Specifies that M_WIDTH_DELTA_POS has no effect.
Collapse Value > 0.0

Specifies the tolerance, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.

To inquire about a global bead template setting, the InquireType parameter can be set to one of the following values. In this case, you must set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to a specific template, using either M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL(), unless otherwise specified.

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

function map To inquire about a global setting of a bead template
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_BEAD_TYPE +

Inquires the type of the bead. SET

(summarize)
Collapse M_DEFAULT

Specifies the default type. INFO
Collapse M_BEAD_EDGE

Specifies a bead template consisting of an edge. INFO
Collapse M_BEAD_STRIPE

Specifies a bead template consisting of a stripe. INFO
Collapse M_INDEX_VALUE +

Inquires the index associated with the template. In this case, you must set the LabelOrIndex parameter to the label of a template.

(summarize)
Collapse M_INVALID

Specifies that the template label you specified is not valid (not associated with a template).
Collapse Value >= 0

Specifies the index value associated with the specified template label.
Collapse M_LABEL_VALUE +

Inquires the label that MIL automatically associated with the template when it was added to the context. In this case, you must set the LabelOrIndex parameter to the index of a template.

(summarize)
Collapse Value > 0

Specifies the label.

To inquire about a global setting of a bead context, the InquireType parameter can be set to one of the following values. In this case, you must set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to M_CONTEXT.

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

function map To inquire about a global setting of a bead context
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_ASSOCIATED_CALIBRATION +

Inquires the calibration context associated with the training image. SET

(summarize)
Collapse M_DEFAULT

Same as M_NULL.
Collapse M_NULL

Specifies that there is no calibration context that has been associated with the training image using M_ASSOCIATED_CALIBRATION.
Collapse MIL Calibration context identifier

Specifies the calibration context that is associated with the training image.
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 current value of the modification counter.
Collapse M_NUMBER_OF_TEMPLATES +

Inquires the number of templates in the bead context. To add and remove templates, use MbeadTemplate().

(summarize)
Collapse Value

Specifies the number of templates.
Collapse M_STATUS +

Inquires the training status of the bead context. MIL establishes the status after the last call to MbeadTrain() (using the most current settings of the bead module).

(summarize)
Collapse M_COMPLETE

Specifies that the context is completely trained. This indicates that each template in the context is trained.

(summarize)
Collapse M_NOT_TRAINED

Specifies that the context is not completely trained. This indicates that there are one or more templates in the context that are not trained.

(summarize)
Collapse M_PARTIAL

Specifies that the context is partially trained. This indicates that all templates in the context are either partially trained, or both partially and completely trained. M_PARTIAL can also indicate that one or more sections of one or more templates were not found in the training image.

(summarize)
Collapse M_TRAINING_IMAGE_SIZE_X +

Inquires the width of the internally saved training image (MbeadTrain() with M_SAVE_TRAINING_IMAGE).

(summarize)
Collapse 0

Specifies that there is no training image.
Collapse Value

Specifies the width of the training image.
Collapse M_TRAINING_IMAGE_SIZE_Y +

Inquires the height of the internally saved training image (MbeadTrain() with M_SAVE_TRAINING_IMAGE).

(summarize)
Collapse 0

Specifies that there is no training image.
Collapse Value

Specifies the height of the training image.
Collapse M_TRAINING_IMAGE_TYPE +

Inquires the data type and data depth of the internally saved training image (MbeadTrain() with M_SAVE_TRAINING_IMAGE).

(summarize)
Collapse M_NULL

Specifies that there is no training image.
Collapse M_UNSIGNED + 8

Specifies that the training image is 8-bit unsigned.

To inquire about a global setting of a bead context or bead result buffer, the InquireType parameter can be set to the following value. When inquiring about a bead context, set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to M_CONTEXT. When inquiring about a bead result buffer, set the ContextOrResultBeadId parameter to the identifier of a bead result buffer, and the LabelOrIndex parameter to M_GENERAL.

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

function map To inquire about a global setting of a bead context or bead result buffer
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_OWNER_SYSTEM +

Inquires the identifier of the system on which either the bead context or bead result buffer has been allocated. SET 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 settings for operations with MbeadGetNeighbors(), the InquireType parameter can be set to the following value. In this case, you must set the ContextOrResultBeadId parameter to the identifier of a bead context, and the LabelOrIndex parameter to M_CONTEXT.

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

function map To inquire about settings for operations with MbeadGetNeighbors()
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_CLOSEST_POINT_MAX_DISTANCE +

Inquires the maximum distance specified for the M_CLOSEST_... operations in MbeadGetNeighbors(). SET

(summarize)
Collapse M_DEFAULT

Same as M_INFINITE.
Collapse M_INFINITE

Specifies that the maximum distance is infinite.
Collapse Value > 0.0

Specifies the maximum distance, relative to the input coordinate system specified using M_TEMPLATE_INPUT_UNITS.

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 To inquire about 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

You can add the following value to the above-mentioned values to determine whether an inquire type is supported.

function map To inquire 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 bead 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.

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 To specify 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
    Note: When a single inquire.

  • Data type: array of type MIL_DOUBLE
    Array size: Depends on the inquire type.
    Note: When multiple inquires.
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
    Note: When a single inquire.

  • Data type: array of type MIL_ID
    Array size: Depends on the inquire type.
    Note: When multiple inquires.
Collapse M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Collapse UserVarPtr data type info

  • Data type: MIL_INT
    Note: When a single inquire.

  • Data type: array of type MIL_INT
    Array size: Depends on the inquire type.
    Note: When multiple inquires.
Collapse M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Collapse UserVarPtr data type info

  • Data type: MIL_INT32
    Note: When a single inquire.

  • Data type: array of type MIL_INT32
    Array size: Depends on the inquire type.
    Note: When multiple inquires.
Collapse M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Collapse UserVarPtr data type info

  • Data type: MIL_INT64
    Note: When a single inquire.

  • Data type: array of type MIL_INT64
    Array size: Depends on the inquire type.
    Note: When multiple inquires.
Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information is not a single value, this function will return M_NULL.
Compilation information
Header Include mil.h.
Library Use mil.lib; milbead.lib.
DLL Requires mil.dll; milbead.dll.
DEFAULT CONTEXT GENERAL INDIVIDUAL WIDTH NOMINAL INTENSITY NOMINAL MODE DEFAULT AUTO DISABLE USER DEFINED POSITION X POSITION Y SIZE TEMPLATE CIRCLE CENTER X DEFAULT TEMPLATE CIRCLE CENTER Y DEFAULT TEMPLATE CIRCLE RADIUS DEFAULT TEMPLATE INPUT UNITS DEFAULT PIXEL WORLD TEMPLATE SEGMENT END X DEFAULT TEMPLATE SEGMENT END Y DEFAULT TEMPLATE SEGMENT START X DEFAULT TEMPLATE SEGMENT START Y DEFAULT TRAINING BOX HEIGHT DEFAULT TRAINING BOX INPUT UNITS DEFAULT PIXEL WORLD TRAINING BOX SPACING DEFAULT DISABLE TRAINING BOX WIDTH DEFAULT TRAINING PATH DEFAULT CIRCLE POLYLINE POLYLINE SEED SEGMENT TRAINING WIDTH NOMINAL DEFAULT DISABLE TRAINING WIDTH SCALE MAX DEFAULT DISABLE TRAINING WIDTH SCALE MIN DEFAULT DISABLE WIDTH NOMINAL DEFAULT WIDTH NOMINAL MODE DEFAULT AUTO CONTINUOUS AUTO UNIFORM USER DEFINED FOREGROUND VALUE DEFAULT FOREGROUND BLACK FOREGROUND WHITE SMOOTHNESS DEFAULT THRESHOLD MODE DEFAULT USER DEFINED THRESHOLD VALUE DEFAULT TRAINED BOX HEIGHT TRAINED BOX SPACING TRAINED BOX WIDTH TRAINED INDIVIDUAL WIDTH NOMINAL TRAINED POSITION X TRAINED POSITION Y TRAINED SIZE TRAINED WIDTH NOMINAL ACCEPTANCE DEFAULT ANGLE ACCURACY MAX DEVIATION DEFAULT BOX WIDTH MARGIN DEFAULT FAIL WARNING OFFSET DEFAULT GAP MAX LENGTH DEFAULT DISABLE GAP TOLERANCE DEFAULT INTENSITY DELTA NEG DEFAULT INTENSITY DELTA POS DEFAULT INTENSITY NOMINAL DEFAULT OFFSET MAX DEFAULT DISABLE WIDTH DELTA NEG DEFAULT DISABLE WIDTH DELTA POS DEFAULT DISABLE BEAD TYPE DEFAULT BEAD EDGE BEAD STRIPE INDEX VALUE INVALID LABEL VALUE ASSOCIATED CALIBRATION DEFAULT NULL MODIFICATION COUNT NUMBER OF TEMPLATES STATUS COMPLETE NOT TRAINED PARTIAL TRAINING IMAGE SIZE X TRAINING IMAGE SIZE Y TRAINING IMAGE TYPE NULL UNSIGNED 8 OWNER SYSTEM DEFAULT HOST CLOSEST POINT MAX DISTANCE DEFAULT INFINITE DEFAULT SUPPORTED NULL TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 CONTEXT DEFAULT GENERAL DEFAULT CONTEXT DEFAULT GENERAL