MdmrDraw

• See also
User Guide:
Results and annotations Steps to read dot-matrix strings from an image
Reference:
MbufAlloc1d MbufInquire MdmrAllocResult MdmrControlStringModel MdmrGetResult MgraAlloc MgraAllocList
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
mdmr.cpp
mdmr.cs
mdmr.vb
variousdotmatrixreadings.cpp

MdmrControlStringModel
MdmrExportFont

Description

Parameters

ContextGraId

Specifies the identifier of the 2D graphics context to use when drawing. Set this parameter to one of the values below.

For specifying the 2D graphics context
Value	Description
M_DEFAULT	Specifies that the default 2D graphics context of the current MIL application is used. Note that there is a different default 2D graphics context for each thread. (summarize) Specifies that the default 2D graphics context of the current MIL application is used. (more details...)
MIL 2D graphics context identifier	Specifies a valid 2D graphics context identifier, which you have allocated using MgraAlloc().

ResultDmrId

Specifies the identifier of the SureDotOCR result buffer from which to extract the features to draw. The result buffer must have been previously allocated on the system using MdmrAllocResult().

DstImageBufOrListGraId

Specifies the identifier of the destination image buffer or 2D graphics list in which to draw. The buffer can be any valid MIL image buffer allocated using MbufAlloc...(). The 2D graphics list must be previously allocated using MgraAllocList(). By drawing into a display's overlay buffer or associating the 2D graphics list with the display, you can also annotate an image non-destructively.

If specifying an image buffer, it must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

Operation

Specifies the drawing operation to perform. When applicable, MdmrDraw() draws the required information at the location that the string was read in the target, at the correct angle, scale, and aspect ratio.

The following Operation parameter values are for drawing operations related to strings. The CharIndex parameter must be set to M_DEFAULT. The values in the table below can be added together to perform multiple drawings at once (for example, M_DRAW_STRING_BOX + M_DRAW_MIL_FONT_STRING).

For drawing operations related to strings
Value	Description
M_DRAW_MIL_FONT_FORMATTED_STRING	Draws the names of the characters that were read, and they appear according to how the target string is formatted in the image (including non-constrained spaces). Character names are drawn under the bottom-left corner of the bounding box of the string (M_DRAW_STRING_BOX). Character names come from the SureDotOCR font that defines them. To draw the names, SureDotOCR uses the font associated with the 2D graphics context. (summarize) Draws the names of the characters that were read, and they appear according to how the target string is formatted in the image (including non-constrained spaces). (more details...)
M_DRAW_MIL_FONT_STRING	Draws the names of the characters that were read, and they appear according to the string model definition. Character names are drawn under the bottom-left corner of the bounding box of the string (M_DRAW_STRING_BOX). Character names come from the SureDotOCR font that defines them. To draw the names, SureDotOCR uses the font associated with the 2D graphics context. (summarize) Draws the names of the characters that were read, and they appear according to the string model definition. (more details...)
M_DRAW_STRING_BOX	Draws a bounding box around the string that was read. This bounding box encloses all of the string's characters. (summarize) Draws a bounding box around the string that was read. (more details...)

The following Operation parameter values are for drawing operations related to characters. The CharIndex parameter must be set to one or all characters. The values in the table below can be added together to perform multiple drawings at once (for example, M_DRAW_STRING_CHAR_BOX + M_DRAW_STRING_CHAR_POSITION).

For drawing operations related to characters
Value	Description
M_DRAW_STRING_CHAR_BOX	Draws the character's bounding box at the location at which the character was read.
M_DRAW_STRING_CHAR_POSITION	Draws a circled dot at the center of each bounding box that surrounds the individual characters of a string.

Index

Specifies the string result (one or all) for which to perform the drawing operation. Set this parameter to one of the values below.

For specifying the string index
Value	Description
M_DEFAULT	Same as M_ALL.
M_ALL	Specifies to perform the drawing operation for all string results.
M_GENERAL	Specifies to perform a global drawing operation for a single bounding box that encompasses all strings. This parameter must be used with M_DRAW_STRING_BOX or it will generate an error. (summarize) Specifies to perform a global drawing operation for a single bounding box that encompasses all strings. (more details...)
Value >= 0	Specifies the index of the string result for which to perform the drawing operation.

CharIndex

Specifies the character (one or all) in the string result for which to perform the drawing operation. Set this parameter to one of the values below.

For specifying the character index
Value	Description
M_DEFAULT	Implements the default behavior. For drawing operations related to strings, the default indicates that this parameter is not required. For drawing operations related to characters, the default is the same as setting the M_INDEX_IN_STRING() macro to M_ALL. (summarize) Implements the default behavior. (more details...)
M_INDEX_IN_FORMATTED_STRING( MIL_INT CharIndex )	Specifies to perform the drawing operation by indicating the character's index, relative to its position in the formatted string. The formatted string includes spaces, if any were read in the target string, even if you did not add spaces to the string model as permitted character constraints (MdmrControlStringModel() with M_SPACE). (summarize) Specifies to perform the drawing operation by indicating the character's index, relative to its position in the formatted string. (more details...)
		Parameters
		CharIndex Set this parameter to one of the following:
			M_ALL Specifies to perform the drawing operation for all characters in the formatted string. To retrieve the number of characters in the formatted string, call MdmrGetResult() with M_FORMATTED_STRING_CHAR_NUMBER.
			0 <= Value < M_FORMATTED_STRING_CHAR_NUMBER Specifies the index of the character in the formatted string for which to perform the drawing operation. The value must be less than the total number of characters in the formatted string (M_FORMATTED_STRING_CHAR_NUMBER).
M_INDEX_IN_STRING( MIL_INT CharIndex )	Specifies to perform the drawing operation by indicating the character's index, relative to its position in the string. The string can include spaces, but only if they correspond to a space permitted character constraint in the string model (MdmrControlStringModel() with M_SPACE). (summarize) Specifies to perform the drawing operation by indicating the character's index, relative to its position in the string. (more details...)
		Parameters
		CharIndex Set this parameter to one of the following:
			M_ALL Specifies to perform the drawing operation for all characters in the string. To retrieve the number of characters in the string, call MdmrGetResult() with M_STRING_CHAR_NUMBER.
			0 <= Value < M_STRING_CHAR_NUMBER Specifies the index of the character in the string for which to perform the drawing operation. The value must be less than the total number of characters in the string (M_STRING_CHAR_NUMBER).

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.