CVB.Net 15.0
Loading...
Searching...
No Matches
DataMatrix Class Reference

Configuration for Data Matrix codes. More...

Inherits ConfigBase< T >.

Public Member Functions

DataMatrix SetPolarity (Polarity polarity)
 Sets value for Polarity.
 
DataMatrix SetMirrorDecodingEnabled (bool enable)
 Sets value for IsMirrorDecodingEnabled .
 
DataMatrix SetRectangularDecodingEnabled (RectangularDecoding rectangularDecoding)
 Sets value for IsRectangularDecodingEnabled.
 
DataMatrix SetMaximumSize (int size)
 Sets value for MaximumSize.
 
DataMatrix SetMinimumSize (int size)
 Sets value for MinimumSize.
 
DataMatrix SetMaxLineFilterSize (int size)
 Sets value for MaxLineFilterSize.
 
DataMatrix SetMaxModuleSize (int size)
 Sets value for MaxModuleSize.
 
DataMatrix SetMaxNumModules (int number)
 Sets value for MaxNumModules.
 
- Public Member Functions inherited from ConfigBase< T >
SetEnabled (bool enabled)
 Sets value for IsEnabled.
 

Properties

Polarity Polarity [get, set]
 Polarity.
 
bool IsMirrorDecodingEnabled [get, set]
 Enable/disable mirror image decoding.
 
RectangularDecoding IsRectangularDecodingEnabled [get, set]
 Enable/disable rectangular decoding.
 
int MaximumSize [get, set]
 Maximum data matrix size in pixels.
 
int MinimumSize [get, set]
 Minimum data matrix size in pixels.
 
int MaxLineFilterSize [get, set]
 Maximum line filter size in pixels.
 
int MaxModuleSize [get, set]
 Maximum module size in pixels.
 
int MaxNumModules [get, set]
 Maximum number of data matrix column modules.
 
- Properties inherited from ConfigBase
virtual bool IsEnabled [get, set]
 The enabled state of this symbology.
 
Decoder Decoder [get]
 Decoder this config belongs to.
 

Detailed Description

Configuration for Data Matrix codes.

For additional details on configuration including a code example, refer to the GetConfig<T>() method in the Decoder class.

Member Function Documentation

◆ SetMaximumSize()

DataMatrix SetMaximumSize ( int size)

Sets value for MaximumSize.

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
sizeSize in pixels.
Returns
Configuration.

◆ SetMaxLineFilterSize()

DataMatrix SetMaxLineFilterSize ( int size)

Sets value for MaxLineFilterSize.

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
sizeSize in pixel [0:36].
Returns
Configuration.

◆ SetMaxModuleSize()

DataMatrix SetMaxModuleSize ( int size)

Sets value for MaxModuleSize.

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
sizeSize in pixel.
Returns
Configuration.

◆ SetMaxNumModules()

DataMatrix SetMaxNumModules ( int number)

Sets value for MaxNumModules.

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
numberMaximum number of modules.
Returns
Configuration.

◆ SetMinimumSize()

DataMatrix SetMinimumSize ( int size)

Sets value for MinimumSize.

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
sizeSize in pixels.
Returns
Configuration.

◆ SetMirrorDecodingEnabled()

DataMatrix SetMirrorDecodingEnabled ( bool enable)

Sets value for IsMirrorDecodingEnabled .

Parameters
enableValue for IsMirrorDecodingEnabled .
Returns
Configuration.

◆ SetPolarity()

DataMatrix SetPolarity ( Polarity polarity)

Sets value for Polarity.

Parameters
polarityValue for Polarity.
Returns
Configuration.

◆ SetRectangularDecodingEnabled()

DataMatrix SetRectangularDecodingEnabled ( RectangularDecoding rectangularDecoding)

Sets value for IsRectangularDecodingEnabled.

Parameters
rectangularDecodingValue for IsRectangularDecodingEnabled.
Returns
Configuration.

Property Documentation

◆ IsMirrorDecodingEnabled

bool IsMirrorDecodingEnabled
getset

Enable/disable mirror image decoding.

When enabled, both normal and mirror images will be decoded.