| MIL 10 Reference
| Customize Help
| Save Settings

MbeadAlloc


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
Previous
MbeadAllocResult
Synopsis
Allocate a bead context.
Syntax
MIL_ID MbeadAlloc(
MIL_ID SysId, //in
MIL_INT64 Strategy, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ContextBeadIdPtr //out
)
Description

This function allocates a bead context on the specified system. When the bead context is no longer required, you should release its memory, using MbeadFree().

Any value that you provide to the MIL Bead module (for example, position and width) must be specified in appropriate units (pixel or real-world), depending on whether your images are calibrated. For more information, see the Camera calibration - overview section of Chapter 25: Calibrating your camera setup. Note that, if you are specifying pixel units, make sure the pixel sizes are consistent across all calibrations (for example, pixel sizes should be the same in the training and verification images). When using different calibration contexts, it is recommended that you use world units.

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
SysId INQ

Specifies the identifier of the system on which to allocate the bead context. This parameter should be set to one of the following values:

function map For specifying the system
CollapseValue Description
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().
Strategy

Specifies the strategy with which to extract and analyze beads. This parameter should be set to the following value:

function map For specifying the strategy
CollapseValue Description
Collapse M_DEFAULT

Specifies the default strategy.
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ContextBeadIdPtr

Specifies the address of the variable in which to write the bead context identifier. Since MbeadAlloc() also returns the bead context identifier, you can set this parameter to M_NULL.

Return value
The returned value is the bead context's identifier if the allocation is successful. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; milbead.lib.
DLL Requires mil.dll; milbead.dll.
DEFAULT HOST DEFAULT