MpatAlloc

See also

User Guide:

Defining and adding models to your Pattern Matching context Geometric Model Finder module Steps to performing a pattern search

Reference:

MpatControl MpatDefine MpatFind MpatFree MpatInquire MsysAlloc

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

- SysId

Table:

For specifying the system identifier

- ContextType

Table:

For the types of Pattern Matching context

Compilation information

Synopsis

Allocate a Pattern Matching context.

Syntax

MIL_ID MpatAlloc(

MIL_ID SysId,	//in
MIL_INT64 ContextType,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContextPatIdPtr	//out

)

Description

This function allocates a Pattern Matching context on the specified system. A pattern matching context contains all the information necessary to perform an MpatFind() operation on a target image, including global search settings and one or more models.

Define search models and add to them to the Pattern Matching context using MpatDefine(). Note that you must add at least one model to the context.

You can adjust the Pattern Matching context settings using MpatControl(). To inquire the Pattern Matching context settings, use MpatInquire().

When the Pattern Matching context is no longer required, release its memory, using MpatFree().

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

SysId INQ

Specifies the system on which to allocate the Pattern Matching context.

This parameter should be set to one of the following values:

For specifying the system identifier
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, which you have allocated using the MsysAlloc() function.

ContextType

Specifies the type of Pattern Matching context. The parameter must be set to the following:

For the types of Pattern Matching context
Value	Description
M_DEFAULT	Same as M_NORMALIZED.
M_NORMALIZED	Specifies a normalized grayscale correlation (NGC) Pattern Matching context.

ControlFlag

Reserved for future expansion. This parameter must be set to M_DEFAULT.

ContextPatIdPtr

Specifies the address in which to write the Pattern Matching context identifier. Since this function also returns the identifier, you can set this parameter to M_NULL.

Return value

The returned value is the Pattern Matching context identifier if the allocation is successful. If allocation fails, M_NULL is returned.

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.