An EMatrixCodeReader instance can detect, decode and grade matrixcodes in an ROI, it returns a vector of EMatrixCode instances. More...

#include <eVision/EasyMatrixCode/EasyMatrixCode2/EMatrixCodeReader.h>

Collaboration diagram for eVision::EasyMatrixCode2::EMatrixCodeReader:

Public Member Functions
	EMatrixCodeReader ()
	Creates an EMatrixCodeReader object.
	EMatrixCodeReader (const eVision::EasyMatrixCode2::EMatrixCodeReader &other)
	Creates an EMatrixCodeReader object.
virtual	~EMatrixCodeReader () throw ()
eVision::EasyMatrixCode2::EMatrixCodeReader &	operator= (const eVision::EasyMatrixCode2::EMatrixCodeReader &other)
	Assignment operator.
void	Load (const std::string &path)
	Load the configuration for this EMatrixCodeReader instance.
void	Load (eVision::ESerializer *serializer)
	Load the configuration for this EMatrixCodeReader instance.
void	Save (const std::string &path)
	Save the configuration for this EMatrixCodeReader instance.
void	Save (eVision::ESerializer *serializer)
	Save the configuration for this EMatrixCodeReader instance.
std::vector< eVision::EasyMatrixCode2::EMatrixCode >	Read (const eVision::EROIBW8 &roi)
	Tries to locate, decode and read data matrix codes in the given ROI.
std::vector< eVision::EasyMatrixCode2::EMatrixCode >	Read (const eVision::EROIBW8 &roi, const eVision::EFrame &frame)
	Tries to locate, decode and read data matrix codes in the given ROI.
std::vector< eVision::EasyMatrixCode2::EMatrixCode >	Read (const eVision::EROIBW8 &roi, const eVision::ERegion &region)
	Tries to locate, decode and read data matrix codes in the given ROI.
std::vector< eVision::EasyMatrixCode2::EMatrixCode >	Read (const eVision::EROIBW8 &roi, const eVision::ERegion &region, const eVision::EFrame &frame)
	Tries to locate, decode and read data matrix codes in the given ROI.
std::vector< eVision::EasyMatrixCode2::EMatrixCode >	Read (const eVision::EROIBW8 &roi, int32_t numCellsX, int32_t numCellsY, float extension)
	Tries to locate, decode and read data matrix codes in the given ROI.
std::vector< eVision::EasyMatrixCode2::EMatrixCode >	Read (const eVision::EROIBW8 &roi, int32_t numCellsX, int32_t numCellsY)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, int32_t numCellsX, int32_t numCellsY, float extension)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, int32_t numCellsX, int32_t numCellsY)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	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 matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	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 matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EasyMatrixCode2::EMatrixCodeGrid &grid, float extension)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EasyMatrixCode2::EMatrixCodeGrid &grid)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EFrame &frame, const eVision::EasyMatrixCode2::EMatrixCodeGrid &grid, float extension)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::ERectangleRegion &area, const eVision::EFrame &frame, const eVision::EasyMatrixCode2::EMatrixCodeGrid &grid)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::EGrid &grid)
	Tries to locate, decode and read data matrix codes in the given ROI.
eVision::EasyMatrixCode2::EMatrixCodeGrid	Read (const eVision::EROIBW8 &roi, const eVision::EGrid &grid, const eVision::EFrame &frame)
	Tries to locate, decode and read data matrix codes in the given ROI.
std::vector< eVision::EasyMatrixCode2::EMatrixCode >	GetReadResults () const
	Outputs the EMatrixCode that were found by the EMatrixCodeReader::Read method.
void	Learn (const eVision::EROIBW8 &roi)
	Learns the optimal parameter settings for detecting datamatrices in the given ROI.
void	Learn (const eVision::EROIBW8 &roi, const eVision::ERegion &region)
	Learns the optimal parameter settings for detecting datamatrices in the given ROI.
bool	GetLearnPerformed () const
	Returns true if some context information has been learned from a call to EMatrixCodeReader::Learn, and false otherwise.
void	ResetLearning ()
	Forgets the learned parameter settings and resets their default values.
eVision::EMatrixCodeIso29158CalibrationParameters	GetIso29158CalibrationParameters () const
	ISO/IEC TR 29158 calibration parameters.
void	SetIso29158CalibrationParameters (eVision::EMatrixCodeIso29158CalibrationParameters params)
	ISO/IEC TR 29158 calibration parameters.
void	SetMaxNumCodes (uint32_t maxNumCodes)
	Maximum number of data matrices to find in a single Image/ROI.
uint32_t	GetMaxNumCodes () const
	Maximum number of data matrices to find in a single Image/ROI.
void	SetMatrixCodeDimensionsRange (const eVision::EIntegerRange &range)
	Sets the range, in pixels, that the datamatrices sides dimensions must have to be detected.
void	UnsetMatrixCodeDimensionsRange ()
	Unsets the range, in pixels, that the datamatrices sides dimensions must have to be detected.
eVision::EIntegerRange	GetMatrixCodeDimensionsRange () const
	Returns the range set by the last call to EMatrixCodeReader::SetMatrixCodeDimensionsRange.
void	SetComputeGrading (bool computeGrading)
	Allows to choose whether the grading properties of the EMatrixCode object will be computed by the EMatrixCodeReader::Read method. The default setting for this property is false.
bool	GetComputeGrading () const
	Allows to choose whether the grading properties of the EMatrixCode object will be computed by the EMatrixCodeReader::Read method. The default setting for this property is false.
void	SetEnablePermissiveDecoding (bool enable)
	Enables or disables the decoding of codes containing partially incorrect information.
bool	GetEnablePermissiveDecoding () const
	Enables or disables the decoding of codes containing partially incorrect information.
void	SetEnableDMRE (bool enable)
	Enables or disables the decoding of Datamatrix Rectangular Extension (DMRE).
bool	GetEnableDMRE () const
	Enables or disables the decoding of Datamatrix Rectangular Extension (DMRE).
void	SetEnableReturnUnreliableCodes (bool enable)
	Enable or disable unreliable codes to be returned.
bool	GetEnableReturnUnreliableCodes () const
	Enable or disable unreliable codes to be returned.
uint64_t	GetTimeOut () const
	The timeout for the EMatrixCodeReader::Read and EMatrixCodeReader::Learn method in microseconds.
void	SetTimeOut (uint64_t timeout)
	The timeout for the EMatrixCodeReader::Read and EMatrixCodeReader::Learn method in microseconds.
void	SetReadMode (eVision::EasyMatrixCode2::EReadMode mode)
	The EReadMode used for the EMatrixCodeReader::Read method. The default value for this property is EReadMode::EReadMode_Speed.
eVision::EasyMatrixCode2::EReadMode	GetReadMode () const
	The EReadMode used for the EMatrixCodeReader::Read method. The default value for this property is EReadMode::EReadMode_Speed.
void	StopProcess ()
	Stops the EMatrixCodeReader::Read and/or EMatrixCodeReader::Learn process as soon as possible.
	EMatrixCodeReader (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

An EMatrixCodeReader instance can detect, decode and grade matrixcodes in an ROI, it returns a vector of EMatrixCode instances.

License(s): EasyMatrixCode

Constructor & Destructor Documentation

◆ EMatrixCodeReader() [1/3]

eVision::EasyMatrixCode2::EMatrixCodeReader::EMatrixCodeReader ( )

Creates an EMatrixCodeReader object.

◆ EMatrixCodeReader() [2/3]

eVision::EasyMatrixCode2::EMatrixCodeReader::EMatrixCodeReader ( const eVision::EasyMatrixCode2::EMatrixCodeReader & other )

Creates an EMatrixCodeReader object.

Parameters

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

◆ ~EMatrixCodeReader()

eVision::EasyMatrixCode2::EMatrixCodeReader::~EMatrixCodeReader	(		)
throw	(	)

virtual

◆ EMatrixCodeReader() [3/3]

eVision::EasyMatrixCode2::EMatrixCodeReader::EMatrixCodeReader ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetComputeGrading()

bool eVision::EasyMatrixCode2::EMatrixCodeReader::GetComputeGrading ( ) const

Allows to choose whether the grading properties of the EMatrixCode object will be computed by the EMatrixCodeReader::Read method. The default setting for this property is false.

◆ GetEnableDMRE()

bool eVision::EasyMatrixCode2::EMatrixCodeReader::GetEnableDMRE ( ) const

Enables or disables the decoding of Datamatrix Rectangular Extension (DMRE).

◆ GetEnablePermissiveDecoding()

bool eVision::EasyMatrixCode2::EMatrixCodeReader::GetEnablePermissiveDecoding ( ) const

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

◆ GetEnableReturnUnreliableCodes()

bool eVision::EasyMatrixCode2::EMatrixCodeReader::GetEnableReturnUnreliableCodes ( ) const

Enable or disable unreliable codes to be returned.

By default, unreliable codes are not returned. Unreliable codes are objects which are likely to be data matrices, but which could not be decoded. These unreliably decoded codes will return false upon calling EMatrixCode::GetIsReliable.

◆ GetIso29158CalibrationParameters()

eVision::EMatrixCodeIso29158CalibrationParameters eVision::EasyMatrixCode2::EMatrixCodeReader::GetIso29158CalibrationParameters ( ) const

ISO/IEC TR 29158 calibration parameters.

◆ GetLearnPerformed()

bool eVision::EasyMatrixCode2::EMatrixCodeReader::GetLearnPerformed ( ) const

Returns true if some context information has been learned from a call to EMatrixCodeReader::Learn, and false otherwise.

◆ GetMatrixCodeDimensionsRange()

eVision::EIntegerRange eVision::EasyMatrixCode2::EMatrixCodeReader::GetMatrixCodeDimensionsRange ( ) const

Returns the range set by the last call to EMatrixCodeReader::SetMatrixCodeDimensionsRange.

◆ GetMaxNumCodes()

uint32_t eVision::EasyMatrixCode2::EMatrixCodeReader::GetMaxNumCodes ( ) const

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

By default, this parameter is set to 1.

◆ GetReadMode()

eVision::EasyMatrixCode2::EReadMode eVision::EasyMatrixCode2::EMatrixCodeReader::GetReadMode ( ) const

The EReadMode used for the EMatrixCodeReader::Read method. The default value for this property is EReadMode::EReadMode_Speed.

◆ GetReadResults()

std::vector< eVision::EasyMatrixCode2::EMatrixCode > eVision::EasyMatrixCode2::EMatrixCodeReader::GetReadResults ( ) const

Outputs the EMatrixCode that were found by the EMatrixCodeReader::Read method.

◆ GetTimeOut()

uint64_t eVision::EasyMatrixCode2::EMatrixCodeReader::GetTimeOut ( ) const

The timeout for the EMatrixCodeReader::Read and EMatrixCodeReader::Learn 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 EMatrixCodeReader::Read method will return all the codes it has decoded up to that point. The EMatrixCodeReader::Learn method will only learn from those codes it has found within the time-out period.

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

◆ Learn() [1/2]

void eVision::EasyMatrixCode2::EMatrixCodeReader::Learn ( const eVision::EROIBW8 & roi )

Learns the optimal parameter settings for detecting datamatrices in the given ROI.

Parameters

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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls.

◆ Learn() [2/2]

void eVision::EasyMatrixCode2::EMatrixCodeReader::Learn	(	const eVision::EROIBW8 &	roi,
		const eVision::ERegion &	region )

Learns the optimal parameter settings for detecting datamatrices in the given ROI.

Parameters

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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls.

◆ Load() [1/2]

void eVision::EasyMatrixCode2::EMatrixCodeReader::Load ( const std::string & path )

Load the configuration for this EMatrixCodeReader instance.

Parameters

path	The path from which to load the configuration.

◆ Load() [2/2]

void eVision::EasyMatrixCode2::EMatrixCodeReader::Load ( eVision::ESerializer * serializer )

Load the configuration for this EMatrixCodeReader instance.

Parameters

serializer The serializer.

◆ operator=()

eVision::EasyMatrixCode2::EMatrixCodeReader & eVision::EasyMatrixCode2::EMatrixCodeReader::operator= ( const eVision::EasyMatrixCode2::EMatrixCodeReader & other )

Assignment operator.

Parameters

other EMatrixCodeReader object to be copied.

◆ Read() [1/16]

std::vector< eVision::EasyMatrixCode2::EMatrixCode > eVision::EasyMatrixCode2::EMatrixCodeReader::Read ( const eVision::EROIBW8 & roi )

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

Parameters

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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid class documentation for more information.

◆ Read() [2/16]

std::vector< eVision::EasyMatrixCode2::EMatrixCode > eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::EFrame &	frame )

Tries to locate, decode and read data matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid class documentation for more information.

◆ Read() [3/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::EGrid &	grid )

Tries to locate, decode and read data matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid class documentation for more information.

◆ Read() [4/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::EGrid &	grid,
		const eVision::EFrame &	frame )

Tries to locate, decode and read data matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid class documentation for more information.

◆ Read() [5/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EasyMatrixCode2::EMatrixCodeGrid &	grid )

Tries to locate, decode and read data matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EasyMatrixCode2::EMatrixCodeGrid &	grid,
		float	extension )

Tries to locate, decode and read data matrix 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.

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EFrame &	frame,
		const eVision::EasyMatrixCode2::EMatrixCodeGrid &	grid )

Tries to locate, decode and read data matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		const eVision::EFrame &	frame,
		const eVision::EasyMatrixCode2::EMatrixCodeGrid &	grid,
		float	extension )

Tries to locate, decode and read data matrix 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.

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::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 matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::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 matrix 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.

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		int32_t	numCellsX,
		int32_t	numCellsY )

Tries to locate, decode and read data matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

eVision::EasyMatrixCode2::EMatrixCodeGrid eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERectangleRegion &	area,
		int32_t	numCellsX,
		int32_t	numCellsY,
		float	extension )

Tries to locate, decode and read data matrix 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.

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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/16]

std::vector< eVision::EasyMatrixCode2::EMatrixCode > eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERegion &	region )

Tries to locate, decode and read data matrix 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.

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid class documentation for more information.

◆ Read() [14/16]

std::vector< eVision::EasyMatrixCode2::EMatrixCode > eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		const eVision::ERegion &	region,
		const eVision::EFrame &	frame )

Tries to locate, decode and read data matrix 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

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid class documentation for more information.

◆ Read() [15/16]

std::vector< eVision::EasyMatrixCode2::EMatrixCode > eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		int32_t	numCellsX,
		int32_t	numCellsY )

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
numCellsX	Number of grid cells in the X direction
numCellsY	Number of grid cells in the Y direction

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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() [16/16]

std::vector< eVision::EasyMatrixCode2::EMatrixCode > eVision::EasyMatrixCode2::EMatrixCodeReader::Read	(	const eVision::EROIBW8 &	roi,
		int32_t	numCellsX,
		int32_t	numCellsY,
		float	extension )

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

Parameters

roi	The ROI in which the data matrix codes have to be found.
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.

Throws an exception if EMatrixCodeReader::GetLearnPerformed returns true and the ROI dimensions are different from the ones used on previous calls. The grid overload allows you to disable some cells of the grid if those cells are not supposed to contain datamatrix codes. See the EMatrixCodeGrid 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.

◆ ResetLearning()

void eVision::EasyMatrixCode2::EMatrixCodeReader::ResetLearning ( )

Forgets the learned parameter settings and resets their default values.

◆ Save() [1/2]

void eVision::EasyMatrixCode2::EMatrixCodeReader::Save ( const std::string & path )

Save the configuration for this EMatrixCodeReader instance.

Parameters

path	The path to which to save the configuration.

◆ Save() [2/2]

void eVision::EasyMatrixCode2::EMatrixCodeReader::Save ( eVision::ESerializer * serializer )

Save the configuration for this EMatrixCodeReader instance.

Parameters

serializer The serializer.

◆ SetComputeGrading()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetComputeGrading ( bool computeGrading )

Allows to choose whether the grading properties of the EMatrixCode object will be computed by the EMatrixCodeReader::Read method. The default setting for this property is false.

◆ SetEnableDMRE()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetEnableDMRE ( bool enable )

Enables or disables the decoding of Datamatrix Rectangular Extension (DMRE).

◆ SetEnablePermissiveDecoding()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetEnablePermissiveDecoding ( bool enable )

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

◆ SetEnableReturnUnreliableCodes()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetEnableReturnUnreliableCodes ( bool enable )

Enable or disable unreliable codes to be returned.

By default, unreliable codes are not returned. Unreliable codes are objects which are likely to be data matrices, but which could not be decoded. These unreliably decoded codes will return false upon calling EMatrixCode::GetIsReliable.

◆ SetIso29158CalibrationParameters()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetIso29158CalibrationParameters ( eVision::EMatrixCodeIso29158CalibrationParameters params )

ISO/IEC TR 29158 calibration parameters.

◆ SetMatrixCodeDimensionsRange()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetMatrixCodeDimensionsRange ( const eVision::EIntegerRange & range )

Sets the range, in pixels, that the datamatrices sides dimensions must have to be detected.

If this parameter is set by the user, it supersedes the value learned by the EMatrixCodeReader::Learn method. If this parameter is set after a EMatrixCodeReader::Learn, EMatrixCodeReader::ResetLearning will be called.

◆ SetMaxNumCodes()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetMaxNumCodes ( uint32_t maxNumCodes )

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

By default, this parameter is set to 1.

◆ SetReadMode()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetReadMode ( eVision::EasyMatrixCode2::EReadMode mode )

The EReadMode used for the EMatrixCodeReader::Read method. The default value for this property is EReadMode::EReadMode_Speed.

◆ SetTimeOut()

void eVision::EasyMatrixCode2::EMatrixCodeReader::SetTimeOut ( uint64_t timeout )

The timeout for the EMatrixCodeReader::Read and EMatrixCodeReader::Learn 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 EMatrixCodeReader::Read method will return all the codes it has decoded up to that point. The EMatrixCodeReader::Learn method will only learn from those codes it has found within the time-out period.

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

◆ StopProcess()

void eVision::EasyMatrixCode2::EMatrixCodeReader::StopProcess ( )

Stops the EMatrixCodeReader::Read and/or EMatrixCodeReader::Learn process as soon as possible.

When this method is called the process is stopped at the first checkpoint.

◆ UnsetMatrixCodeDimensionsRange()

void eVision::EasyMatrixCode2::EMatrixCodeReader::UnsetMatrixCodeDimensionsRange ( )

Unsets the range, in pixels, that the datamatrices sides dimensions must have to be detected.

If this parameter is set by the user, it supersedes the value learned by the EMatrixCodeReader::Learn method. If this parameter is set after a EMatrixCodeReader::Learn, EMatrixCodeReader::ResetLearning will be called.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EasyMatrixCode2::EMatrixCodeReader::wrappedClass_

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EMatrixCodeReader() [1/3]

◆ EMatrixCodeReader() [2/3]

◆ ~EMatrixCodeReader()

◆ EMatrixCodeReader() [3/3]

Member Function Documentation

◆ GetComputeGrading()

◆ GetEnableDMRE()

◆ GetEnablePermissiveDecoding()

◆ GetEnableReturnUnreliableCodes()

◆ GetIso29158CalibrationParameters()

◆ GetLearnPerformed()

◆ GetMatrixCodeDimensionsRange()

◆ GetMaxNumCodes()

◆ GetReadMode()

◆ GetReadResults()

◆ GetTimeOut()

◆ Learn() [1/2]

◆ Learn() [2/2]

◆ Load() [1/2]

◆ Load() [2/2]

◆ operator=()

◆ Read() [1/16]

◆ Read() [2/16]

◆ Read() [3/16]

◆ Read() [4/16]

◆ Read() [5/16]

◆ Read() [6/16]

◆ Read() [7/16]

◆ Read() [8/16]

◆ Read() [9/16]

◆ Read() [10/16]

◆ Read() [11/16]

◆ Read() [12/16]

◆ Read() [13/16]

◆ Read() [14/16]

◆ Read() [15/16]

◆ Read() [16/16]

◆ ResetLearning()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetComputeGrading()

◆ SetEnableDMRE()

◆ SetEnablePermissiveDecoding()

◆ SetEnableReturnUnreliableCodes()

◆ SetIso29158CalibrationParameters()

◆ SetMatrixCodeDimensionsRange()

◆ SetMaxNumCodes()

◆ SetReadMode()

◆ SetTimeOut()

◆ StopProcess()

◆ UnsetMatrixCodeDimensionsRange()

Member Data Documentation

◆ wrappedClass_