MmodPreprocess

See also

User Guide:

Defining and adding models to your Model Finder context Steps to performing a model search

Reference:

MmodAlloc MmodFind MmodInquire

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

Function Map

- ContextId

- ControlFlag

Table:

For specifying whether to perform preprocessing

Compilation information

Synopsis

Preprocess a Model Finder context.

Syntax

void MmodPreprocess(

MIL_ID ContextId,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function preprocesses the specified Model Finder context. It extracts the active edges of the models contained within the Model Finder context and sets internal search settings so that future searches will be optimized for speed and robustness. The procedure is potentially quite lengthy (up to a few seconds) and increases the size of the Model Finder context significantly.

This function must be called before performing the first MmodFind() search. Call this function after all search settings have been set. When you save the Model Finder context, the model's preprocessing changes are not stored with the model. Upon restoration, the model must be preprocessed again.

Note that if some of the model's search settings are changed after a call to MmodPreprocess(), the model must be preprocessed again. To inquire if your model is in a preprocessed state, use MmodInquire() with M_PREPROCESSED (this value must be true to perform an MmodFind() search).

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

ContextId

Specifies the Model Finder context of the model to preprocess. The Model Finder context must have been previously allocated on the system using MmodAlloc().

ControlFlag

Specifies whether to perform or undo the preprocessing of the model context. Set this parameter to one of the following values:

For specifying whether to perform preprocessing
Value	Description
M_DEFAULT	Performs the preprocessing of the model context.
M_RESET	Undoes preprocessing. Undoing preprocessing can be useful if you want to conserve computer memory within an application and preserve Model Finder context settings. (summarize) Undoes preprocessing. (more details...)

Compilation information

Header	Include mil.h.
Library	Use mil.lib; milmod.lib.
DLL	Requires mil.dll; milmod.dll.