Skip to main content
This object allows you to tune the recognition parameters. Each text block and table cell in layout has its own child object of the RecognizerParams type. Besides, this object is passed as a subobject of the PageProcessingParams object into ABBYY FineReader Engine layout analysis-recognition functions. Recognition functions use parameters of recognition defined by text blocks’ and table cells’ child objects of the type RecognizerParams. Whenever a text block or table cell is created during layout analysis, properties of its child object of the RecognizerParams type are initialized with values of properties of the RecognizedParams object that was passed to analysis function. Properties of a subobject of the block which is created using the AddNew method of the LayoutBlocks object are set to reasonable defaults. To know about the default value of this or that property see its description. The RecognizerParams object is a persistent object. This means that the object’s current state can be written to persistent storage. Later, the object can be re-created by reading the object’s state from the persistent storage. The following methods provide persistence of the object: Linux: SaveToFile, and LoadFromFile Windows SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.

​
Properties

Name

Type

Description

Application

Engine, read-only

Returns the Engine object.

Main settings

TextLanguage

TextLanguage

Specifies the language to be used for recognition. This property can be easily set via the SetPredefinedTextLanguage method.

The property returns a constant object. To change the recognition language, you must at first obtain an intermediate TextLanguage object using an appropriate creation method, change the necessary parameters, and then assign the obtained object to the property.

By default, this parameter is initialized with English language.

LanguageDetectionMode

ThreeStatePropertyValueEnum

Manages automatic language detection.

When language autodetection is on, the recognition language is detected for each word in the text. It is selected from the list of languages specified in the TextLanguage property. Autodetection is intended to be used during recognition of documents the language of which is not known to you.

Language autodetection deals only with the predefined languages (see the full list in Predefined Languages in ABBYY FineReader Engine).

If you know for certain that all the languages you specified are present in the document, autodetection is useless. Turn it off by setting this property to TSPV_No.

You can view the list of languages detected in the recognized document or recognized page using the DetectedLanguages property of the FRDocument or FRPage object.

By default, this property value is TSPV_Auto.

TextTypes

int

The value of this property is an OR superposition of the TextTypeEnum enumeration constants which denote possible text types used for recognition. For example, if it is set to TT_Normal | TT_Index, ABBYY FineReader Engine will presume that the text contains only common typographic text and digits written in ZIP-code style, ignoring all other variants. See also Using Text Type Autodetection.

Notes:

  • If this property is equal to any combination of TT_Matrix, TT_Typewriter, TT_OCR_A, and TT_OCR_B, italic fonts and superscript/subscript will not be recognized, regardless of the values of the ProhibitItalic, ProhibitSubscript and ProhibitSuperscript properties.
  • If this property is TT_Handwritten, the orientation of the image cannot be corrected.
  • In Windows:
    • if this property is set to TT_Handwritten or TT_Index, the TrainUserPatterns property cannot be set to TRUE.
    • if the TrainUserPatterns property is set to TRUE, the TextTypes property must contain only one text type.

By default, this property is set to TT_Normal.

DetectTextTypesIndependently

VARIANT_BOOL

Indicates that text type should be determined for each text block separately. This setting is useful when you have comparatively small text blocks with different text types, although it may slightly slow down processing.

The default value of this property is FALSE.

Recognition speed

Mode

RecognitionModeEnum

Specifies the recognition mode to be applied to the target documents. Each mode provides its own level of recognition speed and accuracy to get satisfying results on images and documents with various peculiarities.

By default, this property is set to RM_Normal.

Built-in patterns are always used for the accurate mode. To disable using the built-in patterns, switch to the normal mode (RM_Normal).

Fine tuning

LowResolutionMode

VARIANT_BOOL

Specifies whether a text on an image with low resolution is recognized. This property is useful when recognizing faxes, small prints, images with low resolution or bad print quality.

By default, the value of this property is FALSE.

OneLinePerBlock

VARIANT_BOOL

This property set to TRUE tells ABBYY FineReader Engine to presume that the text in block to which the current RecognizerParams object belongs contains no more than one string.

By default, this property is FALSE.

OneWordPerLine

VARIANT_BOOL

This property set to TRUE tells ABBYY FineReader Engine to presume that no text line may contain more than one word, so the lines of text will be recognized as a single word.

By default, this property is FALSE.

ProhibitItalic

VARIANT_BOOL

This property set to TRUE tells ABBYY FineReader Engine not to recognize letters printed with italic-styled font. It is useful when a text with presumably no italic letters is recognized, in which case it may speed up the recognition. If there exist any italic letters on the image, and this property is TRUE, these letters will be recognized incorrectly.

By default, this property is FALSE.

ProhibitSubscript

VARIANT_BOOL

This property set to TRUE tells ABBYY FineReader Engine not to recognize subscript letters. It is useful when a text with presumably no subscripts is recognized, in which case it may speed up the recognition. If there exist any subscript letters on the image, and this property is TRUE, these letters will be recognized incorrectly.

By default, this property is FALSE.

ProhibitSuperscript

VARIANT_BOOL

This property set to TRUE tells ABBYY FineReader Engine not to recognize superscript letters. It is useful when a text with presumably no superscripts is recognized, in which case it may speed up the recognition. If there exist any superscript letters on the image, and this property is TRUE, these letters will be recognized incorrectly.

By default, this property is FALSE.

ProhibitHyphenation

VARIANT_BOOL

This property set to TRUE prohibits recognition of hyphenation from line to line. It is useful when a text with presumably no hyphenations is recognized, in which case it may speed up the recognition. If there exist any hyphenations in the recognized block, and this property is TRUE, the hyphenated words will be recognized incorrectly.

By default, this property is FALSE.

ProhibitSmallCaps

VARIANT_BOOL

This property set to TRUE tells ABBYY FineReader Engine not to recognize small capitals.

By default, this property is FALSE.

ProhibitInterblockHyphenation

VARIANT_BOOL

This property set to TRUE tells ABBYY FineReader Engine to presume that text from one block cannot be carried over to the next block.

By default, this property is FALSE.

CaseRecognitionMode

CaseRecognitionModeEnum

This property specifies the mode of letter case recognition.

By default, the value of this property is CRM_AutoCase, which corresponds to automatic case recognition.

FieldMarkingType

FieldMarkingTypeEnum

This property specifies the type of marking around letters (for example, underline, frame, box, etc.).

For marking types where each letter is in a separate cell please use CellsCount property to set the number of character cells for a recognized block.

By default, the value of this property is FMT_SimpleText, which means no marking.

CellsCount

int

Specifies the number of character cells in the block.

It makes sense only for the field marking types (the FieldMarkingType property) in which every letter is written in a separate cell.

Default value for this property is 1, but you should set the appropriate value to recognize the text correctly.

User patterns

TrainUserPatterns

Windows only.

VARIANT_BOOL

This property specifies whether user patterns should be trained during the recognition. The Pattern Training dialog box will be displayed during recognition.

For correct operation of pattern training process it is necessary to:

  • set the value of the parent window HWND handle (IEngine::ParentWindow property)
  • specify some user pattern file in the UserPatternsFile property

See also Recognizing with Training.

If this property is set to TRUE:

  • the TextTypes property must contain only one text type, and this text type cannot be TT_Handwritten or TT_Index
  • the CorrectOrientation property of the PagePreprocessingParams object cannot be set to TRUE
Pattern training is not supported for Chinese, Japanese, and Korean languages.

By default, this property is FALSE.

UseBuiltInPatterns

VARIANT_BOOL

This property set to TRUE means that ABBYY FineReader Engine will use its own built-in patterns for recognition. Patterns are files establishing relationship between character image and character itself. You may want to set this property to FALSE when you do not want to use standard ABBYY FineReader Engine patterns for character recognition, but user patterns only. This may be useful for recognition of text typed with decorative or non-standard fonts. In this case, it is better not to use ABBYY FineReader Engine built-in patterns but use your own user-defined patterns trained for these fonts.

A path to user-defined pattern file is stored in the UserPatternsFile property. If the UserPatternsFile property is empty the UseBuiltInPatterns property is ignored. For Windows, see also Recognizing with Training.

By default, this property is TRUE.

You may set this property to FALSE in case of using the normal and fast recognition modes. You cannot prohibit using the built-in patterns for the accurate mode (see description of the Mode property).

UserPatternsFile

BSTR

Contains the full path to a file of the user pattern used for recognition. If the value of this property is not empty, information from the user pattern file will be used during recognition.

If the UseBuiltInPatterns property is FALSE, which means that standard ABBYY FineReader Engine patterns are not used during recognition, this property should contain a path to user-defined pattern file, as only information stored in it will be used. For Windows, see also Recognizing with Training.

By default, this property stores an empty string.

User pattern files created in ABBYY FineReader Engine 10 or earlier cannot be opened in FineReader Engine 12 Release 6 or later. To continue using them, save older user pattern files in the new format:
  • Use FineReader Engine 11 or FineReader Engine 12 Release 5 or earlier.
  • Call the MergePatterns method of the Engine object, passing in a string collection with the name of older pattern file and a full path to new file.

Additional recognition information

HighlightSuspiciousCharacters

VARIANT_BOOL

Specifies if uncertainly recognized characters should be have the IsSuspicious property set to TRUE.

The name of the property reflects the fact that ABBYY FineReader highlights suspicious characters in text with background color, which makes manual verification easier for the operator.

By default, this property is TRUE.

ExactConfidenceCalculation

VARIANT_BOOL

This property is deprecated and will be deleted in future versions.

SaveCharacterRegions

VARIANT_BOOL

Specifies whether the exact characters regions (ICharParams::CharacterRegion) are saved.

The default value is FALSE.

SaveCharacterRecognitionVariants

VARIANT_BOOL

Specifies whether the variants of characters recognition are saved.

The ICharParams::CharacterRecognitionVariants property returns a collection of recognition variants for a character. See also Using Voting API.

The default value is FALSE.

SaveWordRecognitionVariants

VARIANT_BOOL

Specifies whether the variants of recognition of a word are saved.

The IParagraph::GetWordRecognitionVariants method and ICharParams::WordRecognitionVariants property return a collection of recognition variants for a word. See also Using Voting API.

The default value is FALSE.

​
Methods

NameDescription
CopyFromInitializes properties of the current object with values of similar properties of another object.
LoadFromFileRestores the object contents from a file on disk.
LoadFromMemory <Note> Windows only. </Note>Restores the object contents from the global memory.
SaveToFileSaves the object contents into a file on disk.
SaveToMemory <Note> Windows only. </Note>Saves the object contents into the global memory.
SetPredefinedTextLanguageSets the language of recognition to be one of the predefined ABBYY FineReader Engine languages.
RecognizerParams Object Diagram

​
Output parameter

This object is the output parameter of the CreateRecognizerParams method of the Engine object.

​
Input parameter

This object is passed as an input parameter to the following methods:

​
Samples

FREngine.IEngine engine;
string fileName;
// Train user pattern during recognition
FREngine.IDocumentProcessingParams processingParams = Engine.CreateDocumentProcessingParams();
FREngine.IRecognizerParams recognizerParams = processingParams.PageProcessingParams.RecognizerParams;
Engine.CreateEmptyUserPattern( fileName );
Engine.MultiProcessingParams.MultiProcessingMode = FREngine.MultiProcessingModeEnum.MPM_Sequential;
recognizerParams.UserPatternsFile = fileName;
recognizerParams.TrainUserPatterns = true;
Document.Process(processingParams);
The object is used in the following code samples:

​
See also

Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis Recognizing Handwritten Texts PageProcessingParams TextBlock Working with Properties