MocrImportFont

• See also
User Guide:
OCR font Steps to reading or verifying a string in an image
Availability
Not available in MIL-Lite
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
None.
MocrHookFunction
MocrInquire

Description

This function imports character representations from a file to initialize or overwrite those of an existing OCR font context. This function's main use is to initialize custom fonts.

Font character representations can come from either a grayscale image or a text file.

When taken from an image file, character representations are associated with the ASCII characters in the string, specified by CharListString. The image file must be a grid of character representations matching the specifications of the font. The character representations are read from left to right and top to bottom, and the number of characters in the source image must equal the number of characters in the string, specified by CharListString.

When taken from an ASCII file, font character representations must be presented as in the table below.

Row	Description
01	Specifies ASCII file format.
02	Blank row.
03	Specifies the start of a new character representation and its associated (generally ASCII) character.
04 to 36	Specifies the alpha-numerical representation of the character.
37	Blank row.
38	Specifies the start of a new character representation and its associated (generally ASCII) character.
39 to 71	Specifies the alpha-numerical representation of the character.
etc.	This pattern is repeated for every character in the font.

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

FileName

Specifies the name and path of the file from which to import the character representation. The function handles (internally) the opening and closing of the file.

This parameter can be set to the following value:

For specifying the file name and path
Value	Description
MIL_TEXT("FileName") 1	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

FileFormat

Specifies how the data is stored in the file. This parameter can be set to one of the following values:

For specifying how the data is stored
Value	Description
M_FONT_ASCII	Specifies a user-drawn ASCII file. Note that the CharListString must be set to M_NULL. (summarize) Specifies a user-drawn ASCII file. (more details...)
M_MIL	Specifies a MIL format image file. Note that only one-band images can be used. (summarize) Specifies a MIL format image file. (more details...)
M_TIFF	Specifies a TIFF format image file. Note that only one-band images can be used. (summarize) Specifies a TIFF format image file. (more details...)

Operation

Specifies the type of import operation to be performed. This parameter must be set to the following value:

For specifying the type of import operation
Value	Description
M_LOAD_CHARACTER	Specifies that the font character representations should be imported.

CharListString INQ

Specifies the ASCII characters to associate with the font character representations in the file. This parameter can be set to one of the following values:

For specifying the ASCII characters
Value	Description
M_NULL	Specifies that this parameter is ignored. Use this setting when the FileFormat parameter is set to M_FONT_ASCII. (summarize) Specifies that this parameter is ignored. (more details...)
MIL_TEXT("StringOfCharacters") 1	Specifies the list of ASCII characters to associate with the font character representations in the image file. This string must be null-terminated. Note that the number of characters in this list must match the number of font character representations present in the source file. (summarize) Specifies the list of ASCII characters to associate with the font character representations in the image file. (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

FontContextOcrId

Specifies the identifier of the OCR font context.