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

Inheritance diagram for eVision.ECodeReader:

Collaboration diagram for eVision.ECodeReader:

Public Member Functions
	ECodeReader ()
	Creates an ECodeReader object.
	ECodeReader (eVision.ECodeReader other)
	Creates an ECodeReader object.
eVision.ECode[]	Read (eVision.EROIBW8 roi)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECode[]	Read (eVision.EROIBW8 roi, eVision.EFrame frame)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECode[]	Read (eVision.EROIBW8 roi, eVision.ERegion region)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECode[]	Read (eVision.EROIBW8 roi, eVision.ERegion region, eVision.EFrame frame)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (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 (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 (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 (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 (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 (eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.ECodeGrid grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (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 (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 (eVision.EROIBW8 roi, eVision.EGrid grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision.ECodeGrid	Read (eVision.EROIBW8 roi, eVision.EGrid grid, eVision.EFrame frame)
	Tries to locate, decode and read data codes in the given ROI.
void	Load (string path)
	Load the configuration for this ECodeReader instance.
void	Load (eVision.ESerializer serializer)
	Load the configuration for this ECodeReader instance.
void	Save (string path)
	Save the configuration for this ECodeReader instance.
void	Save (eVision.ESerializer serializer)
	Save the configuration for this ECodeReader instance.

Properties
uint	MaxNumCodesPerType `[get, set]`
	The maximum number of codes that the reader should try to find.
ulong	TimeOut `[get, set]`
	The timeout for the ECodeReader.Read method in microseconds.
eVision.ECodeType[]	EnabledCodeTypes `[get, set]`
	The enabled code types.
eVision.EasyMatrixCode2.EMatrixCodeReader	MatrixCodeReader `[get]`
	Gets the underlying EMatrixCodeReader instance.
eVision.EasyBarCode2.EBarCodeReader	BarCodeReader `[get]`
	Gets the underlying EBarCodeReader instance.
eVision.EQRCodeReader	QRCodeReader `[get]`
	Gets the underlying EQRCodeReader instance.

Detailed Description

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

License(s): EasyMatrixCode and EasyBarCode and EasyQRCode

Constructor & Destructor Documentation

◆ ECodeReader() [1/2]

eVision.ECodeReader.ECodeReader ( )

Creates an ECodeReader object.

◆ ECodeReader() [2/2]

eVision.ECodeReader.ECodeReader ( eVision.ECodeReader other )

Creates an ECodeReader object.

Parameters

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

Member Function Documentation

◆ Load() [1/2]

void eVision.ECodeReader.Load ( eVision.ESerializer serializer )

Load the configuration for this ECodeReader instance.

Parameters

serializer The serializer.

◆ Load() [2/2]

void eVision.ECodeReader.Load ( string path )

Load the configuration for this ECodeReader instance.

Parameters

path	The path from which to load the configuration.

◆ Read() [1/14]

eVision.ECode[] eVision.ECodeReader.Read ( eVision.EROIBW8 roi )

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

Parameters

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

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

◆ Read() [2/14]

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

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
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 codes. See the ECodeGrid class documentation for more information.

◆ Read() [3/14]

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

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
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 codes. See the ECodeGrid class documentation for more information.

◆ Read() [4/14]

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

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

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

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

◆ Read() [5/14]

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

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

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

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the ECodeGrid 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.ECodeGrid eVision.ECodeReader.Read	(	eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.ECodeGrid	grid,
		float	extension )

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

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.

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the ECodeGrid 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.ECodeGrid eVision.ECodeReader.Read	(	eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		eVision.EFrame	frame,
		eVision.ECodeGrid	grid )

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

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

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

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.

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

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

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

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.

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the ECodeGrid 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.ECodeGrid eVision.ECodeReader.Read	(	eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		int	numCellsX,
		int	numCellsY )

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

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

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the ECodeGrid 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.ECodeGrid eVision.ECodeReader.Read	(	eVision.EROIBW8	roi,
		eVision.ERectangleRegion	area,
		int	numCellsX,
		int	numCellsY,
		float	extension )

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

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.

The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain codes. See the ECodeGrid 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.ECode[] eVision.ECodeReader.Read	(	eVision.EROIBW8	roi,
		eVision.ERegion	region )

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

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.

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

◆ Read() [14/14]

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

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

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

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

◆ Save() [1/2]

void eVision.ECodeReader.Save ( eVision.ESerializer serializer )

Save the configuration for this ECodeReader instance.

Parameters

serializer The serializer.

◆ Save() [2/2]

void eVision.ECodeReader.Save ( string path )

Save the configuration for this ECodeReader instance.

Parameters

path	The path to which to save the configuration.

Property Documentation

◆ BarCodeReader

eVision.EasyBarCode2.EBarCodeReader eVision.ECodeReader.BarCodeReader

get

Gets the underlying EBarCodeReader instance.

◆ EnabledCodeTypes

eVision.ECodeType [] eVision.ECodeReader.EnabledCodeTypes

getset

The enabled code types.

All code types enabled by default

◆ MatrixCodeReader

eVision.EasyMatrixCode2.EMatrixCodeReader eVision.ECodeReader.MatrixCodeReader

get

Gets the underlying EMatrixCodeReader instance.

◆ MaxNumCodesPerType

uint eVision.ECodeReader.MaxNumCodesPerType

getset

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

By default, this parameter is set to 1.

◆ QRCodeReader

eVision.EQRCodeReader eVision.ECodeReader.QRCodeReader

get

Gets the underlying EQRCodeReader instance.

◆ TimeOut

ulong eVision.ECodeReader.TimeOut

getset

The timeout for the ECodeReader.Read method in microseconds.

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

The 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

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ECodeReader() [1/2]

◆ ECodeReader() [2/2]

Member Function Documentation

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

◆ Save() [1/2]

◆ Save() [2/2]

Property Documentation

◆ BarCodeReader

◆ EnabledCodeTypes

◆ MatrixCodeReader

◆ MaxNumCodesPerType

◆ QRCodeReader

◆ TimeOut