CVB++ 14.0
ReaderFourStateConfigBase Class Reference

Configuration to access parameters of ReaderFourStateConfigBase. More...

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

Inherits ReaderConfigBase.

Inherited by FourStateAustralian, FourStateKix, FourStateRoyalMail, and FourStateUsps.

Public Member Functions

void SetMirrored (bool mirrored)
 Sets whether the code is mirrored/not mirrored. More...
 
bool Mirrored () const
 Returns whether the code is mirrored/not mirrored. More...
 
void SetQuietzoneWidth (int quietzoneWidth)
 Sets the quiet zone in module width. More...
 
int QuietzoneWidth () const
 Returns the quiet zone in module width. More...
 
void SetThreshold (int threshold)
 Sets the digitalisation threshold in percent, ranging from 0 to 100. More...
 
int Threshold () const
 Returns the digitalisation threshold in percent, ranging from 0 to 100. More...
 
- Public Member Functions inherited from ReaderConfigBase
void SetInverse (bool inverse)
 Code is inverted (white on black)/not inverted. More...
 
bool Inverse () const
 Returns whether the code is inverted (white on black) or not. More...
 

Detailed Description

Configuration to access parameters of ReaderFourStateConfigBase.

Member Function Documentation

◆ Mirrored()

bool Mirrored ( ) const
inline

Returns whether the code is mirrored/not mirrored.

Returns
True specifies that the 4-State Australian is mirrored, possibly because the code must be read from the rear or because it was mirrored on image acquisition.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMirrored

◆ QuietzoneWidth()

int QuietzoneWidth ( ) const
inline

Returns the quiet zone in module width.

Returns
The quiet zone. The range is between 2 to 10. Default quietzone = 5.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetQuietzoneWidth

◆ SetMirrored()

void SetMirrored ( bool  mirrored)
inline

Sets whether the code is mirrored/not mirrored.

Parameters
[in]mirroredTrue specifies that the 4-State Australian is mirrored, possibly because the code must be read from the rear or because it was mirrored on image acquisition.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Mirrored

◆ SetQuietzoneWidth()

void SetQuietzoneWidth ( int  quietzoneWidth)
inline

Sets the quiet zone in module width.

Parameters
[in]quietzoneWidthIt sets the minimal quiet zone in module width. The range is between 2 to 10. Default quietzone = 5.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
QuietzoneWidth

◆ SetThreshold()

void SetThreshold ( int  threshold)
inline

Sets the digitalisation threshold in percent, ranging from 0 to 100.

Parameters
[in]thresholdDefault threshold = 10.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Threshold

◆ Threshold()

int Threshold ( ) const
inline

Returns the digitalisation threshold in percent, ranging from 0 to 100.

Returns
The digitalisation threshold.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetThreshold