Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

TextFilterModes

TextFilterModes is a parameter to control how to filter texts on an image. It consisits of one or more modes, each mode represents a way to implement the filtering.

Candidate Mode List

TFM_GENERAL_CONTOUR

TFM_GENERAL_CONTOUR

Filters text using the general algorithm based on contour. This mode has the following arguments for further customizing.

MinImageDimension
Sensitivity
LibraryFileName
LibraryParameters

Setting Methods

As `PublicRuntimeSettings` Member

TextFilterModes can be set dynamically during runtime as a member of FurtherModes, which is a member of PublicRuntimeSettings struct, it is an array with 8 TextFilterMode Enumeration items.

Code Snippet in C++

//...other codes
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->textFilterModes[0] = TFM_GENERAL_CONTOUR;
reader->UpdateRuntimeSettings(pSettings);
reader->SetModeArgument("TextFilterModes", 0, "Sensitivity", "5");
delete pSettings;
//...other codes

Remarks
GetModeArgument and SetModeArgument need to be called for getting and setting Arguments.

See Also

FurtherModes: C | C++ | .NET | Java | Java-Android | Objective-C & Swift
PublicRuntimeSettings: JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & Swift
TextFilterMode Enumeration
GetModeArgument: JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & Swift
SetModeArgument: JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & Swift

As JSON Parameter

TextFilterModes as a JSON parameter is a JSON Object array. Each JSON object is defined as below.

Key Name	Key Value	Description
Mode	Any one in Candidate Mode List as string	(Required) Specifies a mode for text filtering.
MinImageDimension	A number from value range of MinImageDimension	(Optional) Sets the Argument MinImageDimension.
Sensitivity	A number from value range of Sensitivity	(Optional) Sets the Argument Sensitivity.
LibraryFileName	A string from value range of LibraryFileName	(Optional) Sets the Argument LibraryFileName.
LibraryParameters	A string from value range of LibraryFileName	(Optional) Sets the Argument LibraryFileName.

JSON Parameter Example

{
    "TextFilterModes": [
        {
            "Mode": "TFM_GENERAL_CONTOUR", 
            "Sensitivity": 5
        }
    ]
}

Impacts on Performance

Speed

To detect barcodes surrounded by a large number of irrelevant characters, enabling text filtering may improve the Speed. However, enabling text filtering may slow down the Speed when barcodes are the only content of the image.

Read Rate

TextFilterModes has no influence on the Read Rate.

Accuracy

For barcodes surrounded by a large number of irrelevant characters, enabling text filtering may improve the Accuracy.

MinImageDimension

Sets the minimum image dimension (in pixels) to enable text filtering.

Value Type	Value Range	Default Value	Valid For
int	[65536, 0x7fffffff]	65536	TFM_GENERAL_CONTOUR

Remarks
The library will enable the region pre-detection feature only when the image dimension is larger than the given value.

Sensitivity

Sets the sensitivity used for text filtering.

Value Type	Value Range	Default Value	Valid For
int	[0, 9]	0	TFM_GENERAL_CONTOUR

Remarks

0: automatically set by the library.
A larger value means the library will take more effort to filter text.

LibraryFileName

Sets the file name of the library to load dynamically.

Value Type	Value Range	Default Value	Valid For
string	A string value representing file name.	””	All modes

Remarks
The library must be in the same place with Dynamsoft Barcode Reader Library.

LibraryParameters

Sets the parameters passed to the library to load dynamically.

Value Type	Value Range	Default Value	Valid For
string	A string value representing parameters.	””	All modes