MmodRestore
| Board | Supported |
|---|---|
| Host System | Yes |
| V4L2 | Yes |
| Clarity UHD | Yes |
| Concord PoE | No |
| GenTL | Yes |
| GevIQ | Yes |
| GigE Vision | Yes |
| Indio | No |
| Iris GTX | Yes |
| Radient eV-CL | Yes |
| Rapixo CL | Yes |
| Rapixo CoF | Yes |
| Rapixo CXP | Yes |
| USB3 Vision | Yes |
Restore a Model Finder context from disk.
Syntax
AIL_ID MmodRestore(
AIL_CONST_TEXT_PTR FileName, //in
AIL_ID SysId, //in
AIL_INT64 ControlFlag, //in
AIL_ID * ContextIdPtr //out
)
Description
This function restores a Model Finder context that was previously saved to a file, using MmodSave or MmodStream. This function restores all of the Model Finder context's settings that were in effect when the Model Finder context was saved. A restored Model Finder context is not preprocessed, therefore you must call MmodPreprocess before performing a search with MmodFind.
If you had associated camera calibration contexts with the models in your Model Finder context and you did not save them with the context, you must re-associate the camera calibration contexts, using MmodControl with M_ASSOCIATED_CALIBRATION. Moreover, if you had previously set drawing control types, using MgraControl with M_DRAW_..., then you must reset them since they were not saved with the context.
When the restored Model Finder context is no longer required, release it usingMmodFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the restored Model Finder context's lifetime and you must not manually free it.
Parameters
FileName (in, AIL_CONST_TEXT_PTR)
Specifies the name and path of the file from which to restore the Model Finder context. The function handles (internally) the opening and closing of the file.
For specifying the file name and path
| Value | Description |
|---|---|
M_INTERACTIVE | Opens the File Open dialog box from which you can interactively specify the drive, directory, and name of the file. |
"FileName" | Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). Typically, Model Finder context files have an MMF extension. |
To specify a file on a remote computer (under Distributed Aurora Imaging Library), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). |
SysId (in, AIL_ID)
Specifies the system on which to restore the Model Finder context.
For specifying the system identifier
| Value | Description |
|---|---|
M_DEFAULT_HOST | Specifies the default Host system of the current Aurora Imaging Library application. |
System identifier | Specifies a valid system identifier, previously allocated using MsysAlloc. |
ControlFlag (in, AIL_INT64)
Specifies whether to restore, from the Model Finder context, the camera calibration contexts associated with the models.
For specifying whether to restore the camera calibration contexts associated with the models
| Value | Description |
|---|---|
M_DEFAULT | Specifies that the camera calibration contexts are not restored. |
M_WITH_CALIBRATION | Specifies that the camera calibration contexts are restored. In this case, the camera calibration contexts must have been previously saved with the context, using MmodSave or MmodStream with M_WITH_CALIBRATION. Note that the camera calibration contexts associated with synthetic models are not saved or restored. |
The camera calibration information is restored from the same file as the Model Finder context. The camera calibration cannot be managed independently from the Model Finder context. When the Model Finder context is freed, the camera calibration is automatically freed as well. |
ContextIdPtr *(out, AIL_ID)
Specifies the address of the variable in which to write the Model Finder context identifier or specifies the data type that the function should use to return the Model Finder context identifier.
For retrieving the identifier or specifying how to return it
| Value | Description |
|---|---|
M_NULL | Specifies that you will use this function's return value to obtain the identifier of the allocated Model Finder context; in this case, a standard Aurora Imaging Library identifier of type AIL_ID is returned. |
M_UNIQUE_ID | Specifies that you will use this function's return value to obtain the identifier of the allocated Model Finder context; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_MOD_ID_is returned instead of a standard Aurora Imaging Library identifier.This setting is only available when using C++11 (or later).An Aurora Imaging Library smart identifier manages the lifespan of the Aurora Imaging Library object it owns (similar to a std::unique_ptr). Note, you can use an Aurora Imaging Library smart identifier as though it were a standard Aurora Imaging Library identifier, except that you cannot use it to manually free the Model Finder context (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers. |
Address in which to write the identifier | Specifies the address of an AIL_ID in which to write the identifier of the restored Model Finder context. |
If restoration fails, M_NULL is written as the identifier. |
Return Value
Type: AIL_ID
The returned value is the Model Finder context identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_MOD_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).