| MIL 10 Reference
| Customize Help
| Save Settings

McalRestore


See also
Availability
Not available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux with restrictions

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
McalRelativeOrigin
McalSave
Synopsis
Restore a calibration context from a file.
Syntax
MIL_ID McalRestore(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID SystemId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *CalibrationIdPtr //out
)
Description

This function restores a calibration context that was previously saved to a file, using McalSave() or McalStream(), and assigns it an identifier.

This function also restores the calibration context associated with a MIL image buffer (MIM) that was previously saved to a file, using MbufExport() with M_MIL + M_WITH_CALIBRATION, and assigns it an identifier. If you then associate this restored calibration context to the restored image buffer, the calibrated image will be in the same state as the previously saved image (at the moment it was saved). For more information, see the Saving and reloading a calibrated image subsection of the Calibration propagation section of Chapter 25: Calibrating your camera setup.

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
FileName

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

This parameter can be set to one of the following:

function map For specifying the file name and path
CollapseValue Description
Collapse M_INTERACTIVE
[This is only applicable to Windows]

Opens the File Open dialog box from which you can interactively specify the drive, directory, and name of the file.
Collapse MIL_TEXT("FileName") 1

Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile").

To save the file on the remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile").

(summarize)

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

SystemId

Specifies the system on which to restore the calibration 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().
ControlFlag

Specifies the function's control flag. This parameter must be set to the following value:

function map For specifying the function's control flag
CollapseValue Description
Collapse M_DEFAULT

Sets the function's control flag to the default.
CalibrationIdPtr

Specifies the address in which to return the identifier of the calibration context. Since McalRestore() also returns the identifier, you can set this parameter to M_NULL.

Return value
The returned value is the identifier of the calibration context if the operation was successful; M_NULL if the operation failed.
Compilation information
Header Include mil.h.
Library Use mil.lib; milcal.lib.
DLL Requires mil.dll; milcal.dll.
INTERACTIVE DEFAULT HOST DEFAULT