CVBpy 14.0
cvb.barcode Namespace Reference

Common Vision Blox Barcode module for Python. More...

Classes

class  BarcodeGrading
 Configuration to access parameters of PharmaCode. More...
 
class  Codabar
 Configuration to access parameters of Codabar. More...
 
class  Code11
 Configuration to access parameters of Code11. More...
 
class  Code11CheckDigit
 Available check digits for Code11. More...
 
class  Code128
 Configuration to access parameters of Code128. More...
 
class  Code128SubType
 Possible sub types of Code128. More...
 
class  Code32
 Configuration to access parameters of Code32. More...
 
class  Code39
 Configuration to access parameters of Code39. More...
 
class  Code93
 Configuration to access parameters of Code93. More...
 
class  CodeOrientation
 Directions that a four state code may have. More...
 
class  ConfigBase
 Configuration base class to access parameters of ConfigBase. More...
 
class  DataMatrix
 Configuration to access parameters of DataMatrix. More...
 
class  DataMatrixFormats
 Formats of DataMatrix codes to recognize. More...
 
class  DataMatrixGrading
 Configuration to access parameters of DataMatrixGrading. More...
 
class  DataMatrixLevels
 Levels of DataMatrix codes to recognize. More...
 
class  DataMatrixSubType
 Sub types of data matrix codes to read. More...
 
class  DecodeResult
 Possible barcode reading results. More...
 
class  Discrete2of5
 Configuration to access parameters of Discrete2of5. More...
 
class  Ean13
 Configuration to access parameters of Ean13. More...
 
class  Ean8
 Configuration to access parameters of Ean8. More...
 
class  EccLevelQr
 Possible barcode reading results. More...
 
class  FourStateAustralian
 Configuration to access parameters of FourStateAustralian. More...
 
class  FourStateAustralianLevels
 Available level flags Four State Australian codes. More...
 
class  FourStateKix
 Configuration to access parameters of FourStateKix. More...
 
class  FourStateLsb
 LSB settings for four state codes. More...
 
class  FourStateRoyalMail
 Configuration to access parameters of FourStateRoyalMail. More...
 
class  FourStateUsps
 Configuration to access parameters of FourStateUsps. More...
 
class  GradeResult1DInfo
 Additional information about 1D grading results. More...
 
class  GradeResult2DBase
 Base class for 2D grading results. More...
 
class  GradeResultBase
 Configuration to access parameters of GradeResultBase. More...
 
class  GradeResultDataMatrix
 Object contains the barcode grading results for DataMatrix and PharmaCode2D barcodes. More...
 
class  GradeResultQr
 Object contains the barcode grading results for QR barcodes. More...
 
class  Interleaved2of5
 Configuration to access parameters of Interleaved2of5. More...
 
class  MicroPdf417
 Configuration to access parameters of Pdf417. More...
 
class  MsiPlessey
 Configuration to access parameters of MsiPlessey. More...
 
class  MsiPlesseyCheckDigit
 Available check digits for MSI Plessey codes. More...
 
class  Pdf417
 Configuration to access parameters of Pdf417. More...
 
class  Pdf417Levels
 Available PDF417 levels. More...
 
class  PharmaCode
 Configuration to access parameters of PharmaCode. More...
 
class  PharmaCode2DDisposition
 Expectation setting for Pharma Code 2D elements. More...
 
class  PharmaCodeRunDirection
 Run direction of Pharma Codes. More...
 
class  PharmaCodeSkew
 Skew of the Pharma Code bars. More...
 
class  PharmaCodeTolerance
 Tolerance levels for Pharma Code reading acceptance checks. More...
 
class  Planet
 Configuration to access parameters of Planet. More...
 
class  PlanetLevels
 Available level flags for Planet codes. More...
 
class  Postnet
 Configuration to access parameters of Postnet. More...
 
class  PostnetLevels
 Available level flags for Postnet codes. More...
 
class  Qr
 Configuration to access parameters of Qr. More...
 
class  QrGrading
 Configuration to access parameters of QrGrading. More...
 
class  ReaderConfig
 Contains a map of configurations for all active barcode types. More...
 
class  ReaderConfigBase
 Configuration to access parameters of ReaderConfigBase. More...
 
class  ReaderInitialization
 Possible ways to initialize a Barcode reader configuration. More...
 
class  Readout
 Available readout modes. More...
 
class  ReadResult
 Base class for reading decoded barcode results. More...
 
class  ReadResult1D
 Derived from ReadResult and gives specific access to 1D results. More...
 
class  ReadResultCode128
 Derived from ReadResult and gives specific access to Code128 results. More...
 
class  ReadResultCode39Code93
 Derived from ReadResult and gives specific access to Code39 and Code93 results. More...
 
class  ReadResultDataMatrix
 Derived from ReadResult and gives specific access to DataMatrix and PharmaCode2D results. More...
 
class  ReadResultPdf417
 Derived from ReadResult and gives specific access to Pdf417 results. More...
 
class  ReadResultQr
 Derived from ReadResult2D and gives specific access to Qr results. More...
 
class  ReadResultSonyCode
 Derived from ReadResult1D and gives specific access to SonyCode results. More...
 
class  ReadResultUpcE
 Derived from ReadResult1D and gives specific access to UpcE results. More...
 
class  Rss
 Configuration to access parameters of Rss. More...
 
class  RssComposition
 Composition flags for RSS codes. More...
 
class  RssTypes
 Types of RSS codes to read. More...
 
class  SonyCode
 Configuration to access parameters of SonyCode. More...
 
class  Symbology
 Supported barcode types. More...
 
class  UpcA
 Configuration to access parameters of UpcA. More...
 
class  UpcE
 Configuration to access parameters of UpcE. More...
 

Functions

Union[cvb.barcode.ReadResultUpcE, cvb.barcode.ReadResultSonyCode, cvb.barcode.ReadResultCode128, cvb.barcode.ReadResultCode39Code93, cvb.barcode.ReadResult1D, cvb.barcode.ReadResultPdf417, cvb.barcode.ReadResultDataMatrix, cvb.barcode.ReadResultQr, cvb.barcode.ReadResultdecode (cvb.barcode.ReaderConfig reader_config, cvb.ImagePlane image_plane, Optional[cvb.Rect] aoi, Optional[Union[cvb.barcode.ReadResultUpcE, cvb.barcode.ReadResultSonyCode, cvb.barcode.ReadResultCode128, cvb.barcode.ReadResultCode39Code93, cvb.barcode.ReadResult1D, cvb.barcode.ReadResultPdf417, cvb.barcode.ReadResultDataMatrix, cvb.barcode.ReadResultQr, cvb.barcode.ReadResult]] result_type)
 This function initiates the decoding of barcodes and dynamically casts the result. More...
 
cvb.barcode.ReadResultDataMatrix teach_dotted_data_matrix (cvb.barcode.ReaderConfig reader_config, cvb.ImagePlane image_plane, Optional[cvb.Rect] aoi)
 Teach a dotted data matrix code into a configuration. More...
 

Detailed Description

Common Vision Blox Barcode module for Python.

Function Documentation

◆ decode()

This function initiates the decoding of barcodes and dynamically casts the result.

This function is the key function for the decoding of barcodes. In general, you pass an image and a configuration to the function and the results will be returned. The template is used to dynamically cast the resulting object to the specified one.

Parameters

reader_config : cvb.barcode.ReaderConfig This parameter contains all active configurations. A configuration specifies all the conditions which need to be taken into consideration when acquiring barcodes. i.e., which barcodes are to be recognised and what restrictions apply.

image_plane : cvb.ImagePlane The image_plane parameter contains the image object in which barcodes are to be read. The plane must be 8 bits deep and unsigned. The maximum possible extension of the image object in the X and Y direction is 16384. If the image object is larger, the search area is automatically restricted to the maximum permitted area.

aoi : Optional[cvb.Rect] This parameter specifies the area in the image in which the barcode is searched. It is used to restrict the barcode search to a rectangular area within the image object. In this way it is possible to read two or more different barcodes in an image by restricting the search to the area occupied by the barcode. If the entire image were to be specified, the search would terminate when the first barcode is found.

result_type : Optional[Union[cvb.barcode.ReadResultUpcE, cvb.barcode.ReadResultSonyCode, cvb.barcode.ReadResultCode128, cvb.barcode.ReadResultCode39Code93, cvb.barcode.ReadResult1D, cvb.barcode.ReadResultPdf417, cvb.barcode.ReadResultDataMatrix, cvb.barcode.ReadResultQr, cvb.barcode.ReadResult]] Casts the result to this datatype.

Returns

Union[cvb.barcode.ReadResultUpcE, cvb.barcode.ReadResultSonyCode, cvb.barcode.ReadResultCode128, cvb.barcode.ReadResultCode39Code93, cvb.barcode.ReadResult1D, cvb.barcode.ReadResultPdf417, cvb.barcode.ReadResultDataMatrix, cvb.barcode.ReadResultQr, cvb.barcode.ReadResult] The object stores information related to the encoded barcode. Only one barcode can be decoded at a time. Therefore the ReadResult contains the symbology and the location of the decoded barcode.

◆ teach_dotted_data_matrix()

cvb.barcode.ReadResultDataMatrix teach_dotted_data_matrix ( cvb.barcode.ReaderConfig  reader_config,
cvb.ImagePlane  image_plane,
Optional[cvb.Rect aoi 
)

Teach a dotted data matrix code into a configuration.

In general, you pass an image and a configuration to the function and the results will be returned.

Parameters

reader_config : cvb.barcode.ReaderConfig This parameter contains all active configurations. A configuration specifies all the conditions which need to be taken into consideration when acquiring barcodes. i.e., which barcodes are to be recognised and what restrictions apply.

image_plane : cvb.ImagePlane The image_plane parameter contains the image object in which barcodes are to be read. The plane must be 8 bits deep and unsigned. The maximum possible extension of the image object in the X and Y direction is 16384. If the image object is larger, the search area is automatically restricted to the maximum permitted area.

aoi : Optional[cvb.Rect] This parameter specifies the area in the image in which the barcode is searched. It is used to restrict the barcode search to a rectangular area within the image object. In this way it is possible to read two or more different barcodes in an image by restricting the search to the area occupied by the barcode. If the entire image were to be specified, the search would terminate when the first barcode is found.

Returns

cvb.barcode.ReadResultDataMatrix DataMatrix reading result.