MimGetResult2d

See also

Reference:

MimAlloc MimAllocResult MimStatCalculate

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

- ResultImId

- OffsetX

- OffsetY

- SizeX

- SizeY

- ResultType

- ControlFlag

- UserArrayPtr

Parameter Associations

Table:	For specifying the type of result to retrieve
+ combination:	For the ResultType parameter to cast the required results to the requested data type

Compilation information

Synopsis

Get data from a statistics result buffer, and place it in a user-supplied array.

Syntax

void MimGetResult2d(

MIL_ID ResultImId,	//in
MIL_INT OffsetX,	//in
MIL_INT OffsetY,	//in
MIL_INT SizeX,	//in
MIL_INT SizeY,	//in
MIL_INT64 ResultType,	//in
MIL_INT64 ControlFlag,	//in
void *UserArrayPtr	//out

)

Description

This function retrieves, from a M_STATISTICS_RESULT result buffer, the results obtained for a specified region of the series of source buffer passed to MimStatCalculate() that uses a M_STATISTICS_CUMULATIVE_CONTEXT. One value is returned for every pixel in the specified region.

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

ResultImId

Specifies the identifier of the statistics image processing result buffer from which to get results.

OffsetX

Specifies the X-offset of the region for which to retrieve results. The specified value must be between 0 and the SizeX parameter value.

OffsetY

Specifies the Y-offset of the region for which to retrieve results. The specified value must be between 0 and the SizeY parameter value.

SizeX

Specifies the width (X-size) of the region for which to retrieve results.

SizeY

Specifies the height (Y-size) of the region for which to retrieve results.

ResultType

Specifies the type of result(s) to retrieve.

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

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

UserArrayPtr

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_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ]
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> ]

Specifies the address of the user-specified array in which to write the results read from the multiple statistics result buffer.

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

Parameter associations

The table below lists possible values for the ResultType parameter and possible values returned to the UserArrayPtr parameter.

For specifying the type of result to retrieve

For specifying the type of result to retrieve
ResultType		Description
	UserArrayPtr - Possible values returned	Description
M_STAT_MAX +		Retrieves the maximum value of each pixel, given the different source images. (summarize) Retrieves the maximum value of each pixel, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_MAX_ABS +		Retrieves the maximum absolute value of each pixel, given the different source images. (summarize) Retrieves the maximum absolute value of each pixel, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_MEAN +		Retrieves the mean value of each pixel, given the different source images. (summarize) Retrieves the mean value of each pixel, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_MIN +		Retrieves the minimum value of each pixel, given the different source images. (summarize) Retrieves the minimum value of each pixel, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_MIN_ABS +		Retrieves the minimum absolute value of each pixel, given the different source images. (summarize) Retrieves the minimum absolute value of each pixel, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_STANDARD_DEVIATION +		Retrieves the standard deviation value of each pixel, given the different source images. (summarize) Retrieves the standard deviation value of each pixel, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_SUM +		Retrieves the sum of each pixel's different values, given the different source images. (summarize) Retrieves the sum of each pixel's different values, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_SUM_ABS +		Retrieves the sum of the absolute value of each pixel's different value, given the different source images. (summarize) Retrieves the sum of the absolute value of each pixel's different value, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_STAT_SUM_OF_SQUARES +		Retrieves the sum of the square of each pixel's different value, given the different source images. (summarize) Retrieves the sum of the square of each pixel's different value, given the different source images. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))

Combination values for the values listed in For specifying the type of result to retrieve.

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 the ResultType parameter to cast the required results to the requested data type
ResultType		Description
	UserArrayPtr - 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...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] Required array size:((SizeX) * (SizeY))
M_TYPE_MIL_FLOAT		Casts the requested results to a MIL_FLOAT. (summarize) Casts the requested results to a MIL_FLOAT. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ] MORE Data type: array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ] Required array size:((SizeX) * (SizeY))
M_TYPE_MIL_INT		Casts the requested results to a MIL_INT. (summarize) Casts the requested results to a MIL_INT. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] Required array size:((SizeX) * (SizeY))
M_TYPE_MIL_INT32		Casts the requested results to a MIL_INT32. (summarize) Casts the requested results to a MIL_INT32. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] MORE Data type: array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] Required array size:((SizeX) * (SizeY))
M_TYPE_MIL_INT64		Casts the requested results to a MIL_INT64. (summarize) Casts the requested results to a MIL_INT64. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE Data type: array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] Required array size:((SizeX) * (SizeY))

Compilation information

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