eVision Python API
Loading...
Searching...
No Matches
eVision.EasyMatrixCode2.EMatrixCodeReader Class Reference

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

Public Member Functions

None __init__ (self)
 Creates an eVision.EasyMatrixCode2.EMatrixCodeReader object.
None __init__ (self, eVision.EasyMatrixCode2.EMatrixCodeReader other)
 Creates an eVision.EasyMatrixCode2.EMatrixCodeReader object.
None Load (self, str path)
 Load the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.
None Load (self, eVision.ESerializer|None serializer)
 Load the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.
None Save (self, str path)
 Save the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.
None Save (self, eVision.ESerializer|None serializer)
 Save the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.
list[eVision._eVision.EasyMatrixCode2.EMatrixCode] Read (self, eVision.EROIBW8 roi)
 Tries to locate, decode and read data matrix codes in the given ROI.
list[eVision._eVision.EasyMatrixCode2.EMatrixCode] Read (self, eVision.EROIBW8 roi, eVision.EFrame frame)
 Tries to locate, decode and read data matrix codes in the given ROI.
list[eVision._eVision.EasyMatrixCode2.EMatrixCode] Read (self, eVision.EROIBW8 roi, eVision.ERegion region)
 Tries to locate, decode and read data matrix codes in the given ROI.
list[eVision._eVision.EasyMatrixCode2.EMatrixCode] Read (self, eVision.EROIBW8 roi, eVision.ERegion region, eVision.EFrame frame)
 Tries to locate, decode and read data matrix codes in the given ROI.
list[eVision._eVision.EasyMatrixCode2.EMatrixCode] Read (self, eVision.EROIBW8 roi, int numCellsX, int numCellsY, float extension)
 Tries to locate, decode and read data matrix codes in the given ROI.
list[eVision._eVision.EasyMatrixCode2.EMatrixCode] Read (self, eVision.EROIBW8 roi, int numCellsX, int numCellsY)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, int numCellsX, int numCellsY, float extension)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, int numCellsX, int numCellsY)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, int numCellsX, int numCellsY, float extension)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, int numCellsX, int numCellsY)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EasyMatrixCode2.EMatrixCodeGrid grid, float extension)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EasyMatrixCode2.EMatrixCodeGrid grid)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, eVision.EasyMatrixCode2.EMatrixCodeGrid grid, float extension)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.ERectangleRegion area, eVision.EFrame frame, eVision.EasyMatrixCode2.EMatrixCodeGrid grid)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.EGrid grid)
 Tries to locate, decode and read data matrix codes in the given ROI.
eVision.EasyMatrixCode2.EMatrixCodeGrid Read (self, eVision.EROIBW8 roi, eVision.EGrid grid, eVision.EFrame frame)
 Tries to locate, decode and read data matrix codes in the given ROI.
None Learn (self, eVision.EROIBW8 roi)
 Learns the optimal parameter settings for detecting datamatrices in the given ROI.
None Learn (self, eVision.EROIBW8 roi, eVision.ERegion region)
 Learns the optimal parameter settings for detecting datamatrices in the given ROI.
None ResetLearning (self)
 Forgets the learned parameter settings and resets their default values.
None UnsetMatrixCodeDimensionsRange (self)
 Unsets the range, in pixels, that the datamatrices sides dimensions must have to be detected.
None StopProcess (self)
 Stops the eVision.EasyMatrixCode2.EMatrixCodeReader.Read and/or eVision.EasyMatrixCode2.EMatrixCodeReader.Learn process as soon as possible.
list[eVision._eVision.EasyMatrixCode2.EMatrixCode] ReadResults (self)
 Outputs the eVision.EasyMatrixCode2.EMatrixCode that were found by the eVision.EasyMatrixCode2.EMatrixCodeReader.Read method.
bool LearnPerformed (self)
 Returns true if some context information has been learned from a call to eVision.EasyMatrixCode2.EMatrixCodeReader.Learn, and false otherwise.
eVision.EMatrixCodeIso29158CalibrationParameters Iso29158CalibrationParameters (self)
 ISO/IEC TR 29158 calibration parameters.
 Iso29158CalibrationParameters (self, eVision.EMatrixCodeIso29158CalibrationParameters value)
 ISO/IEC TR 29158 calibration parameters.
int MaxNumCodes (self)
 Maximum number of data matrices to find in a single Image/ROI.
 MaxNumCodes (self, int value)
 Maximum number of data matrices to find in a single Image/ROI.
eVision.EIntegerRange MatrixCodeDimensionsRange (self)
 Returns the range set by the last call to eVision.EasyMatrixCode2.EMatrixCodeReader.MatrixCodeDimensionsRange.
 MatrixCodeDimensionsRange (self, eVision.EIntegerRange value)
 Returns the range set by the last call to eVision.EasyMatrixCode2.EMatrixCodeReader.MatrixCodeDimensionsRange.
bool ComputeGrading (self)
 Allows to choose whether the grading properties of the eVision.EasyMatrixCode2.EMatrixCode object will be computed by the eVision.EasyMatrixCode2.EMatrixCodeReader.Read method.
 ComputeGrading (self, bool value)
 Allows to choose whether the grading properties of the eVision.EasyMatrixCode2.EMatrixCode object will be computed by the eVision.EasyMatrixCode2.EMatrixCodeReader.Read method.
bool EnablePermissiveDecoding (self)
 Enables or disables the decoding of codes containing partially incorrect information.
 EnablePermissiveDecoding (self, bool value)
 Enables or disables the decoding of codes containing partially incorrect information.
bool EnableDMRE (self)
 Enables or disables the decoding of Datamatrix Rectangular Extension (DMRE).
 EnableDMRE (self, bool value)
 Enables or disables the decoding of Datamatrix Rectangular Extension (DMRE).
bool EnableReturnUnreliableCodes (self)
 Enable or disable unreliable codes to be returned.
 EnableReturnUnreliableCodes (self, bool value)
 Enable or disable unreliable codes to be returned.
int TimeOut (self)
 The timeout for the eVision.EasyMatrixCode2.EMatrixCodeReader.Read and eVision.EasyMatrixCode2.EMatrixCodeReader.Learn method in microseconds.
 TimeOut (self, int value)
 The timeout for the eVision.EasyMatrixCode2.EMatrixCodeReader.Read and eVision.EasyMatrixCode2.EMatrixCodeReader.Learn method in microseconds.
eVision.EasyMatrixCode2.EReadMode ReadMode (self)
 The eVision.EasyMatrixCode2.EReadMode used for the eVision.EasyMatrixCode2.EMatrixCodeReader.Read method.
 ReadMode (self, eVision.EasyMatrixCode2.EReadMode value)
 The eVision.EasyMatrixCode2.EReadMode used for the eVision.EasyMatrixCode2.EMatrixCodeReader.Read method.

Detailed Description

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

Remarks:

License(s): EasyMatrixCode

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.__init__ ( self)

◆ __init__() [2/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.__init__ ( self,
eVision.EasyMatrixCode2.EMatrixCodeReader other )

Creates an eVision.EasyMatrixCode2.EMatrixCodeReader object.

Parameters
otherAnother eVision.EasyMatrixCode2.EMatrixCodeReader object to be copied in the new eVision.EasyMatrixCode2.EMatrixCodeReader object.

Member Function Documentation

◆ ComputeGrading() [1/2]

bool eVision.EasyMatrixCode2.EMatrixCodeReader.ComputeGrading ( self)

Allows to choose whether the grading properties of the eVision.EasyMatrixCode2.EMatrixCode object will be computed by the eVision.EasyMatrixCode2.EMatrixCodeReader.Read method.

The default setting for this property is false.

◆ ComputeGrading() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.ComputeGrading ( self,
bool value )

Allows to choose whether the grading properties of the eVision.EasyMatrixCode2.EMatrixCode object will be computed by the eVision.EasyMatrixCode2.EMatrixCodeReader.Read method.

The default setting for this property is false.

◆ EnableDMRE() [1/2]

bool eVision.EasyMatrixCode2.EMatrixCodeReader.EnableDMRE ( self)

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

◆ EnableDMRE() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.EnableDMRE ( self,
bool value )

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

◆ EnablePermissiveDecoding() [1/2]

bool eVision.EasyMatrixCode2.EMatrixCodeReader.EnablePermissiveDecoding ( self)

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

◆ EnablePermissiveDecoding() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.EnablePermissiveDecoding ( self,
bool value )

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

◆ EnableReturnUnreliableCodes() [1/2]

bool eVision.EasyMatrixCode2.EMatrixCodeReader.EnableReturnUnreliableCodes ( self)

Enable or disable unreliable codes to be returned.

Remarks:

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 eVision.EasyMatrixCode2.EMatrixCode.IsReliable.

◆ EnableReturnUnreliableCodes() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.EnableReturnUnreliableCodes ( self,
bool value )

Enable or disable unreliable codes to be returned.

Remarks:

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 eVision.EasyMatrixCode2.EMatrixCode.IsReliable.

◆ Iso29158CalibrationParameters() [1/2]

eVision.EMatrixCodeIso29158CalibrationParameters eVision.EasyMatrixCode2.EMatrixCodeReader.Iso29158CalibrationParameters ( self)

ISO/IEC TR 29158 calibration parameters.

◆ Iso29158CalibrationParameters() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.Iso29158CalibrationParameters ( self,
eVision.EMatrixCodeIso29158CalibrationParameters value )

ISO/IEC TR 29158 calibration parameters.

◆ Learn() [1/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.Learn ( self,
eVision.EROIBW8 roi )

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

Remarks:

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

Parameters
roiThe ROI in which the data matrix codes have to be found.

◆ Learn() [2/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.Learn ( self,
eVision.EROIBW8 roi,
eVision.ERegion region )

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

Remarks:

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

Parameters
roiThe ROI in which the data matrix codes have to be found.
regionThe region in which the data matrix codes have to be found.

◆ LearnPerformed()

bool eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed ( self)

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

◆ Load() [1/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.Load ( self,
eVision.ESerializer | None serializer )

Load the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.

Parameters
serializerThe serializer.

◆ Load() [2/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.Load ( self,
str path )

Load the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.

Parameters
pathThe path from which to load the configuration.

◆ MatrixCodeDimensionsRange() [1/2]

eVision.EIntegerRange eVision.EasyMatrixCode2.EMatrixCodeReader.MatrixCodeDimensionsRange ( self)

Returns the range set by the last call to eVision.EasyMatrixCode2.EMatrixCodeReader.MatrixCodeDimensionsRange.

◆ MatrixCodeDimensionsRange() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.MatrixCodeDimensionsRange ( self,
eVision.EIntegerRange value )

Returns the range set by the last call to eVision.EasyMatrixCode2.EMatrixCodeReader.MatrixCodeDimensionsRange.

◆ MaxNumCodes() [1/2]

int eVision.EasyMatrixCode2.EMatrixCodeReader.MaxNumCodes ( self)

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

Remarks:

By default, this parameter is set to 1.

◆ MaxNumCodes() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.MaxNumCodes ( self,
int value )

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

Remarks:

By default, this parameter is set to 1.

◆ Read() [1/16]

list[eVision._eVision.EasyMatrixCode2.EMatrixCode] eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid class documentation for more information.

Parameters
roiThe ROI in which the data matrix codes have to be found.

◆ Read() [2/16]

list[eVision._eVision.EasyMatrixCode2.EMatrixCode] eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.EFrame frame )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid class documentation for more information.

Parameters
roiThe ROI in which the data matrix codes have to be found.
frameReference frame of the input image

◆ Read() [3/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.EGrid grid )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid class documentation for more information.

Parameters
roiThe ROI in which the data matrix codes have to be found.
gridGrid with cell disabling capabilities

◆ Read() [4/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.EGrid grid,
eVision.EFrame frame )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid class documentation for more information.

Parameters
roiThe ROI in which the data matrix codes have to be found.
gridGrid with cell disabling capabilities
frameReference frame of the input image

◆ Read() [5/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERectangleRegion area,
eVision.EasyMatrixCode2.EMatrixCodeGrid grid )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
gridGrid with cell disabling capabilities

◆ Read() [6/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERectangleRegion area,
eVision.EasyMatrixCode2.EMatrixCodeGrid grid,
float extension )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
gridGrid with cell disabling capabilities
extensionExtension 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/16]

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
frameReference frame of the input image
gridGrid with cell disabling capabilities

◆ Read() [8/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERectangleRegion area,
eVision.EFrame frame,
eVision.EasyMatrixCode2.EMatrixCodeGrid grid,
float extension )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
frameReference frame of the input image
gridGrid with cell disabling capabilities
extensionExtension 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/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERectangleRegion area,
eVision.EFrame frame,
int numCellsX,
int numCellsY )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
frameReference frame of the input image
numCellsXNumber of grid cells in the X direction
numCellsYNumber of grid cells in the Y direction

◆ Read() [10/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERectangleRegion area,
eVision.EFrame frame,
int numCellsX,
int numCellsY,
float extension )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
frameReference frame of the input image
numCellsXNumber of grid cells in the X direction
numCellsYNumber of grid cells in the Y direction
extensionExtension 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/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERectangleRegion area,
int numCellsX,
int numCellsY )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
numCellsXNumber of grid cells in the X direction
numCellsYNumber of grid cells in the Y direction

◆ Read() [12/16]

eVision.EasyMatrixCode2.EMatrixCodeGrid eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERectangleRegion area,
int numCellsX,
int numCellsY,
float extension )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
areaRectangular Region used as the full grid area
numCellsXNumber of grid cells in the X direction
numCellsYNumber of grid cells in the Y direction
extensionExtension 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/16]

list[eVision._eVision.EasyMatrixCode2.EMatrixCode] eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERegion region )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid class documentation for more information.

Parameters
roiThe ROI in which the data matrix codes have to be found.
regionRegion into the search field where the data matrix codes have to be found.

◆ Read() [14/16]

list[eVision._eVision.EasyMatrixCode2.EMatrixCode] eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
eVision.ERegion region,
eVision.EFrame frame )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid class documentation for more information.

Parameters
roiThe ROI in which the data matrix codes have to be found.
regionRegion into the search field where the data matrix codes have to be found.
frameReference frame of the input image

◆ Read() [15/16]

list[eVision._eVision.EasyMatrixCode2.EMatrixCode] eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
int numCellsX,
int numCellsY )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
numCellsXNumber of grid cells in the X direction
numCellsYNumber of grid cells in the Y direction

◆ Read() [16/16]

list[eVision._eVision.EasyMatrixCode2.EMatrixCode] eVision.EasyMatrixCode2.EMatrixCodeReader.Read ( self,
eVision.EROIBW8 roi,
int numCellsX,
int numCellsY,
float extension )

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

Remarks:

Throws an exception if eVision.EasyMatrixCode2.EMatrixCodeReader.LearnPerformed 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 eVision.EasyMatrixCode2.EMatrixCodeGrid 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
roiThe ROI in which the data matrix codes have to be found.
numCellsXNumber of grid cells in the X direction
numCellsYNumber of grid cells in the Y direction
extensionExtension of the grid cells to allow cell overlap. For instance, 0.0f means no extension and 0.1f means a 10% cell size extension.

◆ ReadMode() [1/2]

eVision.EasyMatrixCode2.EReadMode eVision.EasyMatrixCode2.EMatrixCodeReader.ReadMode ( self)

◆ ReadMode() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.ReadMode ( self,
eVision.EasyMatrixCode2.EReadMode value )

◆ ReadResults()

list[eVision._eVision.EasyMatrixCode2.EMatrixCode] eVision.EasyMatrixCode2.EMatrixCodeReader.ReadResults ( self)

◆ ResetLearning()

None eVision.EasyMatrixCode2.EMatrixCodeReader.ResetLearning ( self)

Forgets the learned parameter settings and resets their default values.

◆ Save() [1/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.Save ( self,
eVision.ESerializer | None serializer )

Save the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.

Parameters
serializerThe serializer.

◆ Save() [2/2]

None eVision.EasyMatrixCode2.EMatrixCodeReader.Save ( self,
str path )

Save the configuration for this eVision.EasyMatrixCode2.EMatrixCodeReader instance.

Parameters
pathThe path to which to save the configuration.

◆ StopProcess()

None eVision.EasyMatrixCode2.EMatrixCodeReader.StopProcess ( self)

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

Remarks:

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

◆ TimeOut() [1/2]

int eVision.EasyMatrixCode2.EMatrixCodeReader.TimeOut ( self)

The timeout for the eVision.EasyMatrixCode2.EMatrixCodeReader.Read and eVision.EasyMatrixCode2.EMatrixCodeReader.Learn 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.EasyMatrixCode2.EMatrixCodeReader.Read method will return all the codes it has decoded up to that point. The eVision.EasyMatrixCode2.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.

◆ TimeOut() [2/2]

eVision.EasyMatrixCode2.EMatrixCodeReader.TimeOut ( self,
int value )

The timeout for the eVision.EasyMatrixCode2.EMatrixCodeReader.Read and eVision.EasyMatrixCode2.EMatrixCodeReader.Learn 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.EasyMatrixCode2.EMatrixCodeReader.Read method will return all the codes it has decoded up to that point. The eVision.EasyMatrixCode2.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.

◆ UnsetMatrixCodeDimensionsRange()

None eVision.EasyMatrixCode2.EMatrixCodeReader.UnsetMatrixCodeDimensionsRange ( self)

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

Remarks:

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