OpenCV  4.6.0-dev
Open Source Computer Vision
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
cv::QRCodeEncoder Class Referenceabstract

#include <opencv2/objdetect.hpp>

Classes

struct  Params
 QR code encoder parameters. More...
 

Public Types

enum  CorrectionLevel {
  CORRECT_LEVEL_L = 0,
  CORRECT_LEVEL_M = 1,
  CORRECT_LEVEL_Q = 2,
  CORRECT_LEVEL_H = 3
}
 
enum  ECIEncodings { ECI_UTF8 = 26 }
 
enum  EncodeMode {
  MODE_AUTO = -1,
  MODE_NUMERIC = 1,
  MODE_ALPHANUMERIC = 2,
  MODE_BYTE = 4,
  MODE_ECI = 7,
  MODE_KANJI = 8,
  MODE_STRUCTURED_APPEND = 3
}
 

Public Member Functions

virtual ~QRCodeEncoder ()
 
virtual void encode (const String &encoded_info, OutputArray qrcode)=0
 Generates QR code from input string. More...
 
virtual void encodeStructuredAppend (const String &encoded_info, OutputArrayOfArrays qrcodes)=0
 Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes. More...
 

Static Public Member Functions

static Ptr< QRCodeEncodercreate (const QRCodeEncoder::Params &parameters=QRCodeEncoder::Params())
 Constructor. More...
 

Protected Member Functions

 QRCodeEncoder ()
 

Member Enumeration Documentation

◆ CorrectionLevel

Enumerator
CORRECT_LEVEL_L 
CORRECT_LEVEL_M 
CORRECT_LEVEL_Q 
CORRECT_LEVEL_H 

◆ ECIEncodings

Enumerator
ECI_UTF8 

◆ EncodeMode

Enumerator
MODE_AUTO 
MODE_NUMERIC 
MODE_ALPHANUMERIC 
MODE_BYTE 
MODE_ECI 
MODE_KANJI 
MODE_STRUCTURED_APPEND 

Constructor & Destructor Documentation

◆ QRCodeEncoder()

cv::QRCodeEncoder::QRCodeEncoder ( )
protected

◆ ~QRCodeEncoder()

virtual cv::QRCodeEncoder::~QRCodeEncoder ( )
virtual

Member Function Documentation

◆ create()

static Ptr<QRCodeEncoder> cv::QRCodeEncoder::create ( const QRCodeEncoder::Params parameters = QRCodeEncoder::Params())
static
Python:
cv.QRCodeEncoder.create([, parameters]) -> retval
cv.QRCodeEncoder_create([, parameters]) -> retval

Constructor.

Parameters
parametersQR code encoder parameters QRCodeEncoder::Params

◆ encode()

virtual void cv::QRCodeEncoder::encode ( const String encoded_info,
OutputArray  qrcode 
)
pure virtual
Python:
cv.QRCodeEncoder.encode(encoded_info[, qrcode]) -> qrcode

Generates QR code from input string.

Parameters
encoded_infoInput string to encode.
qrcodeGenerated QR code.

◆ encodeStructuredAppend()

virtual void cv::QRCodeEncoder::encodeStructuredAppend ( const String encoded_info,
OutputArrayOfArrays  qrcodes 
)
pure virtual
Python:
cv.QRCodeEncoder.encodeStructuredAppend(encoded_info[, qrcodes]) -> qrcodes

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Parameters
encoded_infoInput string to encode.
qrcodesVector of generated QR codes.

The documentation for this class was generated from the following file: