MstrExpert

See also

User Guide:

Fixing read problems using String Expert Steps to reading a string in an image

Reference:

MbufInquire MbufSetRegion MstrAlloc MstrControl MstrGetResult MstrInquire MstrRead

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.

Function Map

- ContextId

- TargetStringArrayPtr

- NbImages

- ResultId

- ControlFlag

Table:

For specifying the type of analysis to perform

Compilation information

Synopsis

Makes a diagnosis of the String Reader context and reports configuration problems.

Syntax

void MstrExpert(

MIL_ID ContextId,	//in
const MIL_ID *ImageArrayPtr,	//in
const void *TargetStringArrayPtr,	//in
MIL_INT NbImages,	//in
MIL_ID ResultId,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function analyzes the consistency of a String Reader context using a specified image and a target string. Retrieve results using MstrGetResult(); this function returns error and/or warning codes for problems found. Use MstrInquire() to retrieve the meaning associated with these codes.

When the diagnosis of the String Reader context does not cause a general error (see MstrGetResult() with M_GENERAL), the context is ready to be used to read the image provided to MstrExpert(). You can call MstrExpert() multiple times to find and correct problems in the context.

You can limit the verify operation to a region of the image buffer, using a rectangular ROI set with MbufSetRegion().

Note that this function is only available for a font-based context.

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

ContextId

Specifies the identifier of the String Reader context. The String Reader context must have been previously allocated on the required system using MstrAlloc().

ImageArrayPtr

Accepts the address of one of the following:

array of type MIL_ID [optionally, in C++: a reference to a constant std::vector<MIL_ID> ] (and a maximum array rank for C# of 1)
Required array size:(NbImages)

Specifies the identifier of the image to analyze. Note that you cannot provide more than one image.

This image buffer can only have a rectangular region of interest (ROI) defined using MbufSetRegion() (with or without rotation). In addition, the region must be defined in vector format from a 2D graphics list (M_VECTOR or M_VECTOR_AND_RASTER). An error will be generated if the ROI is only in raster format (M_RASTER) or a non-rectangular shape.

TargetStringArrayPtr

Accepts the following address:

Data type: array of type char [optionally, in C++: a reference to a constant std::vector<char> ]
Required array size:(NbImages) Note: Applies when MstrControl() with M_ENCODING is set to M_ASCII.

Data type: array of type short [optionally, in C++: a reference to a constant std::vector<short> ]
Required array size:(NbImages) Note: Applies when MstrControl() with M_ENCODING is set to M_UNICODE.

Specifies the identifier of the string to locate. This string represents the expected strings to locate in each image analyzed using MstrRead(). The string array must be of the right type for the encoding scheme selected (MstrControl() with M_ENCODING). Only one string is supported.

NbImages

Specifies the number of images to analyze. This parameter must be set to 1.

When using a standard vector (std::vector) overload function in C++, you can pass M_DEFAULT to this parameter and MIL will automatically determine the size based on the number of items in the vector passed to the ImageArrayPtr parameter.

ResultId

Specifies the identifier of the String Reader result buffer in which to save the results of MstrExpert().

ControlFlag

Specifies the type of analysis to perform with MstrExpert().

To specify the type of analysis to perform, set this parameter to one of the following values. Except for M_DEFAULT, the following values can be added together.

For specifying the type of analysis to perform
Value	Description
M_DEFAULT	Specifies to report errors and warnings.
M_ERRORS	Specifies to report errors.
M_WARNINGS	Specifies to report warnings.

Compilation information

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