Configuration class for Data Matrix codes.
More...
#include <cvb/config.hpp>
Inherits ConfigBase< DataMatrix >.
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().
DataMatrix & Enable()
Definition detail_config_base.hpp:16
static std::unique_ptr< Decoder > Create()
Creates and returns a new Decoder instance.
Definition detail_decoder.hpp:22
@ 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.
◆ IsMirroringEnabled()
bool IsMirroringEnabled |
( |
| ) |
const |
|
inline |
Checks whether mirroring is enabled.
- Returns
- value
true
if mirroring is enabled, false
otherwise.
◆ MaximumSize()
◆ MaxLineFilterSize()
int MaxLineFilterSize |
( |
| ) |
|
|
inline |
◆ MaxModuleSize()
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()
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()
◆ MinNumberModules()
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()
Gets the currently configured polarity mode.
- Returns
- The polarity mode.
◆ RectangularDecoding()
Gets the currently configured rectangular decoding mode.
- Returns
- The rectangular decoding mode.
◆ SetMaximumSize()
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()
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()
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()
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()
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()
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()
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()
Sets polarity mode for decoding.
- Parameters
-
value | The desired polarity mode. |
- Returns
- A reference to the current DataMatrix object for method chaining.
◆ SetRectangularDecoding()
Configures the rectangular decoding mode.
- Parameters
-
value | The desired rectangular decoding mode. |
- Returns
- A reference to the current DataMatrix object for method chaining.