Module BarcodeMatrixcode¶

The module BarcodeMatrixcode contains the following static classes:

Class	Description

The module BarcodeMatrixcode contains the following classes:

Class	Description
`MvizBarcode`	A barcode result.
`MvizBarcodeDecoder`	Configuration for the mViz based barcode decoder.
`MvizMatrixcode`	A matrixcode result.
`MvizMatrixcodeDecoder`	Configuration for the mViz based matrixcode decoder.

Class MvizBarcode¶

A barcode result.

Namespace: Ngi

Module: BarcodeMatrixcode

The class MvizBarcode implements the following interfaces:

The class MvizBarcode contains the following properties:

Property	Get	Description
`Text`	*	The decoded text of the barcode.
`Position`	*	The position of the barcode.
`SymbologyId`	*	The symbology of the barcode.
`SymbologyName`	*	The symbology of the barcode.
`ChecksumValid`	*	This is true, if a valid checksum was calculated.
`Fnc1`	*	This is true, if a valid FNC1 character was found.
`ReaderProgramming`	*	This is true, if the reader programming control character was found in the first position.
`Append`	*	This is true, if an append control character was found.

The class MvizBarcode contains the following methods:

Method	Description
`ToString`	Provide string representation for debugging purposes.

The class MvizBarcode contains the following enumerations:

Enumeration	Description
`SymbologyType`	Barcode symbologies.

Description¶

A barcode result consists of the read barcode, the symbology and the location of the barcode, and a few other flags.

The following operators are implemented for a barcode: operator == : comparison for equality. operator != : comparison for inequality.

Default Constructor¶

Constructor MvizBarcode¶

MvizBarcode()

Default constructor.

Constructors¶

Constructor MvizBarcode¶

MvizBarcode(System.String text, Rectangle position, MvizBarcode.SymbologyType symbologyId, System.Boolean checksumValid, System.Boolean fnc1, System.Boolean readerProgramming, System.Boolean append)

Default constructor.

The constructor has the following parameters:

Parameter	Type	Description
`text`	`System.String`
`position`	`Rectangle`
`symbologyId`	`MvizBarcode.SymbologyType`
`checksumValid`	`System.Boolean`
`fnc1`	`System.Boolean`
`readerProgramming`	`System.Boolean`
`append`	`System.Boolean`

Properties¶

Property Text¶

System.String Text

The decoded text of the barcode.

Property Position¶

Rectangle Position

The position of the barcode.

Property SymbologyId¶

MvizBarcode.SymbologyType SymbologyId

The symbology of the barcode.

Property SymbologyName¶

System.String SymbologyName

The symbology of the barcode.

Property ChecksumValid¶

System.Boolean ChecksumValid

This is true, if a valid checksum was calculated.

Property Fnc1¶

System.Boolean Fnc1

This is true, if a valid FNC1 character was found.

Property ReaderProgramming¶

System.Boolean ReaderProgramming

This is true, if the reader programming control character was found in the first position.

Property Append¶

System.Boolean Append

This is true, if an append control character was found.

Methods¶

Method ToString¶

System.String ToString()

Provide string representation for debugging purposes.

Enumerations¶

Enumeration SymbologyType¶

enum SymbologyType

Barcode symbologies.

The enumeration SymbologyType has the following constants:

Name	Value	Description
`unknown`	`0`	Unknown.
`code39`	`1`	Code 39.
`code39Ext`	`2`	Code 39 Extended.
`code93`	`3`	Code 93.
`code128`	`4`	Code 128.
`ean8`	`5`	EAN 8.
`ean13`	`6`	EAN 13.
`itf`	`7`	ITF.
`upcA`	`8`	UPC A.
`upcE`	`9`	UPC E.
`databar`	`10`	Databar.
`databarLimited`	`11`	Databar Limited.
`codabar`	`12`	Codabar.
`pharmacode`	`13`	Pharmacode.

enum SymbologyType
{
  unknown = 0,
  code39 = 1,
  code39Ext = 2,
  code93 = 3,
  code128 = 4,
  ean8 = 5,
  ean13 = 6,
  itf = 7,
  upcA = 8,
  upcE = 9,
  databar = 10,
  databarLimited = 11,
  codabar = 12,
  pharmacode = 13,
};

Class MvizBarcodeDecoder¶

Configuration for the mViz based barcode decoder.

Namespace: Ngi

Module: BarcodeMatrixcode

The class MvizBarcodeDecoder implements the following interfaces:

The class MvizBarcodeDecoder contains the following properties:

Property	Get	Set	Description
`Code39`	*	*	The code_39 decoder.
`Code39Ex t`	*	*	The code_39_ext decoder.
`Code93`	*	*	The code_93 decoder.
``Code128` `	*	*	The code_128 decoder.
`Ean8`	*	*	The ean_8 decoder.
`Ean13`	*	*	The ean_13 decoder.
`Itf`	*	*	The ITF decoder.
`UpcA`	*	*	The upc_a decoder.
`UpcE`	*	*	The upc_e decoder.
``Databar` `	*	*	The databar decoder.
`DatabarL imited`	*	*	The databar limited decoder.
``Codabar` `	*	*	The dodabar decoder.
`Pharmaco de`	*	*	The pharmacode decoder.
``Scanning Directions ``	*	*	The number of scanning directions. 0: vertical, 1: horizontal, 2: both, 3 and more: oblique, every 180/N degrees.
`Scanning Density`	*	*	The spacing between scanning-lines, in pixels; small values favor the decoding rate and increase the running time. 5 is a good default.
`NoiseThr eshold`	*	*	The noise threshold. Threshold level to get rid of spurious bars caused by noise. 40 is a good default.
`CheckQui etZone`	*	*	Check the quiet zone. When true, a quiet zone as large as the standard requires must be present; when set to false, it is advisable to disable other symbologies to avoid false matches.
`MinimumB ars`	*	*	The minimum number of bars for a successfull decode.

The class MvizBarcodeDecoder contains the following methods:

Method	Description
`ToString`	Provide string representation for debugging purposes.

Description¶

Various barcode symbologies can be configured as well as modes of decoding.

The following operators are implemented for a barcode_decoder: operator == : comparison for equality. operator != : comparison for inequality.

Default Constructor¶

Constructor MvizBarcodeDecoder¶

MvizBarcodeDecoder()

Default constructor.

By default, all supported symbologies besides pharmacode are enabled. Scanning is done every 60 degrees, the spacing between scanning lines is 60 degrees, the noise threshold is 40, the quiet zone is checked, and the minimum number of bars is 3.

Constructors¶

Constructor MvizBarcodeDecoder¶

MvizBarcodeDecoder(System.Boolean code39, System.Boolean code39Ext, System.Boolean code93, System.Boolean code128, System.Boolean ean8, System.Boolean ean13, System.Boolean itf, System.Boolean upcA, System.Boolean upcE, System.Boolean databar, System.Boolean databarLimited, System.Boolean codabar, System.Boolean pharmacode, System.Int32 scanningDirections, System.Int32 scanningDensity, System.Int32 noiseThreshold, System.Boolean checkQuietZone, System.Int32 minimumBars)

Default constructor.

The constructor has the following parameters:

Parameter	Type	Description
`code39`	`System.Boolean`
`code39Ext`	`System.Boolean`
`code93`	`System.Boolean`
`code128`	`System.Boolean`
`ean8`	`System.Boolean`
`ean13`	`System.Boolean`
`itf`	`System.Boolean`
`upcA`	`System.Boolean`
`upcE`	`System.Boolean`
`databar`	`System.Boolean`
`databarLimited`	`System.Boolean`
`codabar`	`System.Boolean`
`pharmacode`	`System.Boolean`
`scanningDirections`	`System.Int32`
`scanningDensity`	`System.Int32`
`noiseThreshold`	`System.Int32`
`checkQuietZone`	`System.Boolean`
`minimumBars`	`System.Int32`

By default, all supported symbologies besides pharmacode are enabled. Scanning is done every 60 degrees, the spacing between scanning lines is 60 degrees, the noise threshold is 40, the quiet zone is checked, and the minimum number of bars is 3.

Properties¶

Property Code39¶

System.Boolean Code39

The code_39 decoder.

Property Code39Ext¶

System.Boolean Code39Ext

The code_39_ext decoder.

Property Code93¶

System.Boolean Code93

The code_93 decoder.

Property Code128¶

System.Boolean Code128

The code_128 decoder.

Property Ean8¶

System.Boolean Ean8

The ean_8 decoder.

Property Ean13¶

System.Boolean Ean13

The ean_13 decoder.

Property Itf¶

System.Boolean Itf

The ITF decoder.

Property UpcA¶

System.Boolean UpcA

The upc_a decoder.

Property UpcE¶

System.Boolean UpcE

The upc_e decoder.

Property Databar¶

System.Boolean Databar

The databar decoder.

Property DatabarLimited¶

System.Boolean DatabarLimited

The databar limited decoder.

Property Codabar¶

System.Boolean Codabar

The dodabar decoder.

Property Pharmacode¶

System.Boolean Pharmacode

The pharmacode decoder.

Property ScanningDirections¶

System.Int32 ScanningDirections

The number of scanning directions. 0: vertical, 1: horizontal, 2: both, 3 and more: oblique, every 180/N degrees.

Property ScanningDensity¶

System.Int32 ScanningDensity

The spacing between scanning-lines, in pixels; small values favor the decoding rate and increase the running time. 5 is a good default.

Property NoiseThreshold¶

System.Int32 NoiseThreshold

The noise threshold. Threshold level to get rid of spurious bars caused by noise. 40 is a good default.

Property CheckQuietZone¶

System.Boolean CheckQuietZone

Check the quiet zone. When true, a quiet zone as large as the standard requires must be present; when set to false, it is advisable to disable other symbologies to avoid false matches.

Property MinimumBars¶

System.Int32 MinimumBars

The minimum number of bars for a successfull decode.

Methods¶

Method ToString¶

System.String ToString()

Provide string representation for debugging purposes.

Class MvizMatrixcode¶

A matrixcode result.

Namespace: Ngi

Module: BarcodeMatrixcode

The class MvizMatrixcode implements the following interfaces:

The class MvizMatrixcode contains the following properties:

Property	Get	Description
`Text`	*	The decoded text of the barcode.
``Position ``	*	The position of the barcode.
``Corners` `	*	The accurate corners of the barcode.
`Symbolog yId`	*	The symbology of the barcode.
`Symbolog yName`	*	The symbology of the barcode.
``Polarity ``	*	The polarity of the barcode.
`View`	*	The view of the barcode.
`Size`	*	The size of the barcode (the number of columns and rows).
`Fnc1`	*	This is true, if a valid FNC1 character was found.
``ReaderPr ogramming` `	*	This is true, if the reader programming control character was found in the first position.
`SymbolPo sition`	*	If Structured Append is in use, gives the position in the sequence.
`SymbolTo tal`	*	If Structured Append is in use, gives the total number of symbols in the sequence.
`SymbolFi leId1`	*	If Structured Append is in use, first File Identification code, in range [1..254].
`SymbolFi leId2`	*	If Structured Append is in use, second File Identification code, in range [1..254].
`Grades`	*	A character string with the symbol quality gradings in the order: Overall, Symbol Contrast, Print Growth Horizontal, Print Growth Vertical, Axial NonUniformity, Grid NonUniformity, Unused Error, Modulation, Reflectance Margin, Fixed Pattern Damage.
`SymbolCo ntrast`	*	Indicates how different the foreground and background intensities are.
``Contrast Uniformity ``	*	Numerical assessment of local losses of contrast.
`PrintGro wthHorizon tal`	*	A measure of the relative horizontal thickness of the black/white cells, which can be adverse because of orverinkg/underinking or similar effects due to the marking process.
`PrintGro wthVertica l`	*	A measure of the relative vertical thickness of the black/white cells, which can be adverse because of orverinkg/underinking or similar effects due to the marking process.
``AxialNon Uniformity ``	*	Indicates if the size of the cells differs along one axis compared to the other.
``GridNonU niformity` `	*	Indicates if the cells are aligned on a regular grid, with no local deformation.
`UnusedEr ror`	*	2D codes have a built-in error decoding capability, enabled by redundancy in the content.

The class MvizMatrixcode contains the following methods:

Method	Description
`ToString`	Provide string representation for debugging purposes.

The class MvizMatrixcode contains the following enumerations:

Enumeration	Description
`SymbologyType`	Matrixcode symbologies.
`PolarityType`	Matrixcode polarities.
`ViewType`	Matrixcode view.
`ShapeType`	Matrixcode shape.

Description¶

A matrixcode result consists of the read matrixcode, the symbology and the location of the matrixcode.

The following operators are implemented for a matrixcode: operator == : comparison for equality. operator != : comparison for inequality.

Default Constructor¶

Constructor MvizMatrixcode¶

MvizMatrixcode()

Default constructor.

Constructors¶

Constructor MvizMatrixcode¶

MvizMatrixcode(System.String text, Rectangle position, QuadrilateralDouble corners, MvizMatrixcode.SymbologyType symbologyId, MvizMatrixcode.PolarityType polarity, MvizMatrixcode.ViewType view, Extent size, System.Boolean fnc1, System.Boolean readerProgramming, System.Int32 symbolPosition, System.Int32 symbolTotal, System.Int32 symbolFileId1, System.Int32 symbolFileId2, System.String grades, System.Double symbolContrast, System.Double contrastUniformity, System.Double printGrowthHorizontal, System.Double printGrowthVertical, System.Double axialNonUniformity, System.Double gridNonUniformity, System.Double unusedError)

Default constructor.

The constructor has the following parameters:

Parameter	Type	Description
`text`	`System.String`
`position`	`Rectangle`
`corners`	`QuadrilateralDouble`
`symbologyId`	`MvizMatrixcode.SymbologyType`
`polarity`	`MvizMatrixcode.PolarityType`
`view`	`MvizMatrixcode.ViewType`
`size`	`Extent`
`fnc1`	`System.Boolean`
`readerProgramming`	`System.Boolean`
`symbolPosition`	`System.Int32`
`symbolTotal`	`System.Int32`
`symbolFileId1`	`System.Int32`
`symbolFileId2`	`System.Int32`
`grades`	`System.String`
`symbolContrast`	`System.Double`
`contrastUniformity`	`System.Double`
`printGrowthHorizontal`	`System.Double`
`printGrowthVertical`	`System.Double`
`axialNonUniformity`	`System.Double`
`gridNonUniformity`	`System.Double`
`unusedError`	`System.Double`

Properties¶

Property Text¶

System.String Text

The decoded text of the barcode.

Property Position¶

Rectangle Position

The position of the barcode.

Property Corners¶

QuadrilateralDouble Corners

The accurate corners of the barcode.

Property SymbologyId¶

MvizMatrixcode.SymbologyType SymbologyId

The symbology of the barcode.

Property SymbologyName¶

System.String SymbologyName

The symbology of the barcode.

Property Polarity¶

MvizMatrixcode.PolarityType Polarity

The polarity of the barcode.

Property View¶

MvizMatrixcode.ViewType View

The view of the barcode.

Property Size¶

Extent Size

The size of the barcode (the number of columns and rows).

Property Fnc1¶

System.Boolean Fnc1

This is true, if a valid FNC1 character was found.

Property ReaderProgramming¶

System.Boolean ReaderProgramming

This is true, if the reader programming control character was found in the first position.

Property SymbolPosition¶

System.Int32 SymbolPosition

If Structured Append is in use, gives the position in the sequence.

Property SymbolTotal¶

System.Int32 SymbolTotal

If Structured Append is in use, gives the total number of symbols in the sequence.

Property SymbolFileId1¶

System.Int32 SymbolFileId1

If Structured Append is in use, first File Identification code, in range [1..254].

Property SymbolFileId2¶

System.Int32 SymbolFileId2

If Structured Append is in use, second File Identification code, in range [1..254].

Property Grades¶

System.String Grades

A character string with the symbol quality gradings in the order: Overall, Symbol Contrast, Print Growth Horizontal, Print Growth Vertical, Axial NonUniformity, Grid NonUniformity, Unused Error, Modulation, Reflectance Margin, Fixed Pattern Damage.

Property SymbolContrast¶

System.Double SymbolContrast

Indicates how different the foreground and background intensities are.

The larger the better, as noise, dirt or other degradation can modify these intensities and complicate location/decoding.

Property ContrastUniformity¶

System.Double ContrastUniformity

Numerical assessment of local losses of contrast.

Property PrintGrowthHorizontal¶

System.Double PrintGrowthHorizontal

A measure of the relative horizontal thickness of the black/white cells, which can be adverse because of orverinkg/underinking or similar effects due to the marking process.

Property PrintGrowthVertical¶

System.Double PrintGrowthVertical

A measure of the relative vertical thickness of the black/white cells, which can be adverse because of orverinkg/underinking or similar effects due to the marking process.

Property AxialNonUniformity¶

System.Double AxialNonUniformity

Indicates if the size of the cells differs along one axis compared to the other.

This is often an indication of a mismatch in marking speeds across and along the substrate.

Property GridNonUniformity¶

System.Double GridNonUniformity

Indicates if the cells are aligned on a regular grid, with no local deformation.

This is often an indication of a mechanical disturbance in the marking motion.

Property UnusedError¶

System.Double UnusedError

2D codes have a built-in error decoding capability, enabled by redundancy in the content.

The more error correction capacity is consumed, the more likely a reading failure can arise.

Methods¶

Method ToString¶

System.String ToString()

Provide string representation for debugging purposes.

Enumerations¶

Enumeration SymbologyType¶

enum SymbologyType

Matrixcode symbologies.

The enumeration SymbologyType has the following constants:

Name	Value	Description
`unknown`	`0`	Unknown.
`dataMatrix`	`1`	DataMatrix.
`qrCode`	`2`	QR Code.

enum SymbologyType
{
  unknown = 0,
  dataMatrix = 1,
  qrCode = 2,
};

Enumeration PolarityType¶

enum PolarityType

Matrixcode polarities.

The enumeration PolarityType has the following constants:

Name	Value	Description
`blackOnWhite`	`1`	Black on white.
`whiteOnBlack`	`2`	White on black.
`autoPolarity`	`3`	Automatic polarity.

enum PolarityType
{
  blackOnWhite = 1,
  whiteOnBlack = 2,
  autoPolarity = 3,
};

Enumeration ViewType¶

enum ViewType

Matrixcode view.

The enumeration ViewType has the following constants:

Name	Value	Description
`straight`	`1`	Straight, seen from front.
`mirrored`	`2`	Mirrored, seen from back.
`autoView`	`3`	Automatic view.

enum ViewType
{
  straight = 1,
  mirrored = 2,
  autoView = 3,
};

Enumeration ShapeType¶

enum ShapeType

Matrixcode shape.

The enumeration ShapeType has the following constants:

Name	Value	Description
`square`	`1`	Square codes.
`rectangular`	`2`	Rectangular codees.
`all`	`3`	Automatic view.

enum ShapeType
{
  square = 1,
  rectangular = 2,
  all = 3,
};

Class MvizMatrixcodeDecoder¶

Configuration for the mViz based matrixcode decoder.

Namespace: Ngi

Module: BarcodeMatrixcode

The class MvizMatrixcodeDecoder implements the following interfaces:

The class MvizMatrixcodeDecoder contains the following properties:

Property	Get	Set	Description
`DataMatrix`	*	*	The Data Matrix decoder.
`QrCode`	*	*	The QR Code_ext decoder.
`Polarities`	*	*	Selects the possible contrast of the marking.
`Views`	*	*	Selects the possible orientation of the marking.
`Shapes`	*	*	Selects the possible orientation of the marking.
`CheckQuality`	*	*	Computes the quality indicators, when true.
`StartLevel`	*	*	For large images, you can skip the first pyramid levels for faster execution; try small positive value.
`AccurateEdges`	*	*	When true, a final subpixel fit of the edges is performed for very accurate location.

The class MvizMatrixcodeDecoder contains the following methods:

Method	Description
`ToString`	Provide string representation for debugging purposes.

Description¶

Various matrixcode symbologies can be configured as well as modes of decoding.

The following operators are implemented for a barcode_decoder: operator == : comparison for equality. operator != : comparison for inequality.

Default Constructor¶

Constructor MvizMatrixcodeDecoder¶

MvizMatrixcodeDecoder()

Default constructor.

By default, all supported symbologies are enabled..

Constructors¶

Constructor MvizMatrixcodeDecoder¶

MvizMatrixcodeDecoder(System.Boolean dataMatrix, System.Boolean qrCode, MvizMatrixcode.PolarityType polarities, MvizMatrixcode.ViewType views, MvizMatrixcode.ShapeType shapes, System.Boolean checkQuality, System.Int32 startLevel, System.Boolean accurateEdges)

Default constructor.

The constructor has the following parameters:

Parameter	Type	Description
`dataMatrix`	`System.Boolean`
`qrCode`	`System.Boolean`
`polarities`	`MvizMatrixcode.PolarityType`
`views`	`MvizMatrixcode.ViewType`
`shapes`	`MvizMatrixcode.ShapeType`
`checkQuality`	`System.Boolean`
`startLevel`	`System.Int32`
`accurateEdges`	`System.Boolean`

By default, all supported symbologies are enabled..

Properties¶

Property DataMatrix¶

System.Boolean DataMatrix

The Data Matrix decoder.

Property QrCode¶

System.Boolean QrCode

The QR Code_ext decoder.

Property Polarities¶

MvizMatrixcode.PolarityType Polarities

Selects the possible contrast of the marking.

Property Views¶

MvizMatrixcode.ViewType Views

Selects the possible orientation of the marking.

Property Shapes¶

MvizMatrixcode.ShapeType Shapes

Selects the possible orientation of the marking.

Property CheckQuality¶

System.Boolean CheckQuality

Computes the quality indicators, when true.

Property StartLevel¶

System.Int32 StartLevel

For large images, you can skip the first pyramid levels for faster execution; try small positive value.

Property AccurateEdges¶

System.Boolean AccurateEdges

When true, a final subpixel fit of the edges is performed for very accurate location.

Methods¶

Method ToString¶

System.String ToString()

Provide string representation for debugging purposes.