| MIL 10 Reference
| Customize Help
| Save Settings

MimGetResult2d


See also
Availability
Not available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
None.
MimGetResult1d
MimGetResult
Synopsis
Get data from a multiple 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_STAT_MULTIPLE_RESULT result buffer, the results obtained for a specified region of the source buffer passed to MimStatMultiple(). 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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
ResultImId

Specifies the identifier of the 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
  • array of type MIL_FLOAT
  • array of type MIL_INT
  • array of type MIL_INT32
  • array of type MIL_INT64

Specifies the address of the user-specified array in which to write the results read from the multiple statitics 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.

Unless otherwise specified, the following values require that you pass the UserArrayPtr parameter the address of an array of type MIL_DOUBLE with a size equal to SizeX x SizeY .

function map For specifying the type of result to retrieve
CollapseResultType Description
UserArrayPtr
- Possible values returned
Collapse M_MAX +

Retrieves the maximum value of each pixel, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_MAX_ABS +

Retrieves the maximum absolute value of each pixel, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_MEAN +

Retrieves the mean value of each pixel, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_MIN +

Retrieves the minimum value of each pixel, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_MIN_ABS +

Retrieves the minimum absolute value of each pixel, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_STANDARD_DEVIATION +

Retrieves the standard deviation value of each pixel, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_SUM +

Retrieves the sum of each pixel's different values, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_SUM_ABS +

Retrieves the sum of the absolute value of each pixel's different value, given the different source images passed to MimStatMultiple().

(summarize)
Collapse M_SUM_OF_SQUARES +

Retrieves the sum of the square of each pixel's different value, given the different source images passed to MimStatMultiple().

(summarize)
Combination constants 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.

function map For the ResultType parameter to cast the required results to the requested data type
CollapseResultType Description
UserArrayPtr
- Possible values returned
Collapse M_TYPE_MIL_DOUBLE

Casts the requested results to a MIL_DOUBLE.

(summarize)
Collapse UserArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: SizeX x SizeY

Collapse M_TYPE_MIL_FLOAT

Casts the requested results to a MIL_FLOAT.

(summarize)
Collapse UserArrayPtr data type info

Data type: array of type MIL_FLOAT
Array size: SizeX x SizeY

Collapse M_TYPE_MIL_INT

Casts the requested results to a MIL_INT.

(summarize)
Collapse UserArrayPtr data type info

Data type: array of type MIL_INT
Array size: SizeX x SizeY

Collapse M_TYPE_MIL_INT32

Casts the requested results to a MIL_INT32.

(summarize)
Collapse UserArrayPtr data type info

Data type: array of type MIL_INT32
Array size: SizeX x SizeY

Collapse M_TYPE_MIL_INT64

Casts the requested results to a MIL_INT64.

(summarize)
Collapse UserArrayPtr data type info

Data type: array of type MIL_INT64
Array size: SizeX x SizeY

Compilation information
Header Include mil.h.
Library Use mil.lib; milim.lib.
DLL Requires mil.dll; milim.dll.
MAX MAX ABS MEAN MIN MIN ABS STANDARD DEVIATION SUM SUM ABS SUM OF SQUARES TYPE MIL DOUBLE TYPE MIL FLOAT TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64