OpenCV  4.9.0-dev
Open Source Computer Vision
Public Member Functions | List of all members
cv::barcode::BarcodeDetector Class Reference

#include <opencv2/objdetect/barcode.hpp>

Inheritance diagram for cv::barcode::BarcodeDetector:
cv::GraphicalCodeDetector

Public Member Functions

 BarcodeDetector ()
 Initialize the BarcodeDetector. More...
 
 BarcodeDetector (CV_WRAP_FILE_PATH const std::string &prototxt_path, CV_WRAP_FILE_PATH const std::string &model_path)
 Initialize the BarcodeDetector. More...
 
 ~BarcodeDetector ()
 
bool decodeWithType (InputArray img, InputArray points, std::vector< std::string > &decoded_info, std::vector< std::string > &decoded_type) const
 Decodes barcode in image once it's found by the detect() method. More...
 
bool detectAndDecodeWithType (InputArray img, std::vector< std::string > &decoded_info, std::vector< std::string > &decoded_type, OutputArray points=noArray()) const
 Both detects and decodes barcode. More...
 
- Public Member Functions inherited from cv::GraphicalCodeDetector
 GraphicalCodeDetector ()
 
 GraphicalCodeDetector (const GraphicalCodeDetector &)=default
 
 GraphicalCodeDetector (GraphicalCodeDetector &&)=default
 
std::string decode (InputArray img, InputArray points, OutputArray straight_code=noArray()) const
 Decodes graphical code in image once it's found by the detect() method. More...
 
bool decodeMulti (InputArray img, InputArray points, std::vector< std::string > &decoded_info, OutputArrayOfArrays straight_code=noArray()) const
 Decodes graphical codes in image once it's found by the detect() method. More...
 
bool detect (InputArray img, OutputArray points) const
 Detects graphical code in image and returns the quadrangle containing the code. More...
 
std::string detectAndDecode (InputArray img, OutputArray points=noArray(), OutputArray straight_code=noArray()) const
 Both detects and decodes graphical code. More...
 
bool detectAndDecodeMulti (InputArray img, std::vector< std::string > &decoded_info, OutputArray points=noArray(), OutputArrayOfArrays straight_code=noArray()) const
 Both detects and decodes graphical codes. More...
 
bool detectMulti (InputArray img, OutputArray points) const
 Detects graphical codes in image and returns the vector of the quadrangles containing the codes. More...
 
GraphicalCodeDetectoroperator= (const GraphicalCodeDetector &)=default
 
GraphicalCodeDetectoroperator= (GraphicalCodeDetector &&)=default
 

Additional Inherited Members

- Protected Attributes inherited from cv::GraphicalCodeDetector
Ptr< Impl > p
 

Constructor & Destructor Documentation

◆ BarcodeDetector() [1/2]

cv::barcode::BarcodeDetector::BarcodeDetector ( )
Python:
cv.barcode.BarcodeDetector() -> <barcode_BarcodeDetector object>
cv.barcode.BarcodeDetector(prototxt_path, model_path) -> <barcode_BarcodeDetector object>

Initialize the BarcodeDetector.

◆ BarcodeDetector() [2/2]

cv::barcode::BarcodeDetector::BarcodeDetector ( CV_WRAP_FILE_PATH const std::string &  prototxt_path,
CV_WRAP_FILE_PATH const std::string &  model_path 
)
Python:
cv.barcode.BarcodeDetector() -> <barcode_BarcodeDetector object>
cv.barcode.BarcodeDetector(prototxt_path, model_path) -> <barcode_BarcodeDetector object>

Initialize the BarcodeDetector.

Parameters allow to load optional Super Resolution DNN model for better quality.

Parameters
prototxt_pathprototxt file path for the super resolution model
model_pathmodel file path for the super resolution model

◆ ~BarcodeDetector()

cv::barcode::BarcodeDetector::~BarcodeDetector ( )

Member Function Documentation

◆ decodeWithType()

bool cv::barcode::BarcodeDetector::decodeWithType ( InputArray  img,
InputArray  points,
std::vector< std::string > &  decoded_info,
std::vector< std::string > &  decoded_type 
) const
Python:
cv.barcode.BarcodeDetector.decodeWithType(img, points) -> retval, decoded_info, decoded_type

Decodes barcode in image once it's found by the detect() method.

Parameters
imggrayscale or color (BGR) image containing bar code.
pointsvector of rotated rectangle vertices found by detect() method (or some other algorithm). For N detected barcodes, the dimensions of this array should be [N][4]. Order of four points in vector<Point2f> is bottomLeft, topLeft, topRight, bottomRight.
decoded_infoUTF8-encoded output vector of string or empty vector of string if the codes cannot be decoded.
decoded_typevector strings, specifies the type of these barcodes
Returns
true if at least one valid barcode have been found

◆ detectAndDecodeWithType()

bool cv::barcode::BarcodeDetector::detectAndDecodeWithType ( InputArray  img,
std::vector< std::string > &  decoded_info,
std::vector< std::string > &  decoded_type,
OutputArray  points = noArray() 
) const
Python:
cv.barcode.BarcodeDetector.detectAndDecodeWithType(img[, points]) -> retval, decoded_info, decoded_type, points

Both detects and decodes barcode.

Parameters
imggrayscale or color (BGR) image containing barcode.
decoded_infoUTF8-encoded output vector of string(s) or empty vector of string if the codes cannot be decoded.
decoded_typevector of strings, specifies the type of these barcodes
pointsoptional output vector of vertices of the found barcode rectangle. Will be empty if not found.
Returns
true if at least one valid barcode have been found

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