OCRParams Class Documentation

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.

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

The name of the OCR engine to use.

Use the Tesseract4Engine constant to select the Tesseract v4 engine.

The list of languages the OCR engine should recognize.

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

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

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

Copy assignment.

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.

Enable all image preprocessing, default enabled. Note that once the OCREngine is initialized, this setting is permanent.

The name of the OCR engine to use.

Use the Tesseract4Engine constant to select the Tesseract v4 engine.

The list of languages the OCR engine should recognize.

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

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

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