Represents a 1D Bar Code Reading Context. More...

Public Member Functions
None	__init__ (self)
	Constructs a eVision.EasyBarCode2.EBarCodeReader context.
None	__init__ (self, eVision.EasyBarCode2.EBarCodeReader other)
	Constructs a eVision.EasyBarCode2.EBarCodeReader context.
float	Learn (self, list[eVision._eVision.EROIBW8\|None] rois, bool keepDefaultScales, bool addAllScales)
	Learns the best options to use to read the given Images/ROIs.
float	Learn (self, list[eVision._eVision.EROIBW8\|None] rois, bool keepDefaultScales)
	Learns the best options to use to read the given Images/ROIs.
float	Learn (self, list[eVision._eVision.EROIBW8\|None] rois)
	Learns the best options to use to read the given Images/ROIs.
None	ResetLearning (self)
	Forgets the learned parameter settings and resets them to their default values.
list[eVision._eVision.EasyBarCode2.EBarCode]	Read (self, eVision.EROIBW8 img)
	Finds and reads all the barcodes in the provided Image/ROI.
list[eVision._eVision.EasyBarCode2.EBarCode]	Read (self, eVision.EROIBW8 img, eVision.EFrame frame)
	Finds and reads all the barcodes in the provided Image/ROI.
list[eVision._eVision.EasyBarCode2.EBarCode]	Read (self, eVision.EROIBW8 img, eVision.ERegion region)
	Finds and reads all the barcodes in the provided Image/ROI.
list[eVision._eVision.EasyBarCode2.EBarCode]	Read (self, eVision.EROIBW8 img, eVision.ERegion region, eVision.EFrame frame)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, int numCellsX, int numCellsY, float extension)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, int numCellsX, int numCellsY)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, eVision.EFrame frame, int numCellsX, int numCellsY, float extension)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, eVision.EFrame frame, int numCellsX, int numCellsY)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, eVision.EasyBarCode2.EBarCodeGrid grid, float extension)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, eVision.EasyBarCode2.EBarCodeGrid grid)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, eVision.EFrame frame, eVision.EasyBarCode2.EBarCodeGrid grid, float extension)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.ERectangleRegion area, eVision.EFrame frame, eVision.EasyBarCode2.EBarCodeGrid grid)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.EGrid grid)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (self, eVision.EROIBW8 img, eVision.EGrid grid, eVision.EFrame frame)
	Finds and reads all the barcodes in the provided Image/ROI.
None	EnableSymbology (self, eVision.EasyBarCode2.EBarCodeSymbologies symbology)
	Enables a single symbology.
None	EnableSymbologies (self, list[eVision._eVision.EasyBarCode2.EBarCodeSymbologies] symbologies)
	Enables a set of symbologies.
None	EnableAllSymbologies (self)
	Enables all supported symbologies, with the exception of eVision.EasyBarCode2.EBarCodeSymbologies.PDF417, eVision.EasyBarCode2.EBarCodeSymbologies.CodeStk, eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack and eVision.EasyBarCode2.EBarCodeSymbologies.BinaryCode because they might degrade the detection of other symbologies or generate false positives.
None	EnableSafeSymbologies (self)
	Enables all supported symbologies that do not degrade the detection of other symbologies or generate false positives.
None	EnableDefaultSymbologies (self)
	Enables default symbologies.
None	DisableAllSymbologies (self)
	Disables all symbologies.
None	Save (self, str file)
	Save the reader configuration.
None	Save (self, eVision.ESerializer\|None serializer)
	Save the reader configuration.
None	Load (self, str file)
	Load the reader configuration.
None	Load (self, eVision.ESerializer\|None serializer)
	Load the reader configuration.
bool	LearningPerformed (self)
	Returns whether a learning has been performed on the eVision.EasyBarCode2.EBarCodeReader.
int	MaxNumCodes (self)
	Maximum number of barcodes to find in a single Image/ROI.
	MaxNumCodes (self, int value)
	Maximum number of barcodes to find in a single Image/ROI.
bool	ValidateWithChecksum (self)
	Enables/Disables all barcode validations.
	ValidateWithChecksum (self, bool value)
	Enables/Disables all barcode validations.
bool	ValidateBarCode (self)
	Enables/Disables all barcode validations.
	ValidateBarCode (self, bool value)
	Enables/Disables all barcode validations.
bool	ValidateMandatoryChecksum (self)
	Enables/Disables checksum validation for all symbologies for which a checksum is mandatory, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code128.
	ValidateMandatoryChecksum (self, bool value)
	Enables/Disables checksum validation for all symbologies for which a checksum is mandatory, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code128.
bool	ValidateOptionalChecksum (self)
	Enables/Disables checksum validation for all symbologies for which a checksum is optional, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code39.
	ValidateOptionalChecksum (self, bool value)
	Enables/Disables checksum validation for all symbologies for which a checksum is optional, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code39.
bool	ValidatePharmacode (self)
	Enables/Disables validation for the eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack symbology.
	ValidatePharmacode (self, bool value)
	Enables/Disables validation for the eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack symbology.
list[eVision._eVision.EasyBarCode2.EBarCodeSymbologies]	EnabledSymbologies (self)
	Enabled symbologies.
int	TimeOut (self)
	Time-out for the eVision.EasyBarCode2.EBarCodeReader.Read method.
	TimeOut (self, int value)
	Time-out for the eVision.EasyBarCode2.EBarCodeReader.Read method.
float	MinModuleSize (self)
	Parameter used before version 24.10.
	MinModuleSize (self, float value)
	Parameter used before version 24.10.
bool	UseMinModuleSize (self)
	Parameter used before version 24.10.
	UseMinModuleSize (self, bool value)
	Parameter used before version 24.10.
bool	EnablePermissiveDecoding (self)
	Enables or disables the decoding of codes containing partially incorrect information.
	EnablePermissiveDecoding (self, bool value)
	Enables or disables the decoding of codes containing partially incorrect information.
bool	EnablePatternCorrection (self)
	Enables or disables the correction of patterns incorrectly decoded.
	EnablePatternCorrection (self, bool value)
	Enables or disables the correction of patterns incorrectly decoded.
bool	EnableAdvancedDecoding (self)
	Enables or disables some advanced decoding for the eVision.EasyBarCode2.EBarCodeSymbologies.Code128, eVision.EasyBarCode2.EBarCodeSymbologies.Gs1_128 and eVision.EasyBarCode2.EBarCodeSymbologies.Ean13 symbologies specifically.
	EnableAdvancedDecoding (self, bool value)
	Enables or disables some advanced decoding for the eVision.EasyBarCode2.EBarCodeSymbologies.Code128, eVision.EasyBarCode2.EBarCodeSymbologies.Gs1_128 and eVision.EasyBarCode2.EBarCodeSymbologies.Ean13 symbologies specifically.
bool	EnablePrintingErrorCorrection (self)
	Enables or disables the correction of patterns incorrectly printed.
	EnablePrintingErrorCorrection (self, bool value)
	Enables or disables the correction of patterns incorrectly printed.
eVision.EasyBarCode2.EReadingOrientation	ReadingOrientation (self)
	Some symbologies do not specify start and stop patterns, namely: eVision.EasyBarCode2.EBarCodeSymbologies.CodeStk, eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack and eVision.EasyBarCode2.EBarCodeSymbologies.BinaryCode.
	ReadingOrientation (self, eVision.EasyBarCode2.EReadingOrientation value)
	Some symbologies do not specify start and stop patterns, namely: eVision.EasyBarCode2.EBarCodeSymbologies.CodeStk, eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack and eVision.EasyBarCode2.EBarCodeSymbologies.BinaryCode.
bool	ComputeGrading (self)
	Enables or disables the computation of the grades of the read barcodes according to ISO 15416.
	ComputeGrading (self, bool value)
	Enables or disables the computation of the grades of the read barcodes according to ISO 15416.

Detailed Description

Represents a 1D Bar Code Reading Context.

Remarks:

License(s): EasyBarCode

Constructor & Destructor Documentation

◆ init() [1/2]

None eVision.EasyBarCode2.EBarCodeReader.__init__ ( self )

Constructs a eVision.EasyBarCode2.EBarCodeReader context.

Remarks:

The default constructor constructs an uninitialized eVision.EasyBarCode2.EBarCodeReader object. All properties are initialized to their respective default values. The copy constructor constructs a eVision.EasyBarCode2.EBarCodeReader context based on a pre-existing eVision.EasyBarCode2.EBarCodeReader object. All properties and internal data are copied.

◆ init() [2/2]

None eVision.EasyBarCode2.EBarCodeReader.__init__	(		self,
		eVision.EasyBarCode2.EBarCodeReader	other )

Constructs a eVision.EasyBarCode2.EBarCodeReader context.

Remarks:

The default constructor constructs an uninitialized eVision.EasyBarCode2.EBarCodeReader object. All properties are initialized to their respective default values. The copy constructor constructs a eVision.EasyBarCode2.EBarCodeReader context based on a pre-existing eVision.EasyBarCode2.EBarCodeReader object. All properties and internal data are copied.

Parameters

other Another eVision.EasyBarCode2.EBarCodeReader object to be copied in the new eVision.EasyBarCode2.EBarCodeReader object.

Member Function Documentation

◆ ComputeGrading() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.ComputeGrading ( self )

Enables or disables the computation of the grades of the read barcodes according to ISO 15416.

At the moment, grading is only supported for eVision.EasyBarCode2.EBarCodeSymbologies.Code128, eVision.EasyBarCode2.EBarCodeSymbologies.Gs1_128 and eVision.EasyBarCode2.EBarCodeSymbologies.Ean13.

Remarks:

ComputeGrading is disabled by default.

◆ ComputeGrading() [2/2]

eVision.EasyBarCode2.EBarCodeReader.ComputeGrading	(		self,
		bool	value )

Enables or disables the computation of the grades of the read barcodes according to ISO 15416.

At the moment, grading is only supported for eVision.EasyBarCode2.EBarCodeSymbologies.Code128, eVision.EasyBarCode2.EBarCodeSymbologies.Gs1_128 and eVision.EasyBarCode2.EBarCodeSymbologies.Ean13.

Remarks:

ComputeGrading is disabled by default.

◆ DisableAllSymbologies()

None eVision.EasyBarCode2.EBarCodeReader.DisableAllSymbologies ( self )

Disables all symbologies.

◆ EnableAdvancedDecoding() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.EnableAdvancedDecoding ( self )

Enables or disables some advanced decoding for the eVision.EasyBarCode2.EBarCodeSymbologies.Code128, eVision.EasyBarCode2.EBarCodeSymbologies.Gs1_128 and eVision.EasyBarCode2.EBarCodeSymbologies.Ean13 symbologies specifically.

In practice, when this option is set, the reader assumes a character might be badly printed and uses the checksum to correct that character. In rare cases, this option may lead to reading false positives codes.

Remarks:

Advanced decoding is enabled by default.

◆ EnableAdvancedDecoding() [2/2]

eVision.EasyBarCode2.EBarCodeReader.EnableAdvancedDecoding	(		self,
		bool	value )

Enables or disables some advanced decoding for the eVision.EasyBarCode2.EBarCodeSymbologies.Code128, eVision.EasyBarCode2.EBarCodeSymbologies.Gs1_128 and eVision.EasyBarCode2.EBarCodeSymbologies.Ean13 symbologies specifically.

In practice, when this option is set, the reader assumes a character might be badly printed and uses the checksum to correct that character. In rare cases, this option may lead to reading false positives codes.

Remarks:

Advanced decoding is enabled by default.

◆ EnableAllSymbologies()

None eVision.EasyBarCode2.EBarCodeReader.EnableAllSymbologies ( self )

Enables all supported symbologies, with the exception of eVision.EasyBarCode2.EBarCodeSymbologies.PDF417, eVision.EasyBarCode2.EBarCodeSymbologies.CodeStk, eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack and eVision.EasyBarCode2.EBarCodeSymbologies.BinaryCode because they might degrade the detection of other symbologies or generate false positives.

Deprecated

Deprecated, use eVision.EasyBarCode2.EBarCodeReader.EnableSafeSymbologies instead.

Deprecated in version 25.2. Scheduled to be removed in version 27.6.

◆ EnableDefaultSymbologies()

None eVision.EasyBarCode2.EBarCodeReader.EnableDefaultSymbologies ( self )

Enables default symbologies.

◆ EnabledSymbologies()

list[eVision._eVision.EasyBarCode2.EBarCodeSymbologies] eVision.EasyBarCode2.EBarCodeReader.EnabledSymbologies ( self )

Enabled symbologies.

◆ EnablePatternCorrection() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.EnablePatternCorrection ( self )

Enables or disables the correction of patterns incorrectly decoded.

By pattern, we mean a group of n consecutive strips that is decoded to a single value, these exist in most symbologies.

In practice, when this option is set, the reader matches a badly decoded pattern to the closest one in some cases. In rare cases, this option may lead to reading false positives codes. It has no effect for symbologies with complex decoding (e.g. GS1 DataBar, PDF417) or without patterns (e.g. Pharmacode).

Remarks:

Pattern correction is enabled by default.

◆ EnablePatternCorrection() [2/2]

eVision.EasyBarCode2.EBarCodeReader.EnablePatternCorrection	(		self,
		bool	value )

Enables or disables the correction of patterns incorrectly decoded.

By pattern, we mean a group of n consecutive strips that is decoded to a single value, these exist in most symbologies.

In practice, when this option is set, the reader matches a badly decoded pattern to the closest one in some cases. In rare cases, this option may lead to reading false positives codes. It has no effect for symbologies with complex decoding (e.g. GS1 DataBar, PDF417) or without patterns (e.g. Pharmacode).

Remarks:

Pattern correction is enabled by default.

◆ EnablePermissiveDecoding() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.EnablePermissiveDecoding ( self )

Enables or disables the decoding of codes containing partially incorrect information.

In practice, when this option is set, the reader assumes a character might be badly printed and uses the checksum to correct that character. In rare cases, this option may lead to reading false positives codes. It has no effect for symbologies in which a checksum is not mandatory.

Remarks:

Permissive decoding is enabled by default.

◆ EnablePermissiveDecoding() [2/2]

eVision.EasyBarCode2.EBarCodeReader.EnablePermissiveDecoding	(		self,
		bool	value )

Enables or disables the decoding of codes containing partially incorrect information.

In practice, when this option is set, the reader assumes a character might be badly printed and uses the checksum to correct that character. In rare cases, this option may lead to reading false positives codes. It has no effect for symbologies in which a checksum is not mandatory.

Remarks:

Permissive decoding is enabled by default.

◆ EnablePrintingErrorCorrection() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.EnablePrintingErrorCorrection ( self )

Enables or disables the correction of patterns incorrectly printed.

By pattern, we mean a group of n consecutive strips that is decoded to a single value, these exist in most symbologies.

In practice, when this option is set, the reader tries to correct some printing defects. For example some bar or space of a pattern that has a width of 1 module instead of 2. In some cases, this option may lead to reading false positives codes. It has no effect for symbologies with complex decoding (e.g. GS1 DataBar, PDF417) or without patterns (e.g. Pharmacode).

Note that eVision.EasyBarCode2.EBarCodeReader.EnablePrintingErrorCorrection adds an additional step in the processes enabled by eVision.EasyBarCode2.EBarCodeReader.EnableAdvancedDecoding and eVision.EasyBarCode2.EBarCodeReader.EnablePatternCorrection, so it has no effect when they are disabled.

Remarks:

Printing error correction is disabled by default.

◆ EnablePrintingErrorCorrection() [2/2]

eVision.EasyBarCode2.EBarCodeReader.EnablePrintingErrorCorrection	(		self,
		bool	value )

Enables or disables the correction of patterns incorrectly printed.

By pattern, we mean a group of n consecutive strips that is decoded to a single value, these exist in most symbologies.

In practice, when this option is set, the reader tries to correct some printing defects. For example some bar or space of a pattern that has a width of 1 module instead of 2. In some cases, this option may lead to reading false positives codes. It has no effect for symbologies with complex decoding (e.g. GS1 DataBar, PDF417) or without patterns (e.g. Pharmacode).

Note that eVision.EasyBarCode2.EBarCodeReader.EnablePrintingErrorCorrection adds an additional step in the processes enabled by eVision.EasyBarCode2.EBarCodeReader.EnableAdvancedDecoding and eVision.EasyBarCode2.EBarCodeReader.EnablePatternCorrection, so it has no effect when they are disabled.

Remarks:

Printing error correction is disabled by default.

◆ EnableSafeSymbologies()

None eVision.EasyBarCode2.EBarCodeReader.EnableSafeSymbologies ( self )

Enables all supported symbologies that do not degrade the detection of other symbologies or generate false positives.

That is, all with the exception of eVision.EasyBarCode2.EBarCodeSymbologies.PDF417, eVision.EasyBarCode2.EBarCodeSymbologies.CodeStk, eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack and eVision.EasyBarCode2.EBarCodeSymbologies.BinaryCode.

◆ EnableSymbologies()

None eVision.EasyBarCode2.EBarCodeReader.EnableSymbologies	(		self,
		list[eVision._eVision.EasyBarCode2.EBarCodeSymbologies]	symbologies )

Enables a set of symbologies.

Parameters

symbologies the vector of symbologies to enable

◆ EnableSymbology()

None eVision.EasyBarCode2.EBarCodeReader.EnableSymbology	(		self,
		eVision.EasyBarCode2.EBarCodeSymbologies	symbology )

Enables a single symbology.

Parameters

symbology the symbology to enable

◆ Learn() [1/3]

float eVision.EasyBarCode2.EBarCodeReader.Learn	(		self,
		list[eVision._eVision.EROIBW8 \| None]	rois )

Learns the best options to use to read the given Images/ROIs.

The scales at which we detect barcodes are modified. The other options (symbologies, checksum verification, max number of codes, ...) must be set by the user so that the codes are read correctly.

Returns \(\frac{NumberOfBarCodesLearned}{NumberOfImagesOrROI \times MaxNumCodes}\). If the return value is 0, i.e. no codes are read, the learned parameters are not modified.

Remarks:

Learning may have two benefits:

increasing the decoding capabilities at the cost of time (keepDefaultScales and addAllScales set to true)
increasing the speed at the cost of decoding capabilities on other images than the ones given (keepDefaultScales and addAllScales set to false)

Parameters

rois	ROIs in which to find the barcodes.

◆ Learn() [2/3]

float eVision.EasyBarCode2.EBarCodeReader.Learn	(		self,
		list[eVision._eVision.EROIBW8 \| None]	rois,
		bool	keepDefaultScales )

Learns the best options to use to read the given Images/ROIs.

The scales at which we detect barcodes are modified. The other options (symbologies, checksum verification, max number of codes, ...) must be set by the user so that the codes are read correctly.

Returns \(\frac{NumberOfBarCodesLearned}{NumberOfImagesOrROI \times MaxNumCodes}\). If the return value is 0, i.e. no codes are read, the learned parameters are not modified.

Remarks:

Learning may have two benefits:

increasing the decoding capabilities at the cost of time (keepDefaultScales and addAllScales set to true)
increasing the speed at the cost of decoding capabilities on other images than the ones given (keepDefaultScales and addAllScales set to false)

Parameters

rois	ROIs in which to find the barcodes.
keepDefaultScales	if true, Learning does not remove the scales used by default even if they are useless for the given images. Default: true

◆ Learn() [3/3]

float eVision.EasyBarCode2.EBarCodeReader.Learn	(		self,
		list[eVision._eVision.EROIBW8 \| None]	rois,
		bool	keepDefaultScales,
		bool	addAllScales )

Learns the best options to use to read the given Images/ROIs.

The scales at which we detect barcodes are modified. The other options (symbologies, checksum verification, max number of codes, ...) must be set by the user so that the codes are read correctly.

Returns \(\frac{NumberOfBarCodesLearned}{NumberOfImagesOrROI \times MaxNumCodes}\). If the return value is 0, i.e. no codes are read, the learned parameters are not modified.

Remarks:

Learning may have two benefits:

increasing the decoding capabilities at the cost of time (keepDefaultScales and addAllScales set to true)
increasing the speed at the cost of decoding capabilities on other images than the ones given (keepDefaultScales and addAllScales set to false)

Parameters

rois	ROIs in which to find the barcodes.
keepDefaultScales	if true, Learning does not remove the scales used by default even if they are useless for the given images. Default: true
addAllScales	if true, Learning adds all of the scales at which a code is detected. Otherwise, the smallest number of scales required to read all of the images is added. Default: true

◆ LearningPerformed()

bool eVision.EasyBarCode2.EBarCodeReader.LearningPerformed ( self )

Returns whether a learning has been performed on the eVision.EasyBarCode2.EBarCodeReader.

Remarks:

Note that after a failed call to eVision.EasyBarCode2.EBarCodeReader.Learn (the value of 0 was returned), calling this method will returns false.

◆ Load() [1/2]

None eVision.EasyBarCode2.EBarCodeReader.Load	(		self,
		eVision.ESerializer \| None	serializer )

Load the reader configuration.

Parameters

serializer Serializer. Must be in read mode.

◆ Load() [2/2]

None eVision.EasyBarCode2.EBarCodeReader.Load	(		self,
		str	file )

Load the reader configuration.

Parameters

file	File path.

◆ MaxNumCodes() [1/2]

int eVision.EasyBarCode2.EBarCodeReader.MaxNumCodes ( self )

Maximum number of barcodes to find in a single Image/ROI.

Remarks:

By default, this parameter is set to 1.

◆ MaxNumCodes() [2/2]

eVision.EasyBarCode2.EBarCodeReader.MaxNumCodes	(		self,
		int	value )

Maximum number of barcodes to find in a single Image/ROI.

Remarks:

By default, this parameter is set to 1.

◆ MinModuleSize() [1/2]

float eVision.EasyBarCode2.EBarCodeReader.MinModuleSize ( self )

Parameter used before version 24.10.

It has currently no effect.

◆ MinModuleSize() [2/2]

eVision.EasyBarCode2.EBarCodeReader.MinModuleSize	(		self,
		float	value )

Parameter used before version 24.10.

It has currently no effect.

◆ Read() [1/14]

list[eVision._eVision.EasyBarCode2.EBarCode] eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Parameters

img	Image/ROI in which to find the barcodes.

◆ Read() [2/14]

list[eVision._eVision.EasyBarCode2.EBarCode] eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.EFrame	frame )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Parameters

img	Image/ROI in which to find the barcodes.
frame	Reference frame of the input image

◆ Read() [3/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.EGrid	grid )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Parameters

img	Image/ROI in which to find the barcodes.
grid	Grid with cell disabling capabilities

◆ Read() [4/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.EGrid	grid,
		eVision.EFrame	frame )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Parameters

img	Image/ROI in which to find the barcodes.
grid	Grid with cell disabling capabilities
frame	Reference frame of the input image

◆ Read() [5/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		eVision.EasyBarCode2.EBarCodeGrid	grid )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
grid	Grid with cell disabling capabilities

◆ Read() [6/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		eVision.EasyBarCode2.EBarCodeGrid	grid,
		float	extension )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
grid	Grid with cell disabling capabilities
extension	Extension of the grid cells to allow cell overlap. For instance, 0.0 means no extension and 0.1 means a 10% cell size extension. default: 0.0

◆ Read() [7/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		eVision.EasyBarCode2.EBarCodeGrid	grid )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
frame	Reference frame of the input image
grid	Grid with cell disabling capabilities

◆ Read() [8/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		eVision.EasyBarCode2.EBarCodeGrid	grid,
		float	extension )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
frame	Reference frame of the input image
grid	Grid with cell disabling capabilities
extension	Extension of the grid cells to allow cell overlap. For instance, 0.0 means no extension and 0.1 means a 10% cell size extension. default: 0.0

◆ Read() [9/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		int	numCellsX,
		int	numCellsY )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
frame	Reference frame of the input image
numCellsX	Number of grid cells in the X direction
numCellsY	Number of grid cells in the Y direction

◆ Read() [10/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		int	numCellsX,
		int	numCellsY,
		float	extension )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
frame	Reference frame of the input image
numCellsX	Number of grid cells in the X direction
numCellsY	Number of grid cells in the Y direction
extension	Extension of the grid cells to allow cell overlap. For instance, 0.0 means no extension and 0.1 means a 10% cell size extension. default: 0.0

◆ Read() [11/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		int	numCellsX,
		int	numCellsY )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
numCellsX	Number of grid cells in the X direction
numCellsY	Number of grid cells in the Y direction

◆ Read() [12/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERectangleRegion	area,
		int	numCellsX,
		int	numCellsY,
		float	extension )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Deprecated

Deprecated, use overloads taking an eVision.EGrid argument instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters

img	Image/ROI in which to find the barcodes.
area	Rectangular Region used as the full grid area
numCellsX	Number of grid cells in the X direction
numCellsY	Number of grid cells in the Y direction
extension	Extension of the grid cells to allow cell overlap. For instance, 0.0 means no extension and 0.1 means a 10% cell size extension. default: 0.0

◆ Read() [13/14]

list[eVision._eVision.EasyBarCode2.EBarCode] eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERegion	region )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Parameters

img	Image/ROI in which to find the barcodes.
region	Optional region used to reduce the search domain.

◆ Read() [14/14]

list[eVision._eVision.EasyBarCode2.EBarCode] eVision.EasyBarCode2.EBarCodeReader.Read	(		self,
		eVision.EROIBW8	img,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Finds and reads all the barcodes in the provided Image/ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain barcodes. See the eVision.EasyBarCode2.EBarCodeGrid class documentation for more information.

Parameters

img	Image/ROI in which to find the barcodes.
region	Optional region used to reduce the search domain.
frame	Reference frame of the input image

◆ ReadingOrientation() [1/2]

eVision.EasyBarCode2.EReadingOrientation eVision.EasyBarCode2.EBarCodeReader.ReadingOrientation ( self )

Some symbologies do not specify start and stop patterns, namely: eVision.EasyBarCode2.EBarCodeSymbologies.CodeStk, eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack and eVision.EasyBarCode2.EBarCodeSymbologies.BinaryCode.

In these cases, we do not know if we should decode the barcode from left to right or from right to left. eVision.EasyBarCode2.EBarCodeReader.ReadingOrientation solves this problem.

Remarks:

The default orientation is eVision.EasyBarCode2.EReadingOrientation.LeftToRight.

◆ ReadingOrientation() [2/2]

eVision.EasyBarCode2.EBarCodeReader.ReadingOrientation	(		self,
		eVision.EasyBarCode2.EReadingOrientation	value )

Some symbologies do not specify start and stop patterns, namely: eVision.EasyBarCode2.EBarCodeSymbologies.CodeStk, eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack and eVision.EasyBarCode2.EBarCodeSymbologies.BinaryCode.

In these cases, we do not know if we should decode the barcode from left to right or from right to left. eVision.EasyBarCode2.EBarCodeReader.ReadingOrientation solves this problem.

Remarks:

The default orientation is eVision.EasyBarCode2.EReadingOrientation.LeftToRight.

◆ ResetLearning()

None eVision.EasyBarCode2.EBarCodeReader.ResetLearning ( self )

Forgets the learned parameter settings and resets them to their default values.

◆ Save() [1/2]

None eVision.EasyBarCode2.EBarCodeReader.Save	(		self,
		eVision.ESerializer \| None	serializer )

Save the reader configuration.

Parameters

serializer Serializer. Must be in write mode.

◆ Save() [2/2]

None eVision.EasyBarCode2.EBarCodeReader.Save	(		self,
		str	file )

Save the reader configuration.

Parameters

file	File path.

◆ TimeOut() [1/2]

int eVision.EasyBarCode2.EBarCodeReader.TimeOut ( self )

Time-out for the eVision.EasyBarCode2.EBarCodeReader.Read method.

Remarks:

If the processing time of one of these functions becomes longer than the set time-out, the processing is stopped and an exception is thrown. In that case, the error code of the exception is eVision.EError.TimeoutReached.

The time-out is set in microseconds.

This time-out is not a real time-out. The processing is stopped as soon as possible after the time-out has been reached. This means that the time elapsed effectively in the method can be greater than the time-out itself.

◆ TimeOut() [2/2]

eVision.EasyBarCode2.EBarCodeReader.TimeOut	(		self,
		int	value )

Time-out for the eVision.EasyBarCode2.EBarCodeReader.Read method.

Remarks:

If the processing time of one of these functions becomes longer than the set time-out, the processing is stopped and an exception is thrown. In that case, the error code of the exception is eVision.EError.TimeoutReached.

The time-out is set in microseconds.

This time-out is not a real time-out. The processing is stopped as soon as possible after the time-out has been reached. This means that the time elapsed effectively in the method can be greater than the time-out itself.

◆ UseMinModuleSize() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.UseMinModuleSize ( self )

Parameter used before version 24.10.

It has currently no effect.

◆ UseMinModuleSize() [2/2]

eVision.EasyBarCode2.EBarCodeReader.UseMinModuleSize	(		self,
		bool	value )

Parameter used before version 24.10.

It has currently no effect.

◆ ValidateBarCode() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.ValidateBarCode ( self )

Enables/Disables all barcode validations.

Remarks:

If this validation is enabled, barcodes with an erroneous checksum will not be returned.

For the PharmaCodeOneTrack symbology, no checksum is computed. We instead validate that the barcode is coherent along its height and that the relative width of the bars/space are coherent with the symbology's specification. This allow to reduce the number of false positives significantly.

Some symbologies have an optional checksum, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code39, for these symbologies, enforcing checksum validation comes at the risk of removing good barcodes that do not have a checksum. See list of supported codes.

By default, validation is enforced when checksum is mandatory for the symbology and for Pharmacodes.

Deprecated

Deprecated, use eVision.EasyBarCode2.EBarCodeReader.ValidateMandatoryChecksum, eVision.EasyBarCode2.EBarCodeReader.ValidateOptionalChecksum and eVision.EasyBarCode2.EBarCodeReader.ValidatePharmacode instead.

Deprecated in version 23.4. Scheduled to be removed in version 27.6.

◆ ValidateBarCode() [2/2]

eVision.EasyBarCode2.EBarCodeReader.ValidateBarCode	(		self,
		bool	value )

Enables/Disables all barcode validations.

Remarks:

If this validation is enabled, barcodes with an erroneous checksum will not be returned.

For the PharmaCodeOneTrack symbology, no checksum is computed. We instead validate that the barcode is coherent along its height and that the relative width of the bars/space are coherent with the symbology's specification. This allow to reduce the number of false positives significantly.

Some symbologies have an optional checksum, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code39, for these symbologies, enforcing checksum validation comes at the risk of removing good barcodes that do not have a checksum. See list of supported codes.

By default, validation is enforced when checksum is mandatory for the symbology and for Pharmacodes.

Deprecated

Deprecated, use eVision.EasyBarCode2.EBarCodeReader.ValidateMandatoryChecksum, eVision.EasyBarCode2.EBarCodeReader.ValidateOptionalChecksum and eVision.EasyBarCode2.EBarCodeReader.ValidatePharmacode instead.

Deprecated in version 23.4. Scheduled to be removed in version 27.6.

◆ ValidateMandatoryChecksum() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.ValidateMandatoryChecksum ( self )

Enables/Disables checksum validation for all symbologies for which a checksum is mandatory, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code128.

See list of supported codes.

Remarks:

If validation is enabled for symbologies with a mandatory checksum, barcodes of these symbologies with an erroneous checksum will not be returned.

By default, validation is enforced when checksum is mandatory.

◆ ValidateMandatoryChecksum() [2/2]

eVision.EasyBarCode2.EBarCodeReader.ValidateMandatoryChecksum	(		self,
		bool	value )

Enables/Disables checksum validation for all symbologies for which a checksum is mandatory, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code128.

See list of supported codes.

Remarks:

If validation is enabled for symbologies with a mandatory checksum, barcodes of these symbologies with an erroneous checksum will not be returned.

By default, validation is enforced when checksum is mandatory.

◆ ValidateOptionalChecksum() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.ValidateOptionalChecksum ( self )

Enables/Disables checksum validation for all symbologies for which a checksum is optional, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code39.

See list of supported codes.

Remarks:

If validation is enabled for symbologies with an optional checksum, barcodes of these symbologies with an erroneous checksum will not be returned.

By default, validation is not enforced when checksum is optional to avoid removing correct codes.

◆ ValidateOptionalChecksum() [2/2]

eVision.EasyBarCode2.EBarCodeReader.ValidateOptionalChecksum	(		self,
		bool	value )

Enables/Disables checksum validation for all symbologies for which a checksum is optional, for example eVision.EasyBarCode2.EBarCodeSymbologies.Code39.

See list of supported codes.

Remarks:

If validation is enabled for symbologies with an optional checksum, barcodes of these symbologies with an erroneous checksum will not be returned.

By default, validation is not enforced when checksum is optional to avoid removing correct codes.

◆ ValidatePharmacode() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.ValidatePharmacode ( self )

Enables/Disables validation for the eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack symbology.

Remarks:

Pharmacodes are validated by checking that the barcode is coherent along its height and that the relative width of the bars/space are coherent with the symbology's specification. This allows to reduce the number of false positives significantly.

By default, validation is enforced for Pharmacodes.

◆ ValidatePharmacode() [2/2]

eVision.EasyBarCode2.EBarCodeReader.ValidatePharmacode	(		self,
		bool	value )

Enables/Disables validation for the eVision.EasyBarCode2.EBarCodeSymbologies.PharmacodeOneTrack symbology.

Remarks:

Pharmacodes are validated by checking that the barcode is coherent along its height and that the relative width of the bars/space are coherent with the symbology's specification. This allows to reduce the number of false positives significantly.

By default, validation is enforced for Pharmacodes.

◆ ValidateWithChecksum() [1/2]

bool eVision.EasyBarCode2.EBarCodeReader.ValidateWithChecksum ( self )

Enables/Disables all barcode validations.

Deprecated

Deprecated, use eVision.EasyBarCode2.EBarCodeReader.ValidateMandatoryChecksum, eVision.EasyBarCode2.EBarCodeReader.ValidateOptionalChecksum and eVision.EasyBarCode2.EBarCodeReader.ValidatePharmacode instead.

Deprecated in version 23.4. Scheduled to be removed in version 27.6.

◆ ValidateWithChecksum() [2/2]

eVision.EasyBarCode2.EBarCodeReader.ValidateWithChecksum	(		self,
		bool	value )

Enables/Disables all barcode validations.

Deprecated

Deprecated, use eVision.EasyBarCode2.EBarCodeReader.ValidateMandatoryChecksum, eVision.EasyBarCode2.EBarCodeReader.ValidateOptionalChecksum and eVision.EasyBarCode2.EBarCodeReader.ValidatePharmacode instead.

Deprecated in version 23.4. Scheduled to be removed in version 27.6.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ ComputeGrading() [1/2]

◆ ComputeGrading() [2/2]

◆ DisableAllSymbologies()

◆ EnableAdvancedDecoding() [1/2]

◆ EnableAdvancedDecoding() [2/2]

◆ EnableAllSymbologies()

◆ EnableDefaultSymbologies()

◆ EnabledSymbologies()

◆ EnablePatternCorrection() [1/2]

◆ EnablePatternCorrection() [2/2]

◆ EnablePermissiveDecoding() [1/2]

◆ EnablePermissiveDecoding() [2/2]

◆ EnablePrintingErrorCorrection() [1/2]

◆ EnablePrintingErrorCorrection() [2/2]

◆ EnableSafeSymbologies()

◆ EnableSymbologies()

◆ EnableSymbology()

◆ Learn() [1/3]

◆ Learn() [2/3]

◆ Learn() [3/3]

◆ LearningPerformed()

◆ Load() [1/2]

◆ Load() [2/2]

◆ MaxNumCodes() [1/2]

◆ MaxNumCodes() [2/2]

◆ MinModuleSize() [1/2]

◆ MinModuleSize() [2/2]

◆ Read() [1/14]

◆ Read() [2/14]

◆ Read() [3/14]

◆ Read() [4/14]

◆ Read() [5/14]

◆ Read() [6/14]

◆ Read() [7/14]

◆ Read() [8/14]

◆ Read() [9/14]

◆ Read() [10/14]

◆ Read() [11/14]

◆ Read() [12/14]

◆ Read() [13/14]

◆ Read() [14/14]

◆ ReadingOrientation() [1/2]

◆ ReadingOrientation() [2/2]

◆ ResetLearning()

◆ Save() [1/2]

◆ Save() [2/2]

◆ TimeOut() [1/2]

◆ TimeOut() [2/2]

◆ UseMinModuleSize() [1/2]

◆ UseMinModuleSize() [2/2]

◆ ValidateBarCode() [1/2]

◆ ValidateBarCode() [2/2]

◆ ValidateMandatoryChecksum() [1/2]

◆ ValidateMandatoryChecksum() [2/2]

◆ ValidateOptionalChecksum() [1/2]

◆ ValidateOptionalChecksum() [2/2]

◆ ValidatePharmacode() [1/2]

◆ ValidatePharmacode() [2/2]

◆ ValidateWithChecksum() [1/2]

◆ ValidateWithChecksum() [2/2]

◆ init() [1/2]

◆ init() [2/2]