MpatGetResult

See also

User Guide:

Pattern matching algorithm (for advanced users) Search constraints Steps to performing a pattern search

Reference:

MpatControl MpatFind MpatFree 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
patternmatchingtask.cpp
pcbmodelmatching.cpp
photometricstereowithmotion.cpp
variousstatistics.cpp

Function Map

- ResultPatId

- Index

Table:

For specifying where to get results

- ResultType

- ResultArrayPtr

Parameter Associations

Table:	For general results
Table:	For specifying the results to retrieve
+ combination:	For determining whether results are available
+ combination:	For determining the required array size (number of elements) to store the returned values
+ combination:	For specifying the data type

Remarks

Compilation information

Synopsis

Get the specified type of result(s) from a Pattern Matching result buffer.

Syntax

void MpatGetResult(

MIL_ID ResultPatId,	//in
MIL_INT Index,	//in
MIL_INT64 ResultType,	//in
void *ResultArrayPtr	//out

)

Description

This function retrieves the result(s) of the specified type from a specified Pattern Matching result buffer. Results are only available after calling MpatFind().

If your target image was associated with a camera calibration context, positional and dimensional results are, by default, returned with respect to the relative coordinate system of the image. Otherwise, these results are returned in pixels, relative to the top-left pixel in the target image.

If your target image was associated with a camera calibration context but you want to retrieve positional and dimensional results in pixel units, use MpatControl() with the M_RESULT_OUTPUT_UNITS control type set to M_PIXEL. However, note that if you set M_RESULT_OUTPUT_UNITS to M_WORLD without having specified a calibrated target image in which to calculate the results, MpatGetResult() will generate an error.

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

ResultPatId

Specifies the identifier of the Pattern Matching result buffer from which to retrieve results.

Index

Specifies where to get results. This parameter can be set to one of the following:

For specifying where to get results
Value	Description
M_DEFAULT	Same as M_ALL for result types that apply to model occurrences. Same as M_GENERAL for result types that apply to the entire result buffer. (summarize) Same as M_ALL for result types that apply to model occurrences. (more details...)
M_ALL	Retrieves the results of the specified type for all model occurrences found.
M_GENERAL	Retrieves a result relating to the entire result buffer.
0 <= Value < M_NUMBER	Specifies the occurrence index.

ResultType

Specifies the type of result to retrieve for each model occurrence.

See the Parameter associations section for possible values that can be specified.

ResultArrayPtr

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
MIL_DOUBLE
MIL_ID
MIL_INT
MIL_INT32
MIL_INT64

Specifies the address of the one-dimensional array in which to write the specified results. The array must be big enough to hold the number of results indicated by M_NUMBER.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the ResultType parameter and possible values returned to the ResultArrayPtr parameter.

For general results
For specifying the results to retrieve

When retrieving a general result, the ResultType parameter can be set to one of the following values.

For general results
ResultType		Description
	ResultArrayPtr - Possible values returned	Description
M_CONTEXT_ID +		Retrieves the identifier of the Pattern Matching context used by MpatFind() to obtain the results in the result buffer. Note that, if the Pattern Matching context has already been freed, using MpatFree(), the returned Pattern Matching context identifier might no longer be valid. (summarize) Retrieves the identifier of the Pattern Matching context used by MpatFind() to obtain the results in the result buffer. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Recommended casting type: MIL_ID Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Recommended casting type: MIL_ID
M_NUMBER +		Retrieves the number of occurrences found. (summarize) Retrieves the number of occurrences found. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Recommended casting type: MIL_INT Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Recommended casting type: MIL_INT

To specify the type of result to retrieve for each model occurrence, the ResultType parameter must be set to one of the following.

For specifying the results to retrieve
ResultType		Description
	ResultArrayPtr - Possible values returned	Description
M_ANGLE +		Retrieves the angle of the occurrence (if found using MpatFind()), relative to the output coordinate system specified using MpatControl() with M_RESULT_OUTPUT_UNITS. An angle interpreted with respect to the pixel coordinate system is always measured counter-clockwise. For information on the angle's direction of rotation when interpreting the angle with respect to the relative coordinate system, see the Angle convention in MIL subsection of the Working with real-world units section of Chapter 26: Calibrating your camera setup. (summarize) Retrieves the angle of the occurrence (if found using MpatFind()), relative to the output coordinate system specified using MpatControl() with M_RESULT_OUTPUT_UNITS. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_ANGLE + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_ANGLE + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_INDEX +		Retrieves the index of the model that was found. (summarize) Retrieves the index of the model that was found. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_INDEX + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Recommended casting type: Array of type MIL_INT Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_INDEX + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Recommended casting type: Array of type MIL_INT
M_NUMBER_OF_PIXELS +		Retrieves the number of pixels in the model used to compute the correlation function. Note that to retrieve this result type, the sums must be saved using MpatControl() with M_SAVE_SUMS set to M_ENABLE. (summarize) Retrieves the number of pixels in the model used to compute the correlation function. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_NUMBER_OF_PIXELS + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Recommended casting type: Array of type MIL_INT Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_NUMBER_OF_PIXELS + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Recommended casting type: Array of type MIL_INT
M_POSITION_X +		Retrieves the X-coordinate of the occurrence. This is the X-coordinate of the model's reference position transformed at the occurrence (MpatControl() with M_REFERENCE_X). (summarize) Retrieves the X-coordinate of the occurrence. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_POSITION_X + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_POSITION_X + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_POSITION_Y +		Retrieves the Y-coordinate of the occurrence. This is the Y-coordinate of the model's reference position transformed at the occurrence (MpatControl() with M_REFERENCE_Y. (summarize) Retrieves the Y-coordinate of the occurrence. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_POSITION_Y + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_POSITION_Y + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_SCORE +		Retrieves the match score of the occurrence, as a percentage. (summarize) Retrieves the match score of the occurrence, as a percentage. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SCORE + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SCORE + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_SUM_I +		Retrieves the sum of the values of the pixels in the image over the N pixels corresponding to the model occurrence. Note that to retrieve this result type, the sums must be saved using MpatControl() with M_SAVE_SUMS set to M_ENABLE. (summarize) Retrieves the sum of the values of the pixels in the image over the N pixels corresponding to the model occurrence. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_I + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_I + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_SUM_II +		Retrieves the sum of the squares of the values of the pixels in the image over the N pixels corresponding to the model occurrence. Note that to retrieve this result type, the sums must be saved using MpatControl() with M_SAVE_SUMS set to M_ENABLE. (summarize) Retrieves the sum of the squares of the values of the pixels in the image over the N pixels corresponding to the model occurrence. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_II + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_II + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_SUM_IM +		Retrieves the sum of the products of the values of the pixels in the image with the pixels in the model over the N pixels corresponding to the model occurrence. Note that to retrieve this result type, the sums must be saved using MpatControl() with M_SAVE_SUMS set to M_ENABLE. (summarize) Retrieves the sum of the products of the values of the pixels in the image with the pixels in the model over the N pixels corresponding to the model occurrence. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_IM + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_IM + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_SUM_M +		Retrieves the sum of the values of the pixels in the model over the N pixels of the model. Note that to retrieve this result type, the sums must be saved using MpatControl() with M_SAVE_SUMS set to M_ENABLE. (summarize) Retrieves the sum of the values of the pixels in the model over the N pixels of the model. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_M + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_M + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result
M_SUM_MM +		Retrieves the sum of the squares of the values of the pixels in the model over the N pixels of the model. Note that to retrieve this result type, the sums must be saved using MpatControl() with M_SAVE_SUMS set to M_ENABLE. (summarize) Retrieves the sum of the squares of the values of the pixels in the model over the N pixels of the model. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_MM + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size (either of the following): MpatGetResult ( M_NUMBER ) MpatGetResult ( M_SUM_MM + M_NB_ELEMENTS ) Note: for multiple results Data type: address of a MIL_DOUBLE Note: for a single result

Combination value for the values listed in For general results; the values listed in For specifying the results to retrieve.

You can add the following value to the above-mentioned values to specify whether a result is available.

For determining whether results are available
ResultType		Description
	ResultArrayPtr - Possible values returned	Description
M_AVAILABLE +		Retrieves whether a result is available to be returned. (summarize) Retrieves whether a result is available to be returned. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_DOUBLE Note: When a single result. Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_DOUBLE Note: When a single result.
	M_NULL	Specifies that the result is not available to be retrieved.
	Value != 0	Specifies that the result is available to be retrieved.

Combination value for the values listed in For specifying the results to retrieve.

You can add the following value to the above-mentioned values to determine the required array size (number of elements) to store the returned values.

For determining the required array size (number of elements) to store the returned values
ResultType combination value		Description
	ResultArrayPtr - Possible values returned	Description
M_NB_ELEMENTS		Retrieves the required array size (number of elements) to store the returned values. (summarize) Retrieves the required array size (number of elements) to store the returned values. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Recommended casting type: MIL_INT Data type info: Data type: address of a MIL_DOUBLE MORE Data type: address of a MIL_DOUBLE Recommended casting type: MIL_INT

Combination values for the values listed in For general results; the values listed in For specifying the results to retrieve; and for the following value: M_AVAILABLE.

You can add one of the following values to the above-mentioned values to cast the requested results to the required data type.

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

For specifying the data type
ResultType		Description
	ResultArrayPtr - Possible values returned	Description
M_TYPE_MIL_DOUBLE		Casts the requested results to a MIL_DOUBLE. (summarize) Casts the requested results to a MIL_DOUBLE. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_DOUBLE Note: When a single result. Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] \| address of a MIL_DOUBLE MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_DOUBLE Note: When a single result.
M_TYPE_MIL_ID		Casts the requested results to a MIL_ID. (summarize) Casts the requested results to a MIL_ID. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ] \| address of a MIL_ID MORE Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_ID Note: When a single result. Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ] \| address of a MIL_ID MORE Data type: array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_ID Note: When a single result.
M_TYPE_MIL_INT		Casts the requested results to a MIL_INT. (summarize) Casts the requested results to a MIL_INT. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] \| address of a MIL_INT MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_INT Note: When a single result. Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] \| address of a MIL_INT MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_INT Note: When a single result.
M_TYPE_MIL_INT32		Casts the requested results to a MIL_INT32. (summarize) Casts the requested results to a MIL_INT32. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] \| address of a MIL_INT32 MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_INT32 Note: When a single result. Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] \| address of a MIL_INT32 MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_INT32 Note: When a single result.
M_TYPE_MIL_INT64		Casts the requested results to a MIL_INT64. (summarize) Casts the requested results to a MIL_INT64. (more details...)
	ResultArrayPtr extra info	Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] \| address of a MIL_INT64 MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_INT64 Note: When a single result. Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] \| address of a MIL_INT64 MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] Required array size:(defined elsewhere) Note: When multiple results. Data type: address of a MIL_INT64 Note: When a single result.

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.