MagmAlloc

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 a find or train AGM context.

Syntax

AIL_ID MagmAlloc(
    AIL_ID    SysId,        //in
    AIL_INT64 ContextType,  //in
    AIL_INT64 ControlFlag,  //in
    AIL_ID *  ContextIdPtr  //out
)

Description

This function allocates a find or train AGM context on the specified system. A find AGM context contains the information necessary to perform an MagmFind operation, while a train AGM context contains the information necessary to perform an MagmTrain operation.

Define and add models to an AGM context using MagmDefine. You add a single-definition model directly to a find AGM context using MagmDefine. To add a composite-definition model to a find AGM context, you must first add the model to a train AGM context using MagmDefine, train the model using MagmTrain, and then copy the trained composite-definition model to the find AGM context using MagmCopyResult. You can adjust individual model settings using MagmControl.

When the AGM context is no longer required, release it usingMagmFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the AGM context's lifetime and you must not manually free it.

Parameters

SysId (in, AIL_ID)

Specifies the system on which to allocate the context. Set this parameter 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 AGM context. This parameter must be set to one of the following values:

For the type of context

Value	Description
M_GLOBAL_EDGE_BASED_FIND	Specifies to allocate a find AGM context. This context contains settings and the model to find with MagmFind.
M_GLOBAL_EDGE_BASED_TRAIN	Specifies to allocate a train AGM context. This context contains settings and the composite-definition model to train with MagmTrain.

ControlFlag (in, AIL_INT64)

Reserved for future expansion. This parameter must be set to M_DEFAULT.

ContextIdPtr *(out, AIL_ID)

Specifies the address of the variable in which to write the AGM context identifier or specifies the data type that the function should use to return the AGM 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 AGM 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 AGM context; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_AGM_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 AGM context (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers.
Address in which to write the find AGM context identifier	Specifies the address of an AIL_ID in which to write the identifier of the allocated find AGM context.

If allocation fails, M_NULL is written as the identifier. | | Address in which to write the train AGM context identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated train AGM context.

If allocation fails, M_NULL is written as the identifier. |

Return Value

Type: AIL_ID

The returned value is the AGM context identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_AGM_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).