OCRParams Class Documentation

class OCRParams : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Parameters for configuring the OCR (Optical Character Recognition) engine.

OCRParams controls settings such as the engine to use, the resolution of the input images, the language(s) to recognize, performance tuning, page segmentation mode, candidate font names for placing text, and image preprocessing options.

Referenced by

Constructor & Destructor Documentation

OCRParams

OCRParams()

Create an OCRParams structure with defaults.

Property Documentation

CandidateFontNames

System.Collections.Generic.IList< System.String > CandidateFontNames[get, set]

The names of candidate fonts for placing text under an image.

The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on this object.

Enough font names must be supplied to cover the expected languages/scripts in use.

The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals.

The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro.

If the PlaceTextUnder method in OCREngine can't identify a font that covers the whole text of a word, an exception will be thrown.

ConfigurationParameters

System.Collections.Generic.IDictionary< System.String, System.String > ConfigurationParameters[get, set]

Get the configuration parameters.

Note: Reserved for internal use. Do not use unless directed to by Datalogics Support.

EnableImagePreprocessing

bool EnableImagePreprocessing[get, set]

Get the image preprocessing enable state. True if any image preprocessing is on.

Engine

string Engine[get, set]

The name of the OCR engine to use.

Use the Tesseract4Engine constant to select the Tesseract v4 engine.

Languages

System.Collections.Generic.IList< LanguageSetting > Languages[get, set]

The list of languages the OCR engine should recognize.

PageSegmentationMode

PageSegmentationMode PageSegmentationMode[get, set]

The page segmentation mode, which controls how the OCR engine detects text regions on the page.

Performance

Performance Performance[get, set]

The desired performance mode for the OCR engine, balancing speed versus accuracy.

Resolution

double Resolution[get, set]

The resolution, in DPI, at which images are rendered for OCR processing.

Tesseract4Engine

static string Tesseract4Engine[get]

Member Function Documentation

Dispose

void Dispose()

Returns:

void