CVB++ 14.0
QrGrading Class Reference

Configuration to access parameters of QrGrading. More...

#include <cvb/barcode/_detail/qr_grading.hpp>

Inherits Grader2DConfigBase.

Public Member Functions

void SetExpectReducedQuietzone (bool expectReducedQuietzone)
 With this flag the quiet zone expected may be reduced to one module size (standard are 4 module sizes for QR codes and 2 module sizes for micro QR codes). More...
 
bool ExpectReducedQuietzone () const
 Returns whether the quiet zone expected may be reduced to one module size (standard are 4 module sizes for QR codes and 2 module sizes for micro QR codes). More...
 
void SetGradeFormatInformation (bool formatInformation)
 Activates (true) or deactivates (false) the calculation of the format information grade. More...
 
bool GradeFormatInformation () const
 Returns the calculation of the format information grade. More...
 
void SetGradeVersionInformation (bool versionInformation)
 Activates (true) or deactivates (false) the calculation of the version information grade. More...
 
bool GradeVersionInformation () const
 Returns the calculation of the version information grade. More...
 
- Public Member Functions inherited from Grader2DConfigBase
void SetGradeAngleOfDistortion (bool angleOfDistortion)
 Activates (true) or deactivates (false) the calculation of the angle of distortion. This value does not enter the calculation of the scan grade value. More...
 
bool GradeAngleOfDistortion () const
 Returns whether it activates/deactives the calculation of the angle of distortion. This value does not enter the calculation of the scan grade value. More...
 
void SetGradeAxialNonUniformity (bool axialNonUniformity)
 Activates (true) or deactivates (false) the calculation of the axial_nonuniformity grade. More...
 
bool GradeAxialNonUniformity () const
 Returns whether it activates (true) or deactivates (false) the calculation of the axial nonuniformity grade. More...
 
void SetGradeFixedPatternDamage (bool fixedPatternDamage)
 Activates (true) or deactivates (false) the calculation of the fixed pattern damage grade. More...
 
bool GradeFixedPatternDamage () const
 Returns whether it activates (true) or deactivates (false) the calculation of the fixed pattern damage grade. More...
 
void SetGradeGridNonUniformity (bool gridNonUniformity)
 Activates (true) or deactivates (false) the calculation of the grid nonuniformity grade. More...
 
bool GradeGridNonUniformity () const
 Returns whether it activates (true) or deactivates (false) the calculation of the grid nonuniformity grade. More...
 
void SetGradeReflectanceMargin (bool reflectanceMargin)
 Activates (true) or deactivates (false) the calculation of the reflectance margin. More...
 
bool GradeReflectanceMargin () const
 Returns whether it activates (true) or deactivates (false) the calculation of the reflectance margin. More...
 
void SetGradeUnusedErrorCorrection (bool unusedErrorCorrection)
 Activates (true) or deactivates (false) the calculation of the unused error correction grade. More...
 
bool GradeUnusedErrorCorrection () const
 Returns whether it activates (true) or deactivates (false) the calculation of the unused error correction grade. More...
 
- Public Member Functions inherited from GraderConfigBase
void SetGradeModulation (bool modulation)
 Activates (true) or deactivates (false) the calculation of the modulation grade. More...
 
bool GradeModulation () const
 Activates (true) or deactivates (false) the calculation of the modulation grade. More...
 
void SetGradeSymbolContrast (bool symbolContrast)
 Activates (true) or deactivates (false) the calculation of the symbol contrast grade. More...
 
bool GradeSymbolContrast () const
 Activates (true) or deactivates (false) the calculation of the symbol contrast grade. More...
 
void SetReflectanceReference (Cvb::ValueRange< int > reflectanceReference)
 Reflectance Reference Range for contrast calculation. More...
 
Cvb::ValueRange< int > ReflectanceReference () const
 Reflectance Reference Range for contrast calculation. More...
 

Static Public Member Functions

static std::unique_ptr< QrGradingFromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of QrGrading.

Member Function Documentation

◆ ExpectReducedQuietzone()

bool ExpectReducedQuietzone ( ) const
inline

Returns whether the quiet zone expected may be reduced to one module size (standard are 4 module sizes for QR codes and 2 module sizes for micro QR codes).

Returns
Whether the quiet zone around the code is less than the usual 4 module sizes (for regular QR) or 2 module sizes (for mini QR).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
ExpectReducedQuietzone

◆ FromHandle()

static std::unique_ptr< QrGrading > FromHandle ( const HandleGuard< ReaderConfig > &  guard,
bool &  isActiveOut 
)
inlinestatic

Create object from handle.

Parameters
[in]guardHandle guard to read the configuration from.
[out]isActiveOutReturns the active state of the configuration in the handle.
Returns
unique pointer to object.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ GradeFormatInformation()

bool GradeFormatInformation ( ) const
inline

Returns the calculation of the format information grade.

Returns
The calculation of the format information grade.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetGradeFormatInformation

◆ GradeVersionInformation()

bool GradeVersionInformation ( ) const
inline

Returns the calculation of the version information grade.

Returns
The calculation of the version information grade.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetGradeVersionInformation

◆ SetExpectReducedQuietzone()

void SetExpectReducedQuietzone ( bool  expectReducedQuietzone)
inline

With this flag the quiet zone expected may be reduced to one module size (standard are 4 module sizes for QR codes and 2 module sizes for micro QR codes).

Parameters
[in]expectReducedQuietzoneSet to true if the quiet zone around the code is less than the usual 4 module sizes (for regular QR) or 2 module sizes (for mini QR).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
ExpectReducedQuietzone

◆ SetGradeFormatInformation()

void SetGradeFormatInformation ( bool  formatInformation)
inline

Activates (true) or deactivates (false) the calculation of the format information grade.

Parameters
[in]formatInformationActivates (true) or deactivates (false) the calculation of the format information grade.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
GradeFormatInformation

◆ SetGradeVersionInformation()

void SetGradeVersionInformation ( bool  versionInformation)
inline

Activates (true) or deactivates (false) the calculation of the version information grade.

Parameters
[in]versionInformationActivates (true) or deactivates (false) the calculation of the version information grade.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
GradeVersionInformation