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

Inheritance diagram for eVision.EasyBarCode2.EBarCodeReader:

Collaboration diagram for eVision.EasyBarCode2.EBarCodeReader:

Public Member Functions
	EBarCodeReader ()
	Constructs a EBarCodeReader context.
	EBarCodeReader (eVision.EasyBarCode2.EBarCodeReader other)
	Constructs a EBarCodeReader context.
float	Learn (eVision.EROIBW8[] 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.
float	Learn (eVision.EROIBW8[] 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.
float	Learn (eVision.EROIBW8[] 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.
float	Learn (eVision.EImageBW8[] images, 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.
float	Learn (eVision.EImageBW8[] images, 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.
float	Learn (eVision.EImageBW8[] images)
	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.
void	ResetLearning ()
	Forgets the learned parameter settings and resets them to their default values.
eVision.EasyBarCode2.EBarCode[]	Read (eVision.EROIBW8 img)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCode[]	Read (eVision.EROIBW8 img, eVision.EFrame frame)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCode[]	Read (eVision.EROIBW8 img, eVision.ERegion region)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCode[]	Read (eVision.EROIBW8 img, eVision.ERegion region, eVision.EFrame frame)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (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 (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 (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 (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 (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 (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 (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 (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 (eVision.EROIBW8 img, eVision.EGrid grid)
	Finds and reads all the barcodes in the provided Image/ROI.
eVision.EasyBarCode2.EBarCodeGrid	Read (eVision.EROIBW8 img, eVision.EGrid grid, eVision.EFrame frame)
	Finds and reads all the barcodes in the provided Image/ROI.
void	EnableSymbology (eVision.EasyBarCode2.EBarCodeSymbologies symbology)
	Enables a single symbology.
void	EnableSymbologies (eVision.EasyBarCode2.EBarCodeSymbologies[] symbologies)
	Enables a set of symbologies.
void	EnableAllSymbologies ()
	Enables all supported symbologies, with the exception of EBarCodeSymbologies.EBarCodeSymbologies_PDF417, EBarCodeSymbologies.EBarCodeSymbologies_CodeStk, EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack and EBarCodeSymbologies.EBarCodeSymbologies_BinaryCode because they might degrade the detection of other symbologies or generate false positives.
void	EnableSafeSymbologies ()
	Enables all supported symbologies that do not degrade the detection of other symbologies or generate false positives. That is, all with the exception of EBarCodeSymbologies.EBarCodeSymbologies_PDF417, EBarCodeSymbologies.EBarCodeSymbologies_CodeStk, EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack and EBarCodeSymbologies.EBarCodeSymbologies_BinaryCode.
void	EnableDefaultSymbologies ()
	Enables default symbologies.
void	DisableAllSymbologies ()
	Disables all symbologies.
void	Save (string file)
	Save the reader configuration.
void	Save (eVision.ESerializer serializer)
	Save the reader configuration.
void	Load (string file)
	Load the reader configuration.
void	Load (eVision.ESerializer serializer)
	Load the reader configuration.

Properties
bool	LearningPerformed `[get]`
	Returns whether a learning has been performed on the EBarCodeReader.
uint	MaxNumCodes `[get, set]`
	Maximum number of barcodes to find in a single Image/ROI.
bool	ValidateWithChecksum `[get, set]`
	Enables/Disables all barcode validations.
bool	ValidateBarCode `[get, set]`
	Enables/Disables all barcode validations.
bool	ValidateMandatoryChecksum `[get, set]`
	Enables/Disables checksum validation for all symbologies for which a checksum is mandatory, for example EBarCodeSymbologies.EBarCodeSymbologies_Code128.
bool	ValidateOptionalChecksum `[get, set]`
	Enables/Disables checksum validation for all symbologies for which a checksum is optional, for example EBarCodeSymbologies.EBarCodeSymbologies_Code39.
bool	ValidatePharmacode `[get, set]`
	Enables/Disables validation for the EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack symbology.
eVision.EasyBarCode2.EBarCodeSymbologies[]	EnabledSymbologies `[get]`
	Enabled symbologies.
ulong	TimeOut `[get, set]`
	Time-out for the EBarCodeReader.Read method.
float	MinModuleSize `[get, set]`
	Parameter used before version 24.10. It has currently no effect.
bool	UseMinModuleSize `[get, set]`
	Parameter used before version 24.10. It has currently no effect.
bool	EnablePermissiveDecoding `[get, set]`
	Enables or disables the decoding of codes containing partially incorrect information.
bool	EnablePatternCorrection `[get, set]`
	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.
bool	EnableAdvancedDecoding `[get, set]`
	Enables or disables some advanced decoding for the EBarCodeSymbologies.EBarCodeSymbologies_Code128, EBarCodeSymbologies.EBarCodeSymbologies_Gs1_128 and EBarCodeSymbologies.EBarCodeSymbologies_Ean13 symbologies specifically.
bool	EnablePrintingErrorCorrection `[get, set]`
	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.
eVision.EasyBarCode2.EReadingOrientation	ReadingOrientation `[get, set]`
	Some symbologies do not specify start and stop patterns, namely: EBarCodeSymbologies.EBarCodeSymbologies_CodeStk, EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack and EBarCodeSymbologies.EBarCodeSymbologies_BinaryCode. In these cases, we do not know if we should decode the barcode from left to right or from right to left. EBarCodeReader.ReadingOrientation solves this problem.
bool	ComputeGrading `[get, set]`
	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.

License(s): EasyBarCode

Constructor & Destructor Documentation

◆ EBarCodeReader() [1/2]

eVision.EasyBarCode2.EBarCodeReader.EBarCodeReader ( )

Constructs a EBarCodeReader context.

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

◆ EBarCodeReader() [2/2]

eVision.EasyBarCode2.EBarCodeReader.EBarCodeReader ( eVision.EasyBarCode2.EBarCodeReader other )

Constructs a EBarCodeReader context.

Parameters

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

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

Member Function Documentation

◆ DisableAllSymbologies()

void eVision.EasyBarCode2.EBarCodeReader.DisableAllSymbologies ( )

Disables all symbologies.

◆ EnableAllSymbologies()

void eVision.EasyBarCode2.EBarCodeReader.EnableAllSymbologies ( )

Enables all supported symbologies, with the exception of EBarCodeSymbologies.EBarCodeSymbologies_PDF417, EBarCodeSymbologies.EBarCodeSymbologies_CodeStk, EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack and EBarCodeSymbologies.EBarCodeSymbologies_BinaryCode because they might degrade the detection of other symbologies or generate false positives.

Deprecated

Deprecated, use EBarCodeReader.EnableSafeSymbologies instead.

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

◆ EnableDefaultSymbologies()

void eVision.EasyBarCode2.EBarCodeReader.EnableDefaultSymbologies ( )

Enables default symbologies.

◆ EnableSafeSymbologies()

void eVision.EasyBarCode2.EBarCodeReader.EnableSafeSymbologies ( )

Enables all supported symbologies that do not degrade the detection of other symbologies or generate false positives. That is, all with the exception of EBarCodeSymbologies.EBarCodeSymbologies_PDF417, EBarCodeSymbologies.EBarCodeSymbologies_CodeStk, EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack and EBarCodeSymbologies.EBarCodeSymbologies_BinaryCode.

◆ EnableSymbologies()

void eVision.EasyBarCode2.EBarCodeReader.EnableSymbologies ( eVision.EasyBarCode2.EBarCodeSymbologies[] symbologies )

Enables a set of symbologies.

Parameters

symbologies the vector of symbologies to enable

◆ EnableSymbology()

void eVision.EasyBarCode2.EBarCodeReader.EnableSymbology ( eVision.EasyBarCode2.EBarCodeSymbologies symbology )

Enables a single symbology.

Parameters

symbology the symbology to enable

◆ Learn() [1/6]

float eVision.EasyBarCode2.EBarCodeReader.Learn ( eVision.EImageBW8[] images )

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.

Parameters

images Images in which to find the barcodes.

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)

◆ Learn() [2/6]

float eVision.EasyBarCode2.EBarCodeReader.Learn	(	eVision.EImageBW8[]	images,
		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.

Parameters

images	Images 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

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)

◆ Learn() [3/6]

float eVision.EasyBarCode2.EBarCodeReader.Learn	(	eVision.EImageBW8[]	images,
		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.

Parameters

images	Images 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

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)

◆ Learn() [4/6]

float eVision.EasyBarCode2.EBarCodeReader.Learn ( eVision.EROIBW8[] 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.

Parameters

rois	ROIs in which to find the barcodes.

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)

◆ Learn() [5/6]

float eVision.EasyBarCode2.EBarCodeReader.Learn	(	eVision.EROIBW8[]	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.

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

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)

◆ Learn() [6/6]

float eVision.EasyBarCode2.EBarCodeReader.Learn	(	eVision.EROIBW8[]	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.

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

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)

◆ Load() [1/2]

void eVision.EasyBarCode2.EBarCodeReader.Load ( eVision.ESerializer serializer )

Load the reader configuration.

Parameters

serializer Serializer. Must be in read mode.

◆ Load() [2/2]

void eVision.EasyBarCode2.EBarCodeReader.Load ( string file )

Load the reader configuration.

Parameters

file	File path.

◆ Read() [1/14]

eVision.EasyBarCode2.EBarCode[] eVision.EasyBarCode2.EBarCodeReader.Read ( eVision.EROIBW8 img )

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

Parameters

img	Image/ROI in which to find the barcodes.

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

◆ Read() [2/14]

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

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

Parameters

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

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

◆ Read() [3/14]

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

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

Parameters

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

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

◆ Read() [4/14]

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

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

Parameters

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

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

◆ Read() [5/14]

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

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

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [6/14]

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

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

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [7/14]

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

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

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [8/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(	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.

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [9/14]

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

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

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [10/14]

eVision.EasyBarCode2.EBarCodeGrid eVision.EasyBarCode2.EBarCodeReader.Read	(	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.

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [11/14]

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

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

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [12/14]

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

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

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

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

Deprecated

Deprecated, use overloads taking an EGrid argument instead.

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

◆ Read() [13/14]

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

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

Parameters

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

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

◆ Read() [14/14]

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

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

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

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

◆ ResetLearning()

void eVision.EasyBarCode2.EBarCodeReader.ResetLearning ( )

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

◆ Save() [1/2]

void eVision.EasyBarCode2.EBarCodeReader.Save ( eVision.ESerializer serializer )

Save the reader configuration.

Parameters

serializer Serializer. Must be in write mode.

◆ Save() [2/2]

void eVision.EasyBarCode2.EBarCodeReader.Save ( string file )

Save the reader configuration.

Parameters

file	File path.

Property Documentation

◆ ComputeGrading

bool eVision.EasyBarCode2.EBarCodeReader.ComputeGrading

getset

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

At the moment, grading is only supported for EBarCodeSymbologies.EBarCodeSymbologies_Code128, EBarCodeSymbologies.EBarCodeSymbologies_Gs1_128 and EBarCodeSymbologies.EBarCodeSymbologies_Ean13.

ComputeGrading is disabled by default.

◆ EnableAdvancedDecoding

bool eVision.EasyBarCode2.EBarCodeReader.EnableAdvancedDecoding

getset

Enables or disables some advanced decoding for the EBarCodeSymbologies.EBarCodeSymbologies_Code128, EBarCodeSymbologies.EBarCodeSymbologies_Gs1_128 and EBarCodeSymbologies.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.

Advanced decoding is enabled by default.

◆ EnabledSymbologies

eVision.EasyBarCode2.EBarCodeSymbologies [] eVision.EasyBarCode2.EBarCodeReader.EnabledSymbologies

get

Enabled symbologies.

◆ EnablePatternCorrection

bool eVision.EasyBarCode2.EBarCodeReader.EnablePatternCorrection

getset

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).

Pattern correction is enabled by default.

◆ EnablePermissiveDecoding

bool eVision.EasyBarCode2.EBarCodeReader.EnablePermissiveDecoding

getset

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.

Permissive decoding is enabled by default.

◆ EnablePrintingErrorCorrection

bool eVision.EasyBarCode2.EBarCodeReader.EnablePrintingErrorCorrection

getset

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 EBarCodeReader.EnablePrintingErrorCorrection adds an additional step in the processes enabled by EBarCodeReader.EnableAdvancedDecoding and EBarCodeReader.EnablePatternCorrection, so it has no effect when they are disabled.

Printing error correction is disabled by default.

◆ LearningPerformed

bool eVision.EasyBarCode2.EBarCodeReader.LearningPerformed

get

Returns whether a learning has been performed on the EBarCodeReader.

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

◆ MaxNumCodes

uint eVision.EasyBarCode2.EBarCodeReader.MaxNumCodes

getset

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

By default, this parameter is set to 1.

◆ MinModuleSize

float eVision.EasyBarCode2.EBarCodeReader.MinModuleSize

getset

Parameter used before version 24.10. It has currently no effect.

◆ ReadingOrientation

eVision.EasyBarCode2.EReadingOrientation eVision.EasyBarCode2.EBarCodeReader.ReadingOrientation

getset

Some symbologies do not specify start and stop patterns, namely: EBarCodeSymbologies.EBarCodeSymbologies_CodeStk, EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack and EBarCodeSymbologies.EBarCodeSymbologies_BinaryCode. In these cases, we do not know if we should decode the barcode from left to right or from right to left. EBarCodeReader.ReadingOrientation solves this problem.

The default orientation is EReadingOrientation.EReadingOrientation_LeftToRight.

◆ TimeOut

ulong eVision.EasyBarCode2.EBarCodeReader.TimeOut

getset

Time-out for the EBarCodeReader.Read method.

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 EError.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

bool eVision.EasyBarCode2.EBarCodeReader.UseMinModuleSize

getset

Parameter used before version 24.10. It has currently no effect.

◆ ValidateBarCode

bool eVision.EasyBarCode2.EBarCodeReader.ValidateBarCode

getset

Enables/Disables all barcode validations.

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 EBarCodeSymbologies.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 EBarCodeReader.ValidateMandatoryChecksum, EBarCodeReader.ValidateOptionalChecksum and EBarCodeReader.ValidatePharmacode instead.

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

◆ ValidateMandatoryChecksum

bool eVision.EasyBarCode2.EBarCodeReader.ValidateMandatoryChecksum

getset

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

See list of supported codes.

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

bool eVision.EasyBarCode2.EBarCodeReader.ValidateOptionalChecksum

getset

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

See list of supported codes.

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

bool eVision.EasyBarCode2.EBarCodeReader.ValidatePharmacode

getset

Enables/Disables validation for the EBarCodeSymbologies.EBarCodeSymbologies_PharmacodeOneTrack symbology.

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

bool eVision.EasyBarCode2.EBarCodeReader.ValidateWithChecksum

getset

Enables/Disables all barcode validations.

Deprecated

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EBarCodeReader() [1/2]

◆ EBarCodeReader() [2/2]

Member Function Documentation

◆ DisableAllSymbologies()

◆ EnableAllSymbologies()

◆ EnableDefaultSymbologies()

◆ EnableSafeSymbologies()

◆ EnableSymbologies()

◆ EnableSymbology()

◆ Learn() [1/6]

◆ Learn() [2/6]

◆ Learn() [3/6]

◆ Learn() [4/6]

◆ Learn() [5/6]

◆ Learn() [6/6]

◆ Load() [1/2]

◆ Load() [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]

◆ ResetLearning()

◆ Save() [1/2]

◆ Save() [2/2]

Property Documentation

◆ ComputeGrading

◆ EnableAdvancedDecoding

◆ EnabledSymbologies

◆ EnablePatternCorrection

◆ EnablePermissiveDecoding

◆ EnablePrintingErrorCorrection

◆ LearningPerformed

◆ MaxNumCodes

◆ MinModuleSize

◆ ReadingOrientation

◆ TimeOut

◆ UseMinModuleSize

◆ ValidateBarCode

◆ ValidateMandatoryChecksum

◆ ValidateOptionalChecksum

◆ ValidatePharmacode

◆ ValidateWithChecksum