MpatPreprocess

See also

User Guide:

Finding models when they are at an angle Pattern matching algorithm (for advanced users) Preprocessing the Pattern Matching context Speeding up the search Steps to performing a pattern search

Reference:

MbufInquire MpatInquire

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

binarybasedcircledetection.cpp
dmilobjecttrackingslave.cpp
fixturedcoderead.cpp
mmodeltracking.cpp
mmodeltracking.cs
mmodeltracking.vb
mpat.cpp
mpat.cs
mpat.vb
mpatdefinemodelatangle.cpp
mpatfindmultiplemodels.cpp
pcbmodelmatching.cpp
photometricstereowithmotion.cpp
variousstatistics.cpp

Function Map

Compilation information

Synopsis

Preprocess a Pattern Matching context.

Syntax

void MpatPreprocess(

MIL_ID ContextPatId,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID TypicalImageBufId	//in

)

Description

This function preprocesses the specified Pattern Matching context. It trains the MIL application to search for one or more models in the most efficient manner (optionally within a specified typical image). The procedure is potentially quite lengthy (up to several seconds).

Call this function after at least one search model is added to the context and all search settings have been adjusted. When you save, the model's preprocessing changes are not stored with the model. Upon restoration, the model needs to be preprocessed.

Note that if some of the model's search settings are changed after a call to MpatPreprocess(), the model must be preprocessed again. To inquire if your model is in a preprocessed state, use MpatInquire() with M_PREPROCESSED.

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

ContextPatId

Specifies the identifier of the Pattern Matching context to preprocess.

ControlFlag

Reserved for future expansion. Set this parameter to M_DEFAULT.

TypicalImageBufId

Specifies the identifier of a typical target image. The specified typical image will be used to refine and adapt the model to search on this typical background. You should only specify an image buffer if the models will always appear on such a background; otherwise, set this parameter to M_NULL.

This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

Remark

The prototypes of functions in the Mpat module changed as of MIL 10 PP2. For C applications, by default the original prototypes are used to ensure backward-compatibility. To use the updated prototypes, add #define M_USE_OLD_MPAT_API_IN_C 0 before including mil.h. For information about the original API for the Mpat module refer to the MIL 10 PP1 documentation, available online to registered users at https://www.matrox.com/imaging/en/products/software/mil/documentation/.

Compilation information

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