MimAllocResult

See also

User Guide:

Augmentation Finding dominant image orientations Image statistics Peak intensity detection and depth maps Transform and denoise images using wavelets

Reference:

MimAugment MimCountDifference MimFindExtreme MimFindOrientation MimFree MimHistogram MimLocateEvent MimLocatePeak1d MimProjection MimStatCalculate MimWaveletDenoise MimWaveletTransform MsysAlloc

Availability

Available in MIL-Lite with restrictions (see remarks)

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

Function Map

- SysId

Table:

For specifying the system identifier

- NbEntries

Table:

For specifying the number of buffer entries

- ResultType

Table:	For specifying the type of data
+ combination:	For M_PROJ_LIST, M_EXTREME_LIST, or M_EVENT_LIST to change the type of data to store

- ResultImIdPtr

Return value

Remarks

Compilation information

Synopsis

Allocate an image processing result buffer.

Syntax

MIL_ID MimAllocResult(

MIL_ID SysId,	//in
MIL_INT NbEntries,	//in
MIL_INT64 ResultType,	//in
MIL_ID *ResultImIdPtr	//out

)

Description

This function allocates a result buffer with the specified number of entries, for use with some of the Image Processing module's functions (for example, the statistical functions).

When the result buffer is no longer required, you should release its memory, using MimFree().

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

SysId INQ

Specifies the system on which to allocate the result buffer. This parameter should be set to one of the following values:

For specifying the system identifier
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

NbEntries INQ

Specifies the number of buffer entries to allocate for the specified result buffer. This parameter should be set to one of the following values:

For specifying the number of buffer entries
Value	Description
M_DEFAULT	Specifies that MIL automatically establishes the size of the result buffer. You can only use this value when the ResultType parameter is set to M_AUGMENTATION_RESULT, M_COUNT_LIST, M_LOCATE_PEAK_1D_RESULT, M_STATISTICS_RESULT, or M_WAVELET_TRANSFORM_RESULT. (summarize) Specifies that MIL automatically establishes the size of the result buffer. (more details...)
Value > 0	Specifies the number of buffer entries. This value should take into account the type of result buffer being allocated. A specific number of entries must be specified when the ResultType parameter is set to M_EVENT_LIST, M_EXTREME_LIST, M_FIND_ORIENTATION_LIST, M_HIST_LIST, or M_PROJ_LIST. A specific number of entries cannot be specified when the ResultType parameter is set to M_COUNT_LIST, M_LOCATE_PEAK_1D_RESULT, M_STATISTICS_RESULT, or M_WAVELET_TRANSFORM_RESULT. (summarize) Specifies the number of buffer entries. (more details...)

ResultType INQ

Specifies the type of data that will be stored in this result buffer. This parameter must be set to one of the following values:

For specifying the type of data
Value	Description
M_AUGMENTATION_RESULT	Specifies that the buffer can hold MimAugment() results.
M_COUNT_LIST	Specifies that the buffer can hold MimCountDifference() results.
M_EVENT_LIST +	Specifies that the buffer can hold MimLocateEvent() results.
M_EXTREME_LIST +	Specifies that the buffer can hold MimFindExtreme() results.
M_FIND_ORIENTATION_LIST +	Specifies that the buffer can hold MimFindOrientation() results.
M_HIST_LIST	Specifies that the buffer can hold MimHistogram() results.
M_LOCATE_PEAK_1D_RESULT	Specifies that the buffer can hold MimLocatePeak1d() results. In this case, you must set the NbEntries parameter to M_DEFAULT. (summarize) Specifies that the buffer can hold MimLocatePeak1d() results. (more details...)
M_PROJ_LIST +	Specifies that the buffer can hold MimProjection() results.
M_STATISTICS_RESULT	Specifies that the buffer can hold MimStatCalculate() results.
M_WAVELET_TRANSFORM_RESULT	Specifies that the buffer can hold results from MimWaveletTransform() and MimWaveletDenoise(). Such results can themselves be processed. That is, you can use the wavelet result as the source with which to perform MimWaveletTransform() and MimWaveletDenoise(). (summarize) Specifies that the buffer can hold results from MimWaveletTransform() and MimWaveletDenoise(). (more details...)

Combination value for M_EVENT_LIST; M_EXTREME_LIST; M_FIND_ORIENTATION_LIST; M_PROJ_LIST.

You can add the following value to the above-mentioned values to set the type of data stored in the result buffer.

For M_PROJ_LIST, M_EXTREME_LIST, or M_EVENT_LIST to change the type of data to store
Combination value	Description
M_FLOAT	Allocates a result buffer of type float. You should allocate a float result type buffer when the source buffer specified by MimProjection(), MimFindExtreme(), or MimLocateEvent() is of type float. If the specified source buffer is of type float and the result buffer is not, the functions can produce inaccurate results. Note that allocating a result buffer of type float when the source buffer is not, will slow down the operations performed by the MimProjection(), MimFindExtreme(), or MimLocateEvent() function. (summarize) Allocates a result buffer of type float. (more details...)

ResultImIdPtr

Specifies the address of the variable in which to write the image processing result buffer identifier. Since MimAllocResult() also returns the image processing result buffer identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

Return value

The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned.

Remark

[MIL-Lite]

Note that some of the result buffer types listed above are not available in MIL-Lite. See the result buffer's corresponding operation function for MIL-Lite availability.

Compilation information

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