MpatMask

See also

User Guide:

Masking the model Steps to performing a pattern search

Reference:

MbufInquire MpatControl MpatDefine MpatFind MpatInquire MpatPreprocess

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

mpatfindmultiplemodels.cpp
variousstatistics.cpp

Function Map

- Index

Table:

For specifying a model

- MaskBufferId

- MaskType

Table:

For specifying the value of the don't care pixels

- ControlFlag

Remarks

Compilation information

Synopsis

Mask areas of a model in a Pattern Matching context.

Syntax

void MpatMask(

MIL_ID ContextPatId,	//in
MIL_INT Index,	//in
MIL_ID MaskBufferId,	//in
MIL_INT64 MaskType,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function allows you to apply a "don't care" mask to a model in a Pattern Matching context. Essentially, the mask sets pixels in the specified model to a "don't care state. The "don't care" pixels of the model will not be considered when searching for occurrences of the model in the target image (using MpatFind()). If a pixel in the mask image is a non-zero value, the corresponding pixel in the model is set to a "don't care" state. Note that there must be at least one model to the context before calling this function in the mask image; otherwise an error will occur.

Note, each time this function is called, a new set of "don't care" pixels is assigned to the specified model, superseding any existing set. Therefore, multiple calls to this function do not have a cumulative effect. Also, whenever the "don't care" pixels in a model change, the effect of any preprocessing is undone. Therefore, if the "don't care" pixels are changed, call MpatPreprocess() before searching for the model.

This function does not support a M_REGULAR_MODEL + M_CIRCULAR_OVERSCAN type of model, except if M_SEARCH_ANGLE_MODE is set to M_DISABLE.

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 containing the model to mask.

Index

Specifies the individual model on which to apply the mask.

For specifying a model
Value	Description
M_DEFAULT	Specifies the default value; the default value is 0.
Value >= 0	Specifies the index of the model for which the mask is being created.

MaskBufferId

Specifies the identifier of the image buffer to use as a mask. Non-zero-pixel values identify the "don't care" pixels in the model.

This buffer must be a 1-band, 8-bit, unsigned image buffer. The buffer must be of the same size as the model. The buffer can be calibrated; however, the mask is applied on a pixel basis.

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.

Note that you can set this parameter to M_NULL to remove the mask.

MaskType

Specifies which type of mask to employ.

For specifying the value of the don't care pixels
Value	Description
M_DONT_CARE	Specifies to apply (or remove) a don't care mask. The features present in the masked area (non-zero pixels) are ignored during the search. Features present in this area of the occurrence will not affect the scores. (summarize) Specifies to apply (or remove) a don't care mask. (more details...)

ControlFlag

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

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.