An eVision.ECodeReader instance can detect and decode various types of codes. More...

Public Member Functions
None	__init__ (self)
	Creates an eVision.ECodeReader object.
None	__init__ (self, eVision.ECodeReader other)
	Creates an eVision.ECodeReader object.
list[eVision._eVision.ECode]	Read (self, eVision.EROIBW8 roi)
	Tries to locate, decode and read data codes in the given ROI.
list[eVision._eVision.ECode]	Read (self, eVision.EROIBW8 roi, eVision.EFrame frame)
	Tries to locate, decode and read data codes in the given ROI.
list[eVision._eVision.ECode]	Read (self, eVision.EROIBW8 roi, eVision.ERegion region)
	Tries to locate, decode and read data codes in the given ROI.
list[eVision._eVision.ECode]	Read (self, eVision.EROIBW8 roi, eVision.ERegion region, eVision.EFrame frame)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, int numCellsX, int numCellsY, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, int numCellsX, int numCellsY)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, int numCellsX, int numCellsY, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, int numCellsX, int numCellsY)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.ECodeGrid grid, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.ECodeGrid grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, eVision.ECodeGrid grid, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, eVision.ECodeGrid grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.EGrid grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (self, eVision.EROIBW8 roi, eVision.EGrid grid, eVision.EFrame frame)
	Tries to locate, decode and read data codes in the given ROI.
None	Load (self, str path)
	Load the configuration for this eVision.ECodeReader instance.
None	Load (self, eVision.ESerializer\|None serializer)
	Load the configuration for this eVision.ECodeReader instance.
None	Save (self, str path)
	Save the configuration for this eVision.ECodeReader instance.
None	Save (self, eVision.ESerializer\|None serializer)
	Save the configuration for this eVision.ECodeReader instance.
int	MaxNumCodesPerType (self)
	The maximum number of codes that the reader should try to find.
	MaxNumCodesPerType (self, int value)
	The maximum number of codes that the reader should try to find.
int	TimeOut (self)
	The timeout for the eVision.ECodeReader.Read method in microseconds.
	TimeOut (self, int value)
	The timeout for the eVision.ECodeReader.Read method in microseconds.
list[eVision._eVision.ECodeType]	EnabledCodeTypes (self)
	The enabled code types.
	EnabledCodeTypes (self, list[eVision._eVision.ECodeType] value)
	The enabled code types.
eVision.EasyMatrixCode2.EMatrixCodeReader	MatrixCodeReader (self)
	Gets the underlying EMatrixCodeReader instance.
eVision.EasyBarCode2.EBarCodeReader	BarCodeReader (self)
	Gets the underlying EBarCodeReader instance.
eVision.EQRCodeReader	QRCodeReader (self)
	Gets the underlying EQRCodeReader instance.

Detailed Description

An eVision.ECodeReader instance can detect and decode various types of codes.

Remarks:

License(s): EasyMatrixCode and EasyBarCode and EasyQRCode

Constructor & Destructor Documentation

◆ init() [1/2]

None eVision.ECodeReader.__init__ ( self )

Creates an eVision.ECodeReader object.

◆ init() [2/2]

None eVision.ECodeReader.__init__	(		self,
		eVision.ECodeReader	other )

Creates an eVision.ECodeReader object.

Parameters

other Another eVision.ECodeReader object to be copied in the new eVision.ECodeReader object.

Member Function Documentation

◆ BarCodeReader()

eVision.EasyBarCode2.EBarCodeReader eVision.ECodeReader.BarCodeReader ( self )

Gets the underlying EBarCodeReader instance.

◆ EnabledCodeTypes() [1/2]

list[eVision._eVision.ECodeType] eVision.ECodeReader.EnabledCodeTypes ( self )

The enabled code types.

Remarks:

All code types enabled by default

◆ EnabledCodeTypes() [2/2]

eVision.ECodeReader.EnabledCodeTypes	(		self,
		list[eVision._eVision.ECodeType]	value )

The enabled code types.

Remarks:

All code types enabled by default

◆ Load() [1/2]

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

Load the configuration for this eVision.ECodeReader instance.

Parameters

serializer The serializer.

◆ Load() [2/2]

None eVision.ECodeReader.Load	(		self,
		str	path )

Load the configuration for this eVision.ECodeReader instance.

Parameters

path	The path from which to load the configuration.

◆ MatrixCodeReader()

eVision.EasyMatrixCode2.EMatrixCodeReader eVision.ECodeReader.MatrixCodeReader ( self )

Gets the underlying EMatrixCodeReader instance.

◆ MaxNumCodesPerType() [1/2]

int eVision.ECodeReader.MaxNumCodesPerType ( self )

The maximum number of codes that the reader should try to find.

Remarks:

By default, this parameter is set to 1.

◆ MaxNumCodesPerType() [2/2]

eVision.ECodeReader.MaxNumCodesPerType	(		self,
		int	value )

The maximum number of codes that the reader should try to find.

Remarks:

By default, this parameter is set to 1.

◆ QRCodeReader()

eVision.EQRCodeReader eVision.ECodeReader.QRCodeReader ( self )

Gets the underlying EQRCodeReader instance.

◆ Read() [1/14]

list[eVision._eVision.ECode] eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

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

Parameters

roi	The ROI in which the data matrix codes have to be found.

◆ Read() [2/14]

list[eVision._eVision.ECode] eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.EFrame	frame )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
frame	Reference frame of the input image

◆ Read() [3/14]

eVision.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.EGrid	grid )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
grid	Grid with cell disabling capabilities

◆ Read() [4/14]

eVision.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.EGrid	grid,
		eVision.EFrame	frame )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
grid	Grid with cell disabling capabilities
frame	Reference frame of the input image

◆ Read() [5/14]

eVision.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.ECodeGrid	grid )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
area	Rectangular Region used as the full grid area
grid	Grid with cell disabling capabilities

◆ Read() [6/14]

eVision.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.ECodeGrid	grid,
		float	extension )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
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.0f means no extension and 0.1f means a 10% cell size extension.

◆ Read() [7/14]

eVision.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		eVision.ECodeGrid	grid )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
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.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		eVision.ECodeGrid	grid,
		float	extension )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
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.0f means no extension and 0.1f means a 10% cell size extension.

◆ Read() [9/14]

eVision.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		int	numCellsX,
		int	numCellsY )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
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.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		int	numCellsX,
		int	numCellsY,
		float	extension )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
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.0f means no extension and 0.1f means a 10% cell size extension.

◆ Read() [11/14]

eVision.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		int	numCellsX,
		int	numCellsY )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
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.ECodeGrid eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		int	numCellsX,
		int	numCellsY,
		float	extension )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the eVision.ECodeGrid 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

roi	The ROI in which the data matrix codes have to be found.
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.0f means no extension and 0.1f means a 10% cell size extension.

◆ Read() [13/14]

list[eVision._eVision.ECode] eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERegion	region )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
region	Region into the search field where the data matrix codes have to be found.

◆ Read() [14/14]

list[eVision._eVision.ECode] eVision.ECodeReader.Read	(		self,
		eVision.EROIBW8	roi,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Tries to locate, decode and read data codes in the given ROI.

Remarks:

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
region	Region into the search field where the data matrix codes have to be found.
frame	Reference frame of the input image

◆ Save() [1/2]

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

Save the configuration for this eVision.ECodeReader instance.

Parameters

serializer The serializer.

◆ Save() [2/2]

None eVision.ECodeReader.Save	(		self,
		str	path )

Save the configuration for this eVision.ECodeReader instance.

Parameters

path	The path to which to save the configuration.

◆ TimeOut() [1/2]

int eVision.ECodeReader.TimeOut ( self )

The timeout for the eVision.ECodeReader.Read method in microseconds.

Remarks:

If the processing time of one of these methods becomes longer than the set time-out period, the process is stopped.

The eVision.ECodeReader.Read method will return all the codes it has decoded up to that point.

Note that the time-out period is not exact: the process is stopped at the first checkpoint after the time-out period has elapsed.

◆ TimeOut() [2/2]

eVision.ECodeReader.TimeOut	(		self,
		int	value )

The timeout for the eVision.ECodeReader.Read method in microseconds.

Remarks:

If the processing time of one of these methods becomes longer than the set time-out period, the process is stopped.

The eVision.ECodeReader.Read method will return all the codes it has decoded up to that point.

Note that the time-out period is not exact: the process is stopped at the first checkpoint after the time-out period has elapsed.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ BarCodeReader()

◆ EnabledCodeTypes() [1/2]

◆ EnabledCodeTypes() [2/2]

◆ Load() [1/2]

◆ Load() [2/2]

◆ MatrixCodeReader()

◆ MaxNumCodesPerType() [1/2]

◆ MaxNumCodesPerType() [2/2]

◆ QRCodeReader()

◆ 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]

◆ Save() [1/2]

◆ Save() [2/2]

◆ TimeOut() [1/2]

◆ TimeOut() [2/2]

◆ init() [1/2]

◆ init() [2/2]