Configuration class for Data Matrix codes. More...

#include <cvb/config.hpp>

Public Member Functions
DataMatrix &	SetPolarity (enum class Polarity value)
	Sets polarity mode for decoding.

enum Polarity	Polarity () const
	Gets the currently configured polarity mode.

DataMatrix &	SetMirroringEnabled (bool value)
	Enables or disables mirroring based on the given value.

bool	IsMirroringEnabled () const
	Checks whether mirroring is enabled.

DataMatrix &	SetRectangularDecoding (enum class RectangularDecoding value)
	Configures the rectangular decoding mode.

enum RectangularDecoding	RectangularDecoding () const
	Gets the currently configured rectangular decoding mode.

DataMatrix &	SetMinimumSize (int size)
	Sets the minimum Data Matrix size.

int	MinimumSize ()
	Gets the minimum Data Matrix size.

DataMatrix &	SetMaximumSize (int size)
	Sets the maximum Data Matrix size.

int	MaximumSize ()
	Gets the maximum Data Matrix size.

DataMatrix &	SetMinNumberModules (int value)
	Sets the minimum number of Data Matrix column modules.

int	MinNumberModules ()
	Gets the minimum number of Data Matrix column modules.

DataMatrix &	SetMaxNumberModules (int value)
	Sets the maximum number of Data Matrix column modules.

int	MaxNumberModules ()
	Gets the maximum number of Data Matrix column modules.

DataMatrix &	SetMaxModuleSize (int size)
	Sets the maximum module size of Data Matrix in pixels.

int	MaxModuleSize ()
	Gets the maximum module size of Data Matrix in pixels.

DataMatrix &	SetMaxLineFilterSize (int size)
	Sets the maximum line filter size in pixels.

int	MaxLineFilterSize ()
	Gets the maximum line filter size in pixels.

Public Member Functions inherited from ConfigBase< DataMatrix >
bool	Enabled () const
	Checks if decoding for the barcode type represented by the derived class is enabled.

DataMatrix &	Enable ()
	Enables decoding for the barcode type represented by the derived class.

DataMatrix &	Disable ()
	Disables decoding for the barcode type represented by the derived class.

Detailed Description

Configuration class for Data Matrix codes.

Use this class to configure decoding options for Data Matrix barcodes. To access the configuration and enable decoding Data Matrix barcodes, use the following example. For additional details on configuration, refer to the documentation for Decoder::Config().

auto decoder = Cvb::Barcode::Decoder::Create();

decoder->Config<Cvb::Barcode::Symbology::DataMatrix>().Enable();

Cvb::Barcode::Config::ConfigBase< DataMatrix >::Enable

DataMatrix & Enable()

Definition detail_config_base.hpp:16

Cvb::Barcode::Decoder::Create

static std::unique_ptr< Decoder > Create()

Creates and returns a new Decoder instance.

Definition detail_decoder.hpp:22

Cvb::Barcode::Symbology::DataMatrix

@ DataMatrix

Data Matrix.

Definition decl_config_base.hpp:42

Note, that ECC0-140 is not supported.

Note: A more comprehensive code example demonstrating configuration in a broader context, as well as the decoding process, can be found here.

Member Function Documentation

◆ IsMirroringEnabled()

bool IsMirroringEnabled ( ) const

inline

Checks whether mirroring is enabled.

Returns: value true if mirroring is enabled, false otherwise.

◆ MaximumSize()

int MaximumSize ( )

inline

Gets the maximum Data Matrix size.

See function DataMatrix::SetMaximumSize() for details.

Returns: The maximum Data Matrix size.

◆ MaxLineFilterSize()

int MaxLineFilterSize ( )

inline

Gets the maximum line filter size in pixels.

See function DataMatrix::SetMaxLineFilterSize() for details.

Returns: The maximum line filter size in pixels.

◆ MaxModuleSize()

int MaxModuleSize ( )

inline

Gets the maximum module size of Data Matrix in pixels.

See function DataMatrix::SetMaxModuleSize() for details.

Returns: The maximum module size of Data Matrix in pixels.

◆ MaxNumberModules()

int MaxNumberModules ( )

inline

Gets the maximum number of Data Matrix column modules.

See function DataMatrix::SetMaxNumberModules() for details.

Returns: The maximum number of Data Matrix column modules.

◆ MinimumSize()

int MinimumSize ( )

inline

Gets the minimum Data Matrix size.

See function DataMatrix::SetMinimumSize() for details.

Returns: The minimum Data Matrix size.

◆ MinNumberModules()

int MinNumberModules ( )

inline

Gets the minimum number of Data Matrix column modules.

See function DataMatrix::SetMinNumberModules() for details.

Returns: The minimum number of Data Matrix column modules.

◆ Polarity()

Polarity Polarity ( ) const

inlinestrong

Gets the currently configured polarity mode.

Returns: The polarity mode.

◆ RectangularDecoding()

RectangularDecoding RectangularDecoding ( ) const

inlinestrong

Gets the currently configured rectangular decoding mode.

Returns: The rectangular decoding mode.

◆ SetMaximumSize()

DataMatrix & SetMaximumSize ( int size )

inline

Sets the maximum Data Matrix size.

The default value is 2048 pixel. Setting to a lower value that is slightly greater than the biggest Data Matrix in the image may speed up Data Matrix locating with background clutter.

Parameters

size	The desired size (between 0 and 2048 pixels).

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetMaxLineFilterSize()

DataMatrix & SetMaxLineFilterSize ( int size )

inline

Sets the maximum line filter size in pixels.

The default value is 0. Setting it to a larger value will help filter out line patterns that are not part of the Data Matrix borders, and speed up Data Matrix locating with background clutter.

Parameters

size	The desired number of column modules (between 0 and 36).

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetMaxModuleSize()

DataMatrix & SetMaxModuleSize ( int size )

inline

Sets the maximum module size of Data Matrix in pixels.

The default value is 100 pixels. Setting it to a smaller value sufficient for decoding all possible Data Matrix sizes in the image may speed up Data Matrix locating with background clutter.

Parameters

size	The desired number of column modules (between 2 and 100).

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetMaxNumberModules()

DataMatrix & SetMaxNumberModules ( int value )

inline

Sets the maximum number of Data Matrix column modules.

The default value is 144 for the 144x144 Data Matrix. Setting it to the largest column number of the Data Matrix in the image may speed up Data Matrix locating with background clutter.

Parameters

value The desired number of column modules (between 10 and 144).

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetMinimumSize()

DataMatrix & SetMinimumSize ( int size )

inline

Sets the minimum Data Matrix size.

The default value is 0 pixel. Setting to a higher value that is slightly smaller than the smallest Data Matrix in the image may speed up Data Matrix locating with background clutter.

Parameters

size	The desired size (between 0 and 2048 pixels).

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetMinNumberModules()

DataMatrix & SetMinNumberModules ( int value )

inline

Sets the minimum number of Data Matrix column modules.

The default value is 10 for the 10x10 Data Matrix. Setting it to the smallest column number of the Data Matrix in the image may speed up Data Matrix locating with background clutter.

Parameters

value The desired number of column modules (between 10 and 144).

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetMirroringEnabled()

DataMatrix & SetMirroringEnabled ( bool value )

inline

Enables or disables mirroring based on the given value.

Parameters

value Set to true to enable mirroring, or false to disable it.

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetPolarity()

DataMatrix & SetPolarity ( enum class Polarity value )

inline

Sets polarity mode for decoding.

Parameters

value The desired polarity mode.

Returns: A reference to the current DataMatrix object for method chaining.

◆ SetRectangularDecoding()

DataMatrix & SetRectangularDecoding ( enum class RectangularDecoding value )

inline

Configures the rectangular decoding mode.

Parameters

value The desired rectangular decoding mode.

Returns: A reference to the current DataMatrix object for method chaining.

Public Member Functions

Detailed Description

Member Function Documentation

◆ IsMirroringEnabled()

◆ MaximumSize()

◆ MaxLineFilterSize()

◆ MaxModuleSize()

◆ MaxNumberModules()

◆ MinimumSize()

◆ MinNumberModules()

◆ Polarity()

◆ RectangularDecoding()

◆ SetMaximumSize()

◆ SetMaxLineFilterSize()

◆ SetMaxModuleSize()

◆ SetMaxNumberModules()

◆ SetMinimumSize()

◆ SetMinNumberModules()

◆ SetMirroringEnabled()

◆ SetPolarity()

◆ SetRectangularDecoding()