MbeadControl

Sets how MIL establishes the nominal pixel intensity of the template. You can use the pixel intensity of the template when verifying beads. That is, MIL can validate the brightness of each measured point according to the brightness of its associated trained point. MIL calculates the intensity for each point at the center of its corresponding bead width.

You can only use this value with stripe-beads. INQ

Sets the X-coordinate of the center of a template whose path follows a circle. This value only applies if M_TRAINING_PATH is set to M_CIRCLE. INQ

Sets the Y-coordinate of the center of a template whose path follows a circle. This value only applies if M_TRAINING_PATH is set to M_CIRCLE. INQ

Sets the radius of a template whose path follows a circle. This value only applies if M_TRAINING_PATH is set to M_CIRCLE. INQ

Sets 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 control types, as well as the units with which to interpret the template's position and dimension values specified using MbeadTemplate(). This essentially sets the input coordinate system to use. INQ

Sets the X-coordinate of the end of a template whose path follows a segment. This value only applies if M_TRAINING_PATH is set to M_SEGMENT. INQ

Sets the Y-coordinate of the end of a template whose path follows a segment. This value only applies if M_TRAINING_PATH is set to M_SEGMENT. INQ

Sets the X-coordinate of the start of a template whose path follows a segment. This value only applies if M_TRAINING_PATH is set to M_SEGMENT. INQ

Sets the Y-coordinate of the start of a template whose path follows a segment. This value only applies if M_TRAINING_PATH is set to M_SEGMENT. INQ

Sets the height of the training box in which to establish the trained points.

When you call MbeadTrain(), MIL uses the specified height of the training box to achieve the best height value based on all your settings (for example, if you use a training image). To inquire the actual height MIL establishes (the trained height), use MbeadInquire() with M_TRAINED_BOX_HEIGHT. INQ

Sets the units with which to interpret the M_TRAINING_BOX_HEIGHT, M_TRAINING_BOX_WIDTH, M_TRAINING_BOX_SPACING, and M_TRAINING_WIDTH_NOMINAL control types. This essentially sets the input coordinate system to use. INQ

Sets the distance between the center of the training boxes in which to establish the trained points. Since MIL establishes trained points at regular intervals along the template's path, the specified spacing is adjusted accordingly. To inquire the actual spacing MIL uses, call MbeadInquire() with M_TRAINED_BOX_SPACING. INQ

Sets the width of the training box in which to establish the trained points.

When you call MbeadTrain(), MIL uses the specified width of the training box to achieve the best width value based on all your settings (for example, if you use a training image). To inquire the actual width MIL establishes (the trained width), use MbeadInquire() with M_TRAINED_BOX_WIDTH. Note that MIL does not typically alter the specified training box width. INQ

Sets how MIL establishes the path of the bead template. Along the path, MIL establishes trained points at regular intervals based on the specified spacing (M_TRAINING_BOX_SPACING). INQ

Sets the width with which to validate the template's automatically established nominal width. M_TRAINING_WIDTH_NOMINAL only applies when M_WIDTH_NOMINAL_MODE is set to M_AUTO_.... The width of the measured bead automatically established with the training image must respect the nominal width specified, otherwise the template will be invalid. To set scaling factors based on the nominal width, use M_TRAINING_WIDTH_SCALE_MAX and M_TRAINING_WIDTH_SCALE_MIN. INQ

Sets the scale factor by which to determine the upper limit (maximum permitted scale) of the bead width. MIL applies the scale factor to the nominal training width (M_TRAINING_WIDTH_NOMINAL).

You can only use this value with stripe-beads. INQ

Sets the scale factor by which to determine the lower limit (minimum permitted scale) of the bead width. MIL applies the scale factor to the nominal width (M_TRAINING_WIDTH_NOMINAL).

You can only use this value with stripe-beads. INQ

Sets the nominal width to use, when it is explicitly defined. M_WIDTH_NOMINAL only applies when M_WIDTH_NOMINAL_MODE is set to M_USER_DEFINED.

The width set for M_WIDTH_NOMINAL applies to all vertices. To modify the width of one or more vertices, use MbeadTemplate() with M_SET_WIDTH_NOMINAL. INQ

Sets how to establish the nominal width of the bead template. If the bead is a stripe (MbeadTemplate() with M_BEAD_STRIPE), the width refers to the thickness between the stripe's outer edges. If the bead is an edge (M_BEAD_EDGE), the width refers to the thickness of the edge's intensity transition. INQ

Sets the acceptance level for the score of the template's corresponding measured bead. The measured bead can only have a passing status result (M_STATUS) if its score is greater than or equal to the acceptance, regardless of any other setting. To retrieve the computed score, use MbeadGetResult() with M_SCORE. The score indicates, as a percentage, the amount of trained points in the template that have a corresponding measured point with a passing status, relative to the total number of trained points in the template. INQ

Sets the maximum angular deviation between the angle of the bead template at each of its trained points, and the angle of the corresponding measured bead at each of its measured points. MIL considers the angle represented by the trained and measured points to be along the theoretical line that is perpendicular between the point and its corresponding bead. INQ

Sets an additional width for the search box MIL uses to verify the template's measured bead.

MIL bases the search box's width on the trained box's width, which you can inquire with M_TRAINED_BOX_WIDTH. MIL adds the additional width (M_BOX_WIDTH_MARGIN) to the sides (margins) of the search box. MIL applies the additional width as a percentage of the trained nominal width of the bead template, which you can inquire with M_TRAINED_WIDTH_NOMINAL. That is, SearchBoxWidth = TrainedBoxWidth + (TrainedNominalWidth x AdditionalMarginPercentage).

For example, if the width of the trained box is 100 pixels, the trained nominal width of the bead is 60 pixels, and the additional width for the search box is 50%, the search box width is 130 pixels (100 + (60 x 0.5). In this case, the search box is 30 pixels wider (15 pixels on each if its sides) than the trained box. INQ

Sets an additional width to the search box in which a measured point can be found, but will have a failed status result (M_STATUS). When measured points fall outside the search box, but within this additional width, you can still retrieve results about them, such as their found position. If M_FAIL_WARNING_OFFSET is less than the search box width that MIL uses for validating measured points (M_BOX_WIDTH_MARGIN), M_FAIL_WARNING_OFFSET has no effect. INQ

Sets the maximum allowable length of one single gap in the template's measured bead, for it to have a passing status result (M_STATUS). A gap refers to a section of the measured bead that corresponds to a single trained point, or to a set of consecutive trained points, that were expected but not found during verification. If any gap is longer than M_GAP_MAX_LENGTH, the template's measured bead will not have a passing status, regardless of any other setting. INQ

Sets the percentage of the total allowable gap (all gaps together) in the template's measured bead, for it to have a passing status result (M_STATUS). A gap refers to a section of the measured bead that corresponds to a single trained point, or to a set of consecutive trained points, that were expected but not found during verification. If the total combined length of all gaps in the measured bead, relative to the full length of the corresponding bead template, is greater than M_GAP_TOLERANCE, the template's measured bead will not have a passing status, regardless of any other setting. INQ

Sets the lowest pixel intensity that is considered valid for the measured bead, relative to the nominal intensity. That is, LowestValidIntensity = NominalIntensity - M_INTENSITY_DELTA_NEG. The nominal intensity can either be established by the training phase (M_INTENSITY_NOMINAL_MODE set to M_AUTO) or with an explicit value (M_INTENSITY_NOMINAL).

You can only use this value with stripe-beads. INQ

Sets the highest pixel intensity that is considered valid for the measured bead, relative to the nominal intensity. That is, HighestValidIntensity = NominalIntensity + M_INTENSITY_DELTA_POS. The nominal intensity can either be established by the training phase (M_INTENSITY_NOMINAL_MODE set to M_AUTO) or with an explicit value (M_INTENSITY_NOMINAL).

You can only use this value with stripe-beads. INQ

Sets the nominal pixel intensity of the template's measured bead.

M_INTENSITY_NOMINAL only has an effect if you set M_INTENSITY_NOMINAL_MODE to M_USER_DEFINED. To specify a range of acceptable pixel-intensities for the measured bead, use M_INTENSITY_DELTA_NEG and M_INTENSITY_DELTA_POS.

You can only use this value with stripe-beads. INQ

Sets the maximum allowable distance between the position of the trained points in the template, and the position of the corresponding measured points in the target, for the measured bead to have a passing status result (M_STATUS). Measured points must always fall within the search box (for example, M_BOX_WIDTH_MARGIN). INQ

Sets the valid delta negative tolerance between the width of the measured bead and the nominal width of the corresponding template, for the measured bead to have a passing status result (M_STATUS).

You can only use this value with stripe-beads. INQ

Sets the valid delta positive tolerance between the width of the measured bead and the nominal width of the corresponding template, for the measured bead to have a passing status result (M_STATUS).

You can only use this value with stripe-beads. INQ

Sets whether the foreground that MIL uses when performing the edge extraction of the bead from an image should be darker or lighter than the background. Only beads with the specified foreground will be trained or verified, depending on which function you are calling. INQ

Sets the degree of noise reduction that MIL uses when performing the edge extraction of the bead from an image. INQ

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

Sets the value beneath which a grayscale variation within the image is not considered an edge of the bead. This value only applies if M_THRESHOLD_MODE is set to M_USER_DEFINED. INQ

Associates the specified camera calibration context with the training image specified in MbeadTrain(), if required. MIL requires a calibrated training image if your training settings are specified in world units (M_TEMPLATE_INPUT_UNITS and/or M_TRAINING_BOX_INPUT_UNITS set to M_WORLD). If you associate a camera calibration, and you pass a calibrated training image to MbeadTrain(), MIL ignores the associated camera calibration (M_ASSOCIATED_CALIBRATION), and uses the image's camera calibration instead.

Note that if you do not save the camera calibration context with the bead context (MbeadSave() or MbeadStream() with M_WITH_CALIBRATION), you must use M_ASSOCIATED_CALIBRATION to re-associate the camera calibration context after restoring the bead context (MbeadRestore() or MbeadStream()).

This value is for the training phase (MbeadTrain()). If you modify this value, you must retrain the context before the next verification. INQ

Sets the maximum distance for the M_CLOSEST_... operations in MbeadGetNeighbors(). INQ