MbeadAlloc

See also

User Guide:

Defining, training, and modifying bead templates Steps to validate beads

Reference:

MbeadFree MsysAlloc

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

mbead.cpp
mbead.cs
mbead.vb

Function Map

- SysId

Table:

For specifying the system

- Strategy

Table:

For specifying the strategy

- ControlFlag

- ContextBeadIdPtr

Return value

Compilation information

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 26: Calibrating your camera setup. Note that, if you are specifying pixel units, make sure the pixel sizes are consistent across all camera calibrations (for example, pixel sizes should be the same in the training and verification images). When using different camera 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 which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

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:

For specifying the system
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
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:

For specifying the strategy
Value	Description
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.