Decoder Class Reference

Class for barcode decoding. More...

#include <decl_decoder.hpp>

Public Member Functions
std::vector< Result >	Execute (const ImagePlane &plane, const Rect< int > &aoi)
	Performs the barcode decoding.
std::vector< Result >	Execute (const ImagePlane &plane)
	Performs the barcode decoding.
template<Symbology SYM>
Config::Mapper< SYM >::Type &	Config ()
	Retrieves the configuration object for a specific barcode symbology.
void	SetBasicInkjetDPMEnabled (bool value)
	Enables or disables the reading of Basic Inkjet DPM (Direct Part Marking) codes.
bool	IsBasicInkjetDPMEnabled () const
	Checks whether the Basic Inkjet DPM mode is enabled.

Static Public Member Functions
static std::unique_ptr< Decoder >	Create ()
	Creates and returns a new Decoder instance.

Detailed Description

Class for barcode decoding.

This class provides the core functionality for detecting and decoding barcodes in images. Each barcode type can be configured using its corresponding configuration class.

To decode an image containing a supported barcode, start by creating a decoder. You can configure your decoder using the member function Decoder::Config(), which returns a reference to the desired configuration class. The configuration class is specified by the Barcode::Symbology template. All supported barcode types are enumerated in the enum class Barcode::Symbology.

After configuring the decoder, load an image containing the barcode(s) and execute the decoding process. The following code snippet demonstrates how to decode an image containing Data Matrix and QR codes:

#include <iostream>
#include <cvb/image.hpp>
#include <cvb/barcode/barcode.hpp>
 
using namespace Cvb::Barcode;
 
// Create a decoder.
auto decoder = Decoder::Create();
 
// Retrieve the configuration object for a specific barcode symbology.
auto& config = decoder->Config<Symbology::DataMatrix>();
 
// Enable decoding for the selected symbology and configure additional (optional) parameters.
config.Enable().SetPolarity(Config::Polarity::DarkOnLight);
 
// Alternatively, the configuration can be performed in a more concise manner:
decoder->Config<Symbology::QR>().Enable().SetPolarity(Config::Polarity::DarkOnLight);
 
// Load the image and decode.
auto image   = Cvb::Image::Load(CVB_LIT("your_image_with_barcode.bmp"));
auto results = decoder->Execute(image->Plane(0));
 
// Display results.
std::cout << results.size() << " barcode(s) found.\n";
for (int i = 0; i < results.size(); i++)
{
   std::cout << results[i].Data().c_str() << "\n";
}

Member Function Documentation

Config()

template<Symbology SYM>

Config::Mapper< SYM >::Type & Config ( )

inline

Retrieves the configuration object for a specific barcode symbology.

Use this function to access the configuration settings for a particular barcode symbology. After creating a decoder, you can obtain the desired configuration object as shown below:

auto decoder = Cvb::Barcode::Decoder::Create();
auto &config = decoder->Config<Cvb::Barcode::Symbology::DataMatrix>();
config.Enable();

Alternatively, you can utilize the fluent interface pattern for seamless configuration:

auto decoder = Cvb::Barcode::Decoder::Create();
decoder->Config<Cvb::Barcode::Symbology::DataMatrix>().Enable().SetMirroring(true);

Template Parameters

SYM	The barcode symbology for which the configuration is retrieved.

Returns

A reference to the configuration object corresponding to the specified symbology.

Create()

std::unique_ptr< Decoder > Create ( )

inlinestatic

Creates and returns a new Decoder instance.

Returns

A std::unique_ptr pointing to the newly created Decoder object.

Execute() [1/2]

std::vector< Result > Execute ( const ImagePlane & plane )

inline

Performs the barcode decoding.

Up to 256 barcodes can be detected using this function.

Parameters

plane

The image plane containing the barcode(s) to decode.

Returns

A vector of Result objects containing the decoded barcode data.

Execute() [2/2]

std::vector< Result > Execute ( const ImagePlane & plane, const Rect< int > & aoi )

inline

Performs the barcode decoding.

For further details see function Execute(const ImagePlane &).

Parameters

plane	The image plane containing the barcode(s) to decode.
aoi	The area of interest within the image where the decoding operation will be performed.

Returns

A vector of Result objects containing the decoded barcode data.

IsBasicInkjetDPMEnabled()

bool IsBasicInkjetDPMEnabled ( ) const

inline

Checks whether the Basic Inkjet DPM mode is enabled.

Returns

value true if the Basic Inkjet DPM mode is enabled, false otherwise.

SetBasicInkjetDPMEnabled()

void SetBasicInkjetDPMEnabled ( bool value )

inline

Enables or disables the reading of Basic Inkjet DPM (Direct Part Marking) codes.

This setting applies exclusively to DPM codes. Enabling Basic Inkjet DPM allows for the reading of low-quality inkjet images.

Parameters

value

Set to true to enable Basic Inkjet DPM, false otherwise.