MimAlloc
| Board | Supported |
|---|---|
| Host System | Yes |
| V4L2 | Yes |
| Clarity UHD | Yes |
| Concord PoE | No |
| GenTL | Yes |
| GevIQ | Yes |
| GigE Vision | Yes |
| Indio | No |
| Iris GTX | Yes |
| Radient eV-CL | Yes |
| Rapixo CL | Yes |
| Rapixo CoF | Yes |
| Rapixo CXP | Yes |
| USB3 Vision | Yes |
Allocate an image processing context.
Syntax
AIL_ID MimAlloc(
AIL_ID SysId, //in
AIL_INT64 ContextType, //in
AIL_INT64 ControlFlag, //in
AIL_ID * ContextImIdPtr //out
)
Description
This function allocates an image processing context on the specified system.
Note that image processing contexts allocated with MimAlloc can be saved using either MimStream or MimSave and restored using MimRestore.
When the image processing context is no longer required, release it usingMimFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the image processing context's lifetime and you must not manually free it.
Parameters
SysId (in, AIL_ID)
Specifies the system on which to allocate the context. 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 Aurora Imaging Library application. |
System identifier | Specifies a valid system identifier, previously allocated using MsysAlloc. |
ContextType (in, AIL_INT64)
Specifies the type of image processing context. This parameter should be set to one of the following values:
For specifying the type of context
| Value | Description |
|---|---|
M_AUGMENTATION_CONTEXT | Specifies an image processing context that can be used with MimAugment. |
M_BINARIZE_ADAPTIVE_CONTEXT | Specifies an image processing context that can be used with MimBinarizeAdaptive to perform an adaptive binarization. |
M_BINARIZE_ADAPTIVE_FROM_SEED_CONTEXT | Specifies an image processing context that can be used with MimBinarizeAdaptive to perform an adaptive binarization using seeds. |
M_DEAD_PIXEL_CONTEXT | Specifies an image processing context that can be used with MimDeadPixelCorrection. |
M_DEINTERLACE_CONTEXT | Specifies an image processing context that can be used with MimDeinterlace. |
M_FILTER_MAJORITY_CONTEXT | Specifies an image processing context that can be used with MimFilterMajority. |
M_FIND_ORIENTATION_CONTEXT | Specifies an image processing context that can be used with MimFindOrientation. |
M_FLAT_FIELD_CONTEXT | Specifies an image processing context that can be used with MimFlatField. |
M_HISTOGRAM_EQUALIZE_ADAPTIVE_CONTEXT | Specifies an image processing context that can be used with MimHistogramEqualizeAdaptive. |
M_IM_REMAP_CONTEXT | Specifies an image processing context that can be used with MimRemap. |
M_LINEAR_FILTER_IIR_CONTEXT | Specifies an image processing context that can be used with MimConvolve or MimDifferential. |
M_LOCATE_PEAK_1D_CONTEXT | Specifies an image processing context that can be used with MimLocatePeak1d. |
M_MATCH_CONTEXT | Specifies an image processing context that can be used with MimMatch. |
M_REARRANGE_CONTEXT | Specifies an image processing context that can be used with MimRearrange. |
M_STATISTICS_CONTEXT | Specifies an image processing context that can be used with MimStatCalculate. |
M_STATISTICS_CUMULATIVE_CONTEXT | Specifies an image processing context that can be used with MimStatCalculate when calculating statistics from multiple images. |
M_UNWARP_ALONG_PATH_CONTEXT | Specifies an image processing context that can be used with MimUnwarpAlongPath. |
M_WAVELET_TRANSFORM_CONTEXT | Specifies an image processing context that can be used with MimWaveletTransform and MimWaveletDenoise. |
M_WAVELET_TRANSFORM_CUSTOM_CONTEXT | Specifies a custom image processing context that can be used with MimWaveletTransform and MimWaveletDenoise. |
ControlFlag (in, AIL_INT64)
Reserved for future expansion and must be set to M_DEFAULT.
ContextImIdPtr *(out, AIL_ID)
Specifies the address of the variable in which to write the image processing context identifier or specifies the data type that the function should use to return the image processing context identifier.
For retrieving the identifier or specifying how to return it
| Value | Description |
|---|---|
M_NULL | Specifies that you will use this function's return value to obtain the identifier of the allocated image processing context; in this case, a standard Aurora Imaging Library identifier of type AIL_ID is returned. |
M_UNIQUE_ID | Specifies that you will use this function's return value to obtain the identifier of the allocated image processing context; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_IM_ID_is returned instead of a standard Aurora Imaging Library identifier.This setting is only available when using C++11 (or later).An Aurora Imaging Library smart identifier manages the lifespan of the Aurora Imaging Library object it owns (similar to a std::unique_ptr). Note, you can use an Aurora Imaging Library smart identifier as though it were a standard Aurora Imaging Library identifier, except that you cannot use it to manually free the image processing context (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers. |
Address in which to write the identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated image processing context. |
If allocation fails, M_NULL is written as the identifier. |
Return Value
Type: AIL_ID
The returned value is the image processing context identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_IM_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).
Remarks
Note that some of the context types listed above are not available in Aurora Imaging Library Lite. See the context's corresponding operation function for Aurora Imaging Library Lite availability.