Visual Servoing Platform  version 3.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
vpDetectorQRCode Class Reference

#include <visp3/detection/vpDetectorQRCode.h>

+ Inheritance diagram for vpDetectorQRCode:

Public Member Functions

 vpDetectorQRCode ()
virtual ~vpDetectorQRCode ()
bool detect (const vpImage< unsigned char > &I)
std::vector< std::vector
< vpImagePoint > > & 
getPolygon ()
std::vector< vpImagePoint > & getPolygon (size_t i)
std::string & getMessage (size_t i)
std::vector< std::string > & getMessage ()
size_t getNbObjects () const
vpImagePoint getCog (size_t i) const
vpRect getBBox (size_t i) const

Protected Attributes

zbar::ImageScanner m_scanner
std::vector< std::vector
< vpImagePoint > > 
std::vector< std::string > m_message
size_t m_nb_objects

Detailed Description

Base class for bar code detector. This class is a wrapper over libzbar available from Installation instructions are provided here

The detect() function allows to detect multiple QR codes in an image. Once detected, for each QR code it is possible to retrieve the location of the corners using getPolygon(), the encoded message using getMessage(), the bounding box using getBBox() and the center of gravity using getCog().

The following sample code shows how to use this class to detect QR codes in an image.

#include <visp3/detection/vpDetectorQRCode.h>
#include <visp3/io/vpImageIo.h>
int main()
vpImageIo::read(I, "bar-code.pgm");
vpDetectorQRCode detector;
bool status = detector.detect(I);
if (status) {
for(size_t i=0; i < detector.getNbObjects(); i++) {
std::cout << "Bar code " << i << ":" << std::endl;
std::vector<vpImagePoint> p = detector.getPolygon(i);
for(size_t j=0; j < p.size(); j++)
std::cout << " Point " << j << ": " << p[j] << std::endl;
std::cout << " Message: \"" << detector.getMessage(i) << "\"" << std::endl;

The previous example may produce results like:

Bar code 0:
Point 0: 48, 212
Point 1: 57, 84
Point 2: 188, 92
Point 3: 183, 220
Message: "qrcode 2"
Bar code 1:
Point 0: 26, 550
Point 1: 35, 409
Point 2: 174, 414
Point 3: 167, 555
Message: "qrcode 1"

Other examples are also provided in tutorial-barcode-detector.cpp and tutorial-barcode-detector-live.cpp

tutorial-barcode-detector-live.cpp, tutorial-barcode-detector.cpp, and tutorial-pose-from-qrcode-image.cpp.

Definition at line 112 of file vpDetectorQRCode.h.

Constructor & Destructor Documentation

vpDetectorQRCode::vpDetectorQRCode ( )

Default constructor.

Definition at line 48 of file vpDetectorQRCode.cpp.

References m_scanner.

virtual vpDetectorQRCode::~vpDetectorQRCode ( )

Definition at line 119 of file vpDetectorQRCode.h.

Member Function Documentation

bool vpDetectorQRCode::detect ( const vpImage< unsigned char > &  I)

Detect QR codes in the image. Return true if a code is detected, false otherwise.

I: Input image.

Implements vpDetectorBase.


Definition at line 59 of file vpDetectorQRCode.cpp.

References vpImage< Type >::bitmap, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpDetectorBase::m_message, vpDetectorBase::m_nb_objects, vpDetectorBase::m_polygon, and m_scanner.

vpRect vpDetectorBase::getBBox ( size_t  i) const
vpImagePoint vpDetectorBase::getCog ( size_t  i) const

Return the center of gravity location of the ith object.

Definition at line 75 of file vpDetectorBase.cpp.

References vpDetectorBase::m_polygon.

std::string & vpDetectorBase::getMessage ( size_t  i)
std::vector< std::string >& vpDetectorBase::getMessage ( void  )

Returns the contained message of the ith object if there is one.

Definition at line 105 of file vpDetectorBase.h.

size_t vpDetectorBase::getNbObjects ( ) const
std::vector< std::vector<vpImagePoint> >& vpDetectorBase::getPolygon ( )
std::vector< vpImagePoint > & vpDetectorBase::getPolygon ( size_t  i)

Returns ith object container box as a vector of points.

Definition at line 51 of file vpDetectorBase.cpp.

References vpException::badValue, and vpDetectorBase::m_polygon.

Member Data Documentation

std::vector< std::string > vpDetectorBase::m_message

Message attached to each object.

Definition at line 65 of file vpDetectorBase.h.

Referenced by vpDetectorFace::detect(), vpDetectorDataMatrixCode::detect(), detect(), and vpDetectorBase::getMessage().

size_t vpDetectorBase::m_nb_objects

Number of detected objects.

Definition at line 66 of file vpDetectorBase.h.

Referenced by vpDetectorFace::detect(), vpDetectorDataMatrixCode::detect(), and detect().

std::vector< std::vector<vpImagePoint> > vpDetectorBase::m_polygon

For each object, defines the polygon that contains the object.

Definition at line 64 of file vpDetectorBase.h.

Referenced by vpDetectorFace::detect(), vpDetectorDataMatrixCode::detect(), detect(), vpDetectorBase::getBBox(), vpDetectorBase::getCog(), vpDetectorBase::getMessage(), and vpDetectorBase::getPolygon().

zbar::ImageScanner vpDetectorQRCode::m_scanner

QR code detector.

Definition at line 115 of file vpDetectorQRCode.h.

Referenced by detect(), and vpDetectorQRCode().