MmodStream

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

Load, restore, or save a Model Finder context from/to a file or a memory stream.

Syntax

void MmodStream(
    AIL_TEXT_PTR MemPtrOrFileName,  //in-out
    AIL_ID       SysId,             //in
    AIL_INT64    Operation,         //in
    AIL_INT64    StreamType,        //in
    AIL_DOUBLE   Version,           //in
    AIL_INT64    ControlFlag,       //in
    AIL_ID *     ContextModIdPtr,   //in-out
    AIL_INT *    SizeByteVarPtr     //out
)

Description

This function can load, restore, or save a Model Finder context from/to a file or memory stream.

To inquire the number of bytes necessary to save a Model Finder context to memory stream, you should first call this function (MmodStream) with M_INQUIRE_SIZE_BYTE.

The content saved to memory stream is equivalent to the content saved to file. This function is equivalent to a file saved using MmodSave.

You can use this and other Aurora Imaging Library stream functions, for example, to save all required Aurora Imaging Library objects, as well as any other custom data, for your application to a memory stream. Once in a memory stream, you can write the stream to a single file or transfer it over a network. You are responsible for concatenating the streams and for saving the stream to file. All information about the previously allocated Model Finder context is saved, including all of the individual models' current settings. However, preprocessing, any associated camera calibration contexts and drawing control type settings are not saved.

All of the Model Finder context's settings that were in effect when the Model Finder context was saved will be restored. A loaded or 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.

Using MmodStream, you can choose to save a backwards-compatible version of the Model Finder context, which will work using a version of Aurora Imaging Library that is up to one major release older than the current version (depending on which version is specified). However, all settings and features unique to the higher version will be ignored when restored using the lower version. Besides saving backwards-compatible versions, you can also load or restore Model Finder contexts saved using Aurora Imaging Library version 7.0 or above. Settings that do not exist in the lower version will be filled with default values when the Model Finder context is loaded or restored.

Parameters

MemPtrOrFileName (in-out, AIL_TEXT_PTR)

Specifies the file or memory stream.

SysId (in, AIL_ID)

Specifies the system on which to restore the Model Finder context.

Operation (in, AIL_INT64)

Specifies the operation to perform on the Model Finder context.

StreamType (in, AIL_INT64)

Specifies the type of stream in which to store/from which to restore the Model Finder context.

For specifying the type of stream

Value	Description
M_FILE	Specifies a file stream.
M_MEMORY	Specifies a memory stream. You are responsible for allocating a block of memory for the stream.

Version (in, AIL_DOUBLE)

Specifies the Aurora Imaging Library version of the Model Finder context. When performing an M_LOAD or M_RESTORE operation, this parameter must be set to M_DEFAULT.

ControlFlag (in, AIL_INT64)

Specifies whether to restore, from the file or memory stream, the camera calibration contexts associated with the models, or specifies to save, with the Model Finder context, the camera calibration contexts associated with the models.

For specifying whether to restore or save the camera calibration contexts

Value	Description
M_DEFAULT	Specifies that the camera calibration contexts are not saved or restored.
M_WITH_CALIBRATION	Specifies that the camera calibration contexts are saved or restored, depending on the Operation parameter. When restored, 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/ saved to the same file or memory stream 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. |

ContextModIdPtr *(in-out, AIL_ID)

Specifies the address of the variable in which to write or from which to read the identifier of the Model Finder context.

SizeByteVarPtr *(out, AIL_INT)

Specifies the address of the variable in which to write the size of the Model Finder context, in bytes.

Parameter Associations

For performing the stream operation.

---

M_INQUIRE_SIZE_BYTE

Inquires the number of bytes required to save a Model Finder context to memory stream. This operation is not supported when the StreamType parameter is set to M_FILE.

Value	Description
M_DEFAULT	Specifies the current version of Aurora Imaging Library.
M_PROC_VERSION_100_SP4	Specifies the version as being Aurora Imaging Library 10.0 Service Pack 4.
M_PROC_VERSION_100_SP5	Specifies the version as being Aurora Imaging Library 10.0 Service Pack 5.
M_PROC_VERSION_100_SP6	Specifies the version as being Aurora Imaging Library 10.0 Service Pack 6.
M_PROC_VERSION_100_SP7	Specifies the version as being Aurora Imaging Library 10.0 Service Pack 7.
M_PROC_VERSION_110	Specifies the version as being Aurora Imaging Library 11.0.

---

M_LOAD

Loads the content of a specified file or memory stream into a previously allocated Model Finder context.

Value	Description
M_INTERACTIVE	Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set toM_FILE.
"FileName"	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. Model Finder contexts typically have an MMF file extension. The function handles (internally) the opening and closing of the file. 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").
MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type AIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the AIL_UINT8 pointer to an AIL_TEXT_PTR.

---

M_RESTORE

Restores a Model Finder context from a file or memory stream and assigns it an Aurora Imaging Library identifier.

Value	Description
M_INTERACTIVE	Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set toM_FILE.
"FileName"	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. Model Finder contexts typically have an MMF file extension. The function handles (internally) the opening and closing of the file. 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").
MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type AIL_UINT8. The specified address must correspond to the first memory address in which the object is located, and the block of memory must contain the entire object. Note that when using a C compiler (not a C++ or other compiler), you must cast the AIL_UINT8 pointer to an AIL_TEXT_PTR.
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.

---

M_SAVE

Saves a Model Finder context to a specified file or memory stream.

Value	Description
M_INTERACTIVE	Opens a dialog box from which you can interactively specify the drive, directory, and name of the file, when the StreamType parameter is set toM_FILE.
"FileName"	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"), when the StreamType parameter is set to M_FILE. For easier use with other Aurora Imaging Library software products, when saving a model finder context to a file, use the MMF file extension. The function handles (internally) the opening and closing of the file. If the file already exists, it will be overwritten. 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").
MemPtr	Specifies the address of the block of memory, when the StreamType parameter is set to M_MEMORY. The block of memory should be of type AIL_UINT8. The specified address must correspond to the first memory address in which to write, and the block of memory must be large enough to stream the entire object. To determine the required size, call this function with M_INQUIRE_SIZE_BYTE. Note that when using a C compiler (not a C++ or other compiler), you must cast the AIL_UINT8 pointer to an AIL_TEXT_PTR.
(see M_INQUIRE_SIZE_BYTE)