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

#include <eVision/EasyID/ECodeReader.h>

Collaboration diagram for eVision::ECodeReader:

Public Member Functions
	ECodeReader ()
	Creates an ECodeReader object.
	ECodeReader (const eVision::ECodeReader &other)
	Creates an ECodeReader object.
virtual	~ECodeReader () throw ()
eVision::ECodeReader &	operator= (const eVision::ECodeReader &other)
	Assignment operator.
std::vector< eVision::ECode >	Read (const eVision::EROIBW8 &roi)
	Tries to locate, decode and read data codes in the given ROI.
std::vector< eVision::ECode >	Read (const eVision::EROIBW8 &roi, const eVision::EFrame &frame)
	Tries to locate, decode and read data codes in the given ROI.
std::vector< eVision::ECode >	Read (const eVision::EROIBW8 &roi, const eVision::ERegion &region)
	Tries to locate, decode and read data codes in the given ROI.
std::vector< eVision::ECode >	Read (const eVision::EROIBW8 &roi, const eVision::ERegion &region, const eVision::EFrame &frame)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, int32_t numCellsX, int32_t numCellsY, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, int32_t numCellsX, int32_t numCellsY)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EFrame &frame, int32_t numCellsX, int32_t numCellsY, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EFrame &frame, int32_t numCellsX, int32_t numCellsY)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::ECodeGrid &grid, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::ECodeGrid &grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EFrame &frame, const eVision::ECodeGrid &grid, float extension)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EFrame &frame, const eVision::ECodeGrid &grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::EGrid &grid)
	Tries to locate, decode and read data codes in the given ROI.
eVision::ECodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::EGrid &grid, const eVision::EFrame &frame)
	Tries to locate, decode and read data codes in the given ROI.
void	SetMaxNumCodesPerType (uint32_t max)
	The maximum number of codes that the reader should try to find.
uint32_t	GetMaxNumCodesPerType () const
	The maximum number of codes that the reader should try to find.
void	SetTimeOut (uint64_t timeOut)
	The timeout for the ECodeReader::Read method in microseconds.
uint64_t	GetTimeOut () const
	The timeout for the ECodeReader::Read method in microseconds.
void	SetEnabledCodeTypes (std::vector< eVision::ECodeType > types)
	The enabled code types.
std::vector< eVision::ECodeType >	GetEnabledCodeTypes ()
	The enabled code types.
void	Load (const std::string &path)
	Load the configuration for this ECodeReader instance.
void	Load (eVision::ESerializer *serializer)
	Load the configuration for this ECodeReader instance.
void	Save (const std::string &path)
	Save the configuration for this ECodeReader instance.
void	Save (eVision::ESerializer *serializer)
	Save the configuration for this ECodeReader instance.
eVision::EasyMatrixCode2::EMatrixCodeReader &	GetMatrixCodeReader ()
	Gets the underlying EMatrixCodeReader instance.
eVision::EasyBarCode2::EBarCodeReader &	GetBarCodeReader ()
	Gets the underlying EBarCodeReader instance.
eVision::EQRCodeReader &	GetQRCodeReader ()
	Gets the underlying EQRCodeReader instance.
	ECodeReader (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

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/3]

eVision::ECodeReader::ECodeReader ( )

Creates an ECodeReader object.

◆ ECodeReader() [2/3]

eVision::ECodeReader::ECodeReader ( const eVision::ECodeReader & other )

Creates an ECodeReader object.

Parameters

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

◆ ~ECodeReader()

eVision::ECodeReader::~ECodeReader	(		)
throw	(	)

virtual

◆ ECodeReader() [3/3]

eVision::ECodeReader::ECodeReader ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetBarCodeReader()

eVision::EasyBarCode2::EBarCodeReader & eVision::ECodeReader::GetBarCodeReader ( )

Gets the underlying EBarCodeReader instance.

◆ GetEnabledCodeTypes()

std::vector< eVision::ECodeType > eVision::ECodeReader::GetEnabledCodeTypes ( )

The enabled code types.

All code types enabled by default

◆ GetMatrixCodeReader()

eVision::EasyMatrixCode2::EMatrixCodeReader & eVision::ECodeReader::GetMatrixCodeReader ( )

Gets the underlying EMatrixCodeReader instance.

◆ GetMaxNumCodesPerType()

uint32_t eVision::ECodeReader::GetMaxNumCodesPerType ( ) const

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

By default, this parameter is set to 1.

◆ GetQRCodeReader()

eVision::EQRCodeReader & eVision::ECodeReader::GetQRCodeReader ( )

Gets the underlying EQRCodeReader instance.

◆ GetTimeOut()

uint64_t eVision::ECodeReader::GetTimeOut ( ) const

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.

◆ Load() [1/2]

void eVision::ECodeReader::Load ( const std::string & path )

Load the configuration for this ECodeReader instance.

Parameters

path	The path from which to load the configuration.

◆ Load() [2/2]

void eVision::ECodeReader::Load ( eVision::ESerializer * serializer )

Load the configuration for this ECodeReader instance.

Parameters

serializer The serializer.

◆ operator=()

eVision::ECodeReader & eVision::ECodeReader::operator= ( const eVision::ECodeReader & other )

Assignment operator.

Parameters

other ECodeReader object to be copied.

◆ Read() [1/14]

std::vector< eVision::ECode > eVision::ECodeReader::Read ( const 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]

std::vector< eVision::ECode > eVision::ECodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const 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	(	const eVision::EROIBW8 &	roi,
		const 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	(	const eVision::EROIBW8 &	roi,
		const eVision::EGrid &	grid,
		const 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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const 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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const 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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EFrame &	frame,
		const 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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EFrame &	frame,
		const 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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EFrame &	frame,
		int32_t	numCellsX,
		int32_t	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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EFrame &	frame,
		int32_t	numCellsX,
		int32_t	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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		int32_t	numCellsX,
		int32_t	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	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		int32_t	numCellsX,
		int32_t	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]

std::vector< eVision::ECode > eVision::ECodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const 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]

std::vector< eVision::ECode > eVision::ECodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERegion &	region,
		const 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 ( const std::string & path )

Save the configuration for this ECodeReader instance.

Parameters

path	The path to which to save the configuration.

◆ Save() [2/2]

void eVision::ECodeReader::Save ( eVision::ESerializer * serializer )

Save the configuration for this ECodeReader instance.

Parameters

serializer The serializer.

◆ SetEnabledCodeTypes()

void eVision::ECodeReader::SetEnabledCodeTypes ( std::vector< eVision::ECodeType > types )

The enabled code types.

All code types enabled by default

◆ SetMaxNumCodesPerType()

void eVision::ECodeReader::SetMaxNumCodesPerType ( uint32_t max )

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

By default, this parameter is set to 1.

◆ SetTimeOut()

void eVision::ECodeReader::SetTimeOut ( uint64_t timeOut )

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.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::ECodeReader::wrappedClass_

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ECodeReader() [1/3]

◆ ECodeReader() [2/3]

◆ ~ECodeReader()

◆ ECodeReader() [3/3]

Member Function Documentation

◆ GetBarCodeReader()

◆ GetEnabledCodeTypes()

◆ GetMatrixCodeReader()

◆ GetMaxNumCodesPerType()

◆ GetQRCodeReader()

◆ GetTimeOut()

◆ Load() [1/2]

◆ Load() [2/2]

◆ operator=()

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

◆ SetEnabledCodeTypes()

◆ SetMaxNumCodesPerType()

◆ SetTimeOut()

Member Data Documentation

◆ wrappedClass_