MdlocrAllocDataset

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 Deep Learning OCR dataset.

Syntax

AIL_ID MdlocrAllocDataset(
    AIL_ID    SysId,        //in
    AIL_INT64 DatasetType,  //in
    AIL_INT64 ControlFlag,  //in
    AIL_ID *  DatasetIdPtr  //out
)

Description

This function allocates a Deep Learning OCR dataset on the specified system. A Deep Learning OCR dataset contains information about images and the characters represented in these images. The dataset can be exported using MdlocrExport and retrieved using MdlocrImport. You can add and remove dataset entries using MdlocrAddImageToDataset and MdlocrDeleteLastImageFromDataset, respectively.

When the Deep Learning OCR dataset is no longer required, release it usingMdlocrFree unless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the Deep Learning OCR dataset's lifetime and you must not manually free it.

Parameters

SysId (in, AIL_ID)

Specifies the identifier of the system on which to allocate the Deep Learning OCR dataset. Set this parameter to one of the values below:

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.

DatasetType (in, AIL_INT64)

Specifies the type of dataset to allocate. Set this parameter to the value below:

For specifying the type of dataset to allocate

Value	Description
M_OCR_NET2_DATASET	Specifies to allocate a Deep Learning OCR dataset based on the NET2 architecture. This dataset can be used with M_OCR_NET2_TINY_V1 contexts.

ControlFlag (in, AIL_INT64)

Reserved for future expansion and must be set to M_DEFAULT.

DatasetIdPtr *(out, AIL_ID)

Specifies the address of the variable in which to write the Deep Learning OCR dataset identifier or specifies the data type that the function should use to return the Deep Learning OCR dataset 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 Deep Learning OCR dataset; 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 Deep Learning OCR dataset; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_DLOCR_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 Deep Learning OCR dataset (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 Deep Learning OCR dataset.

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

Return Value

Type: AIL_ID

The returned value is the Deep Learning OCR dataset identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_DLOCR_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).