MbeadRestore

See also

User Guide:

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

Reference:

MbeadControl MbeadSave MbeadStream MbeadTrain MbeadVerify 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

None.

Function Map

- FileName

Table:

For specifying the file name and path

- SysId

Table:

For specifying the system identifier

- ControlFlag

Table:

For specifying whether to restore the camera calibration context that was saved with the bead context

- ContextBeadIdPtr

Return value

Compilation information

Synopsis

Restore a bead context from disk.

Syntax

MIL_ID MbeadRestore(

MIL_CONST_TEXT_PTR FileName,	//in
MIL_ID SysId,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContextBeadIdPtr	//out

)

Description

This function restores a bead context that was previously saved to a file, using MbeadSave() or MbeadStream(). This function restores all of the bead context's settings that were in effect when it was saved. The templates of a restored bead context are not trained, therefore you must call MbeadTrain() before performing a verification with MbeadVerify().

If you had associated a camera calibration context with the training image and you did not save it with the context, you must re-associate the camera calibration context, using MbeadControl() with M_ASSOCIATED_CALIBRATION.

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

FileName

Specifies the name and path of the file from which to restore the bead context. The function handles (internally) the opening and closing of the file.

This parameter should be set to the following value:

For specifying the file name and path
Value	Description
MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). Typically, bead context files have a MBEAD file extension. To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

SysId

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

For specifying the system identifier
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().

ControlFlag

Specifies whether to restore the camera calibration context that was saved with the bead context.

For specifying whether to restore the camera calibration context that was saved with the bead context
Value	Description
M_DEFAULT	Specifies that the camera calibration is not restored.
M_WITH_CALIBRATION	Specifies that the camera calibration is restored. In this case, the camera calibration must have been previously saved with the context, using MbeadSave() or MbeadStream() with M_WITH_CALIBRATION. The camera calibration information is restored from the same file as the bead context. The camera calibration cannot be managed independently from the bead context. When the bead context is freed, the camera calibration is automatically freed as well. (summarize) Specifies that the camera calibration is restored. (more details...)

ContextBeadIdPtr

Specifies the address of the variable in which to write the bead context identifier. Since this function also returns the bead context identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

Return value

The returned value is the bead context identifier. 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.