MIL_ID ResultBeadId, | //in |
MIL_INT LabelOrIndex, | //in |
MIL_INT ResultIndex, | //in |
MIL_INT64 ResultType, | //in |
void *UserVarPtr | //out |
This function retrieves results of the specified type from a bead result buffer. Results are only available after calling MbeadVerify().
Results for the specified bead template or trained point are based on how they compare with their corresponding measured bead or measured point in the verification's target image. The returned results are ordered by the label value of their template.
If your target image was associated with a calibration context, positional and dimensional results are returned with respect to the relative coordinate system of the target image. Otherwise, these results are returned in pixels, relative to the top-left pixel in the target image.
Specifies the label or index of the template for which to get results, or specifies that you are getting general results related to all templates. This parameter must be set to one of the following values:
For specifying where you are getting
results
|
|||||||||||||||||||||||||||||||||||||||
Value |
Description
|
||||||||||||||||||||||||||||||||||||||
Specifies the index of the template for which to get results. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the index. Valid indices range from 0 (the first template) to the number of defined templates minus 1. |
|||||||||||||||||||||||||||||||||||||||
Specifies the label of the template for which to get results. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the label. The label must be greater than 0. |
|||||||||||||||||||||||||||||||||||||||
M_GENERAL |
Specifies to get general results related to all templates. |
Specifies the trained points (one or all) for which to get results or specifies that you are getting general results. This parameter must be set to one of the following values:
For specifying the trained points for
which to get results or for specifying general results
|
|||||||||||||||||||||||||||||||||||||||
Value | Description
|
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Same as M_GENERAL. |
||||||||||||||||||||||||||||||||||||||
M_ALL |
Specifies to get results for each trained point in the template. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_GENERAL |
Specifies to get general results. (more details...) |
||||||||||||||||||||||||||||||||||||||
Value |
Specifies the index of the trained point for which to get results. (more details...) |
Specifies the result to get.
See the Parameter associations section for possible values that can be specified.
Specifies the address in which to write the requested information.
See the Parameter associations section for possible values that can be returned.
The tables below list possible values for the ResultType parameter and possible values returned to the UserVarPtr parameter.
To get the status of results, the ResultType parameter can be set to the following value.
Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE (when retrieving the status of results related to all templates, a single template, or a single trained point) or the address of an array of type MIL_DOUBLE with a size equal to M_NUMBER (when retrieving the status of results related to each trained point in a template).
For retrieving the status of
results
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_STATUS + |
Retrieves whether results have passed or failed verification. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies that the results have not passed verification. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies that the results have passed verification. |
To retrieve the number of templates or the number of trained points in a template, the ResultType parameter can be set to the following value.
Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.
For retrieving the number of templates or
the number of trained points in a template
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_NUMBER + |
Retrieves the number of templates or the number of trained points in a template. (more details...) |
To retrieve results related to a template's corresponding measured bead, the ResultType parameter should be set to one of the following values. In this case, you must set the LabelOrIndex parameter to the index or label of the template for which to get results (M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL()) and the ResultIndex parameter to M_GENERAL.
Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE.
For retrieving results related to a
template (measured bead)
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_CLOSURE + |
Retrieves whether the measured bead is closed. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FALSE |
Specifies that the measured bead is not closed. |
||||||||||||||||||||||||||||||||||||||
M_TRUE |
Specifies that the measured bead is closed. |
||||||||||||||||||||||||||||||||||||||
M_GAP_COVERAGE + |
Retrieves the percentage of the total gap in the measured bead, relative to the length of the expected measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_GAP_MAX_LENGTH + |
Retrieves the length of the longest uninterrupted chain of trained points that were not found in the bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTENSITY_MAX + |
Retrieves the maximum pixel intensity of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTENSITY_MAX_INDEX + |
Retrieves the index of the trained point that corresponds to the maximum intensity of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INVALID |
Specifies that MIL could not establish a maximum pixel intensity. (more details...) |
||||||||||||||||||||||||||||||||||||||
Value |
Specifies the index of the trained point that corresponds to the maximum intensity. |
||||||||||||||||||||||||||||||||||||||
M_INTENSITY_MIN + |
Retrieves the minimum pixel intensity of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTENSITY_MIN_INDEX + |
Retrieves the index of the trained point that corresponds to the minimum intensity of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INVALID |
Specifies that MIL could not establish a minimum pixel intensity. (more details...) |
||||||||||||||||||||||||||||||||||||||
Value |
Specifies the index of the trained point that corresponds to the minimum intensity. |
||||||||||||||||||||||||||||||||||||||
M_LABEL_VALUE + |
Retrieves the label of the template corresponding to the index specified with M_TEMPLATE_INDEX(). (more details...) |
||||||||||||||||||||||||||||||||||||||
M_NUMBER_FOUND + |
Retrieves the number of trained points that have a corresponding measured point in the bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_OFFSET_MAX + |
Retrieves the maximum linear distance between the position of a trained point and the position of its corresponding measured point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_OFFSET_MAX_INDEX + |
Retrieves the index of the trained point that represents the maximum offset of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INVALID |
Specifies that MIL could not establish a maximum offset. (more details...) |
||||||||||||||||||||||||||||||||||||||
Value > 0 |
Specifies the index of the trained point that corresponds to the maximum offset. |
||||||||||||||||||||||||||||||||||||||
M_SCORE + |
Retrieves the percentage of trained points that have a corresponding measured point with a passing status, relative to the total number of trained points in the template. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_STATUS_GAP_TOLERANCE + |
Retrieves whether the M_GAP_COVERAGE result has passed or failed the gap tolerance criterion, as specified using MbeadControl() with M_GAP_TOLERANCE. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies that the result is greater than the gap tolerance criterion. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies that the result is less than or equal to the gap tolerance criterion. |
||||||||||||||||||||||||||||||||||||||
M_STATUS_SCORE + |
Retrieves whether the M_SCORE result has passed or failed the acceptance criterion, as specified using MbeadControl() with M_ACCEPTANCE. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies that the result is greater than the acceptance criterion. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies that the result is less than or equal to the acceptance criterion. |
||||||||||||||||||||||||||||||||||||||
M_WIDTH_AVERAGE + |
Retrieves the average width of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_WIDTH_MAX + |
Retrieves the maximum width of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_WIDTH_MAX_INDEX + |
Retrieves the index of the trained point that corresponds to the maximum width of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INVALID |
Specifies that MIL could not establish a maximum width. (more details...) |
||||||||||||||||||||||||||||||||||||||
Value |
Specifies the index of the trained point that corresponds to the maximum width. |
||||||||||||||||||||||||||||||||||||||
M_WIDTH_MIN + |
Retrieves the minimum width of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_WIDTH_MIN_INDEX + |
Retrieves the index of the trained point that corresponds to the minimum width of the measured bead. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INVALID |
Specifies that MIL could not establish a minimum width. (more details...) |
||||||||||||||||||||||||||||||||||||||
Value |
Specifies the index of the trained point that corresponds to the minimum width. |
To retrieve results related to a trained point's (one or all) corresponding measured point, the ResultType parameter should be set to one of the following values. In this case, you must set the LabelOrIndex parameter to the index or label of the template for which to get results (M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL()) and the ResultIndex parameter to a specific value or M_ALL.
Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE (when retrieving results related to a single trained point) or the address of an array of type MIL_DOUBLE with a size equal to M_NUMBER (when retrieving results related to all trained points).
For retrieving results related to trained
points (measured points)
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_ANGLE + |
Retrieves the angle of the measured bead at the position of the measured point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_INTENSITY + |
Retrieves the intensity of the measured bead at the position of the measured point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_OFFSET + |
Retrieves the linear distance between the trained point and its corresponding measured point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_X + |
Retrieves the X-coordinate of the measured point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_POSITION_Y + |
Retrieves the Y-coordinate of the measured point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_STATUS_SEARCH + |
Retrieves whether MIL considers it possible to establish the measured point, given the current settings. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies that MIL considers it impossible to establish the measured point. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies that MIL considers it possible to establish the measured point. |
||||||||||||||||||||||||||||||||||||||
M_TRAINED_INDEX + |
Retrieves the index of the trained point that corresponds to the measured point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_TRAINED_POSITION_X + |
Retrieves the X-position of the trained point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_TRAINED_POSITION_Y + |
Retrieves the Y-position of the trained point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_WIDTH_VALUE + |
Retrieves the width of the measured bead at the position of the measured point. (more details...) |
To retrieve results related to a template's corresponding measured bead, or to a trained point's (one or all) corresponding measured point, the ResultType parameter can be set to one of the following values. In this case, you must set the LabelOrIndex parameter to the index or label of the template for which to get results (M_TEMPLATE_INDEX() or M_TEMPLATE_LABEL()). When retrieving results related to a template, you must set the ResultIndex parameter to M_GENERAL. When retrieving results related to the trained points, you must set the ResultIndex parameter to a specific value or M_ALL.
Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_DOUBLE (when retrieving results related to a template or a trained point) or the address of an array of type MIL_DOUBLE with a size equal to M_NUMBER (when retrieving results related to all trained points).
For retrieving results related to a
template (measured bead) or to trained points (measured
points)
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_STATUS_FOUND + |
Retrieves the found status of the related template or trained point. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies a failing status. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies a passing status. |
||||||||||||||||||||||||||||||||||||||
M_STATUS_GAP_MAX + |
Retrieves whether the M_GAP_MAX_LENGTH result has passed or failed the maximum gap criterion, as specified using MbeadControl() with M_GAP_MAX_LENGTH. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies a failing status. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies a passing status. |
||||||||||||||||||||||||||||||||||||||
M_STATUS_INTENSITY_MAX + |
Retrieves whether the M_INTENSITY result has passed or failed the criterion for the highest pixel intensity allowed, as specified using MbeadControl() with NominalIntensity + M_INTENSITY_DELTA_POS. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies a failing status. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies a passing status. |
||||||||||||||||||||||||||||||||||||||
M_STATUS_INTENSITY_MIN + |
Retrieves whether the M_INTENSITY result has passed or failed the criterion for the lowest intensity allowed, as specified using MbeadControl() with NominalIntensity - M_INTENSITY_DELTA_NEG. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies a failing status. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies a passing status. |
||||||||||||||||||||||||||||||||||||||
M_STATUS_OFFSET + |
Retrieves whether the M_OFFSET result has passed or failed the maximum offset criterion, as specified using MbeadControl() with M_OFFSET_MAX. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies a failing status. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies a passing status. |
||||||||||||||||||||||||||||||||||||||
M_STATUS_WIDTH_MAX + |
Retrieves whether the M_WIDTH_VALUE result has passed or failed the maximum width criterion, as specified using MbeadControl() with M_TRAINING_WIDTH_NOMINAL + M_WIDTH_DELTA_POS. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies a failing status. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies a passing status. |
||||||||||||||||||||||||||||||||||||||
M_STATUS_WIDTH_MIN + |
Retrieves whether the M_WIDTH_VALUE result has passed or failed the minimum width criterion, as specified using MbeadControl() with M_TRAINING_WIDTH_NOMINAL - M_WIDTH_DELTA_NEG. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_FAIL |
Specifies a failing status. |
||||||||||||||||||||||||||||||||||||||
M_PASS |
Specifies a passing status. |
You can add the following value to the above-mentioned values to specify whether a result is available.
For determining whether results are
available
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_AVAILABLE |
Retrieves whether a result is available to be returned. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr data type info |
Data
type: MIL_DOUBLE |
||||||||||||||||||||||||||||||||||||||
M_NULL |
Specifies that the result is not available to be returned. |
||||||||||||||||||||||||||||||||||||||
Value != 0 |
Specifies that the result is available to be returned. |
You can add one of the following values to the above-mentioned values to cast the requested results to the required data type.
For specifying the data type
|
|||||||||||||||||||||||||||||||||||||||
ResultType |
Description
|
||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_DOUBLE |
Casts the requested results to a MIL_DOUBLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_ID |
Casts the requested results to a MIL_ID. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_INT |
Casts the requested results to a MIL_INT. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_INT32 |
Casts the requested results to a MIL_INT32. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr data type info |
|
||||||||||||||||||||||||||||||||||||||
M_TYPE_MIL_INT64 |
Casts the requested results to a MIL_INT64. (more details...) |
||||||||||||||||||||||||||||||||||||||
UserVarPtr data type info |
|
Header | Include mil.h. |
Library | Use mil.lib; milbead.lib. |
DLL | Requires mil.dll; milbead.dll. |