Table of Contents
Step 2: Recognition Keys
Below you can find the description of the recognition keys of the abbyyocr11 utility.
--languageDetectionMode
-
New CLI 11 R2
-
Manages automatic language detection. When language detection is on (Yes is passed to this option), the recognition language is detected for each word in the text. It is selected from the list of languages specified for the -rl option. Autodetection is intended to be used during recognition of documents the language of which is not known to you.
If you know for certain that all the languages you specified are present in the document, autodetection is useless. Turn it off by passing No to this property.
In Auto mode ABBYY FineReader Engine decides whether language detection should be performed or not.
| Key | Parameters | Default |
|---|---|---|
| -rldm | Yes No Auto |
No |
| - -languageDetectionMode | ||
--balancedMode
-
The recognition will run in balanced mode (an intermediate mode between full and fast modes, which can be activated with the help of the -fm key).
| Key | Parameters | Default |
|---|---|---|
| -rbm | no | |
| - -balancedMode | ||
--caseRecognitionMode
-
Specifies the mode of letter case recognition.
| Key | Parameters | Default |
|---|---|---|
| -rcm | AutoCase SmallCase CapitalCase |
AutoCase |
| - -caseRecognitionMode | ||
--cellsCount
-
Specifies the number of character cells for a recognised block. This key is valid only for the handprint recognition. It has a sense only for the field marking types (-rfmt key) that imply splitting the text in cells.
| Key | Parameters | Default |
|---|---|---|
| -rcc | the number of character cells for a recognised block | 1 |
| - -cellsCount | ||
--disableSecondStageRecognizer
-
No second-stage recognition will be performed.
| Key | Parameters | Default |
|---|---|---|
| -rdss | no | |
| - -disableSecondStageRecognizer | ||
--errorHighlightLevel
-
Specifies the level at which the ICharParams::IsSuspicious property is set to TRUE for a recognised character.
| Key | Parameters | Default |
|---|---|---|
| -rehl | None Scanty Standard Thorough AllText |
Standard |
| - -errorHighlightLevel | ||
--exactConfidenceCalculation
-
Character confidence will be defined more accurately, but recognition speed may get slower.
| Key | Parameters | Default |
|---|---|---|
| -recc | no | |
| - -exactConfidenceCalculation | ||
--fastMode
-
Provides 2-2,5 times faster recognition speed at the cost of moderate increased error rate (1,5-2 times more errors). For text printed with good quality ABBYY FineReader Engine makes 1-2 errors per page on average. The increase of errors can be easily eliminated by using various scenarios, e.g. the full text indexing with “fuzzy” search, preliminary recognition, etc.
| Key | Parameters | Default |
|---|---|---|
| -fm | no | |
| - -fastMode | ||
--fieldMarkingType
-
This property specifies the type of marking around letters (for example, underline, frame, box and etc.).
| Key | Parameters | Default |
|---|---|---|
| -rfmt | SimpleText UnderlinedText TextInFrame GreyBoxes CharBoxSeries SimpleComb CombInFrame PartitionedFrame |
SimpleText |
| - -fieldMarkingType | ||
--oneLinePerTextCell
-
Presumes that the text in the block to which the current RecognizerParams object corresponds contains no more than one string.
| Key | Parameters | Default |
|---|---|---|
| -tol | no | |
| - -oneLinePerTextCell | ||
--oneWordPerLine
-
Presumes that no text line may contain more than one word, so the lines of text will be recognised as a single word.
| Key | Parameters | Default |
|---|---|---|
| -rowl | no | |
| - -oneWordPerLine | ||
-- --TextTypes
-
Update CLI 11 R1
-
Presumes that the text to recognize is of one of the types the collection contains..
-
The Handprinted constant is unavailable in FineReader Engine for Linux.
| Key | Parameters | Default |
|---|---|---|
| -rtt | Space-separated combination of the following constants: Normal Typewriter Matrix Index OCR_A OCR_B MICR_E13B MICR_CMC7 Gothic 1) Receipt |
Normal |
| - -TextTypes | ||
--prohibitHyphenation
-
Prohibits recognition of hyphenation from line to line.
| Key | Parameters | Default |
|---|---|---|
| -rphp | no | |
| - -prohibitHyphenation | ||
--prohibitInterblockHyphenation
-
Presumes that text from one block can't be carried over to the next block.
| Key | Parameters | Default |
|---|---|---|
| -rpihp | no | |
| - -prohibitInterblockHyphenation | ||
--prohibitItalic
-
Prohibits recognition of letters printed with italic-styled font.
| Key | Parameters | Default |
|---|---|---|
| -rpi | no | |
| - -prohibitItalic | ||
--prohibitSubscript
-
Prohibits recognition of subscript letters.
| Key | Parameters | Default |
|---|---|---|
| -rpsub | no | |
| - -prohibitSubscript | ||
--prohibitSuperscript
-
Prohibits recognition of superscript letters.
| Key | Parameters | Default |
|---|---|---|
| -rpsup | no | |
| - -prohibitSuperscript | ||
--saveCharacterRecognitionVariants
-
Specifies whether the variants of a character's recognition are saved.
| Key | Parameters | Default |
|---|---|---|
| -rscrv | no | |
| - -saveCharacterRecognitionVariants | ||
--saveWordRecognitionVariants
-
Specifies whether the variants of a word's recognition are saved.
| Key | Parameters | Default |
|---|---|---|
| -rswrv | no | |
| - -saveWordRecognitionVariants | ||
--recognitionLanguage
-
Sets the recognition language(s) which should be present in the list of the predefined ABBYY FineReader Engine languages and/or in the /UserLanguages directory.
| Key | Parameters | Default |
|---|---|---|
| -rl |
list of recognition languages or and/or user languages (see blow) |
English |
| - -recognitionLanguage | ||
--userPatternsFile
-
This key sets the path to the user patterns file used for recognition.
-
Note: User patterns can be created using ABBYY FineReader Engine 11 (for Linux or Windows) or the Desktop - FineReader 12 Professional 12 on Windows – [[http://finereader.abbyy.com/professional/|Free Trial on abbyy.com)).
| Key | Parameters | Default |
|---|---|---|
| -upf | user patterns file name | |
| - -userPatternsFile | ||
--doNotUseBuiltInPatterns
-
When -dnubp key is not used, the ABBYY OCR 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 use this key when you do not want to use standard built-in 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.
-
Please note that when -dnubp key is used, the path to the user-defined patterns file should be specified with the -upf key as only information stored in this file will be used. If the path to the user patterns file is not specified, used -dnubp key is ignored so built-in patterns are used for recognition.
| Key | Parameters | Default |
|---|---|---|
| -dnubp | no | |
| - -doNotUseBuiltInPatterns | ||
-
Note. Full keys are marked by italic.
1) not incl. in the license per default