MimGetResult2d

Filters
See also

Reference:

MimAlloc MimAllocResult MimStatCalculate

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/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 if there is complementary information.

Parameters

This function is not supported on the selected boards.

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
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.

For specifying the type of result to retrieve

For specifying the type of result to retrieve
ResultType		Description
	UserArrayPtr - Possible values returned	Description
M_NUMBER +		Retrieves the number of pixels. (summarize) Retrieves the number of pixels. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY))
M_STAT_GLCM_CONTRAST +		Retrieves the contrast of all the grayscale pixel values within a specified neighborhood in relation to the normalized co-occurrence probability of each pixel. (summarize) Retrieves the contrast of all the grayscale pixel values within a specified neighborhood in relation to the normalized co-occurrence probability of each pixel. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY))
M_STAT_GLCM_CORRELATION +		Retrieves the correlation within the normalized co-occurrence probability in a specified neighborhood. (summarize) Retrieves the correlation within the normalized co-occurrence probability in a specified neighborhood. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY))
M_STAT_GLCM_DISSIMILARITY +		Retrieves the correlation within the normalized co-occurrence probability in a specified neighborhood. (summarize) Retrieves the correlation within the normalized co-occurrence probability in a specified neighborhood. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY))
M_STAT_GLCM_ENERGY +		Retrieves the energy between two points in the gray level co-occurrence matrix of a given neighborhood. (summarize) Retrieves the energy between two points in the gray level co-occurrence matrix of a given neighborhood. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY))
M_STAT_GLCM_ENTROPY +		Retrieves the inverse of the energy between two points in the normalized co-occurrence probability of a specified neighborhood. (summarize) Retrieves the inverse of the energy between two points in the normalized co-occurrence probability of a specified neighborhood. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY))
M_STAT_GLCM_HOMOGENEITY +		Retrieves the similarity between the normalized co-occurrence probability and the gray level co-occurrence matrix of a given neighborhood. (summarize) Retrieves the similarity between the normalized co-occurrence probability and the gray level co-occurrence matrix of a given neighborhood. (more details...)
	UserArrayPtr extra info	Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY))
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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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.

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 (more details...) Data type: array of type MIL_DOUBLE Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_DOUBLE (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_FLOAT Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_FLOAT (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_INT Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_INT (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_INT32 Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_INT32 (more details...) Data type: array of type 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 (more details...) Data type: array of type MIL_INT64 Required array size:((SizeX) * (SizeY)) Data type info: Data type: array of type MIL_INT64 (more details...) Data type: array of type 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.