MimMatch

See also

User Guide:

Establishing a correlation

Reference:

MbufInquire MimAlloc MimControl MimInquire

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

None.

Function Map

- ControlFlag

Table:

For specifying the operation to perform.

Compilation information

Synopsis

Generates a series of correlation values between the source image and a model image.

Syntax

void MimMatch(

MIL_ID MatchContextImId,	//in
MIL_ID SrcImageBufId,	//in
MIL_ID DstImageBufId,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function generates a series of correlation values (match scores) resulting from the model image being compared to every pixel in your image. The MimMatch() operation results in an image of correlation data. The closer the resulting pixel value is to the specified maximum score, the closer the match between the source image buffer and the model image.

This function uses a match image processing context to match a pixel in the source image with a given model image. Specify the model image using MimControl() with M_MODEL_IMAGE. You can also specify the algorithm to use to perform the correlation (the mode), using MimControl() with M_MODE. In addition, you can limit the region in the model image with which to perform the correlation, using a mask image; specify the mask image using MimControl() with M_MASK_IMAGE. In the match mask image, all non-zero pixels are considered mask pixels that are ignored during the match.

When dealing with large images, you can reduce the number of comparisons performed from 1 every pixel to 1 every other pixel in your model image, using MimControl() with M_MODEL_STEP.

Before you call this function to perform a match operation, preprocess the match image processing context by calling MimMatch() with M_PREPROCESS. If the preprocess operation is not done explicitly (using M_PREPROCESS), it will be done when MimMatch() is first called. When preprocessed explictly, the source and destination image buffers can be set to M_NULL. If, however, the source or destination image buffer is provided, it will be used in the preprocess operation, to better optimize future calls.

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

MatchContextImId

Specifies the identifier of the match image processing context. The context must have been allocated using MimAlloc() with M_MATCH_CONTEXT. In addition, the match image processing context must already be configured with the identifier of the model image.

SrcImageBufId

Specifies the identifier of the source image buffer. The buffer must be an 8-bit unsigned image buffer.

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.

When preprocessing the match image processing context, set this parameter to a typical source image buffer. To exclude this buffer from preprocessing, set this parameter to M_NULL.

DstImageBufId

Specifies the identifier of the destination image buffer. The buffer must be either a 16-bit signed or a 32-bit floating-point image buffer.

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.

When preprocessing the match image processing context, set this parameter to a typical destination image buffer. To exclude this buffer from preprocessing, set this parameter to M_NULL.

ControlFlag

Specifies the operation to perform. This parameter must be set to one of the following values.

For specifying the operation to perform.
Value	Description
M_DEFAULT	Performs the match operation according to the settings of the match image processing context.
M_PREPROCESS	Preprocess the specified image processing context. Note that, if not called explicitly, this operation will be performed automatically with the first call to MimMatch(). If the identifier of the source and/or destination buffer is not set to M_NULL, information about the source and/or destination image buffer will be used in the preprocessing operation. (summarize) Preprocess the specified image processing context. (more details...)

Compilation information

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