IBaseOCRExtractor InterfaceByteScout PDF Extractor SDK
Defines a base interface for PDF text extractors.

Namespace:  Bytescout.PDFExtractor
Assembly:  Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version:

public interface IBaseOCRExtractor

The IBaseOCRExtractor type exposes the following members.


Public propertyOCRAutoModeMinExistingTextLength
Applies to OCRMode.Auto only: Min total length of existing text on current page to decide if OCR should be run or not. If the length of text is lesser than this property then library runs OCR for this page. Otherwise it extracts the existing text only.
Public propertyOCRBlackList
OCRBlackList property allows to define a list of characters not allowed to be recognized from scanned document. The resulting text will only contain characters that are not in this list.
Public propertyOCRCacheMode
OCR results caching behaviour. Turned off by default (no cache is used). In "WholePage" caching mode you may save processing time as the SDK will check if need to re-run OCR on the page or can just pull results from previously cached OCR results.
Public propertyOCRCorrections
Collection of corrections automatically applied to recognized text to fix repeating recognition errors.
Public propertyOCRDetectPageRotation
Gets or sets whether to detect scanned page rotation. Slightly slows down the processing time.
Public propertyOCRImagePreprocessingFilters
Collection of image processing filters applied to the document page before Optical Character Recognition (OCR). May improve the recognition quality.
Public propertyOCRLanguage
Language for Optical Character Recognition (OCR). The valid values are:
  • "eng" - English (default)
  • "deu" - German
  • "fra" - French
  • "spa" - Spanish

Download more languages at https://github.com/bytescout/ocrdata.

Public propertyOCRLanguageDataFolder
Folder containing OCR language data files.
Public propertyOCRMaximizeCPUUtilization
Gets or sets maximum OCR performance using Intel OpenMP (if available) to accelerate to approximately 30%. Default is false.
Public propertyOCRMode
Enables Optical Character Recognition (OCR) to recognize text from embedded images. Set the language using OCRLanguage property.

This option requires Bytescout.PDFExtractor.OCRExtension.dll assembly and appropriate language files in OCRLanguageDataFolder folder. The SDK is shipped with language files for English, French, German and Spanish. You can download more languages at https://github.com/bytescout/ocrdata.

Public propertyOCROverallConfidence
Gets overall OCR confidence. This value is calculated after the extraction is performed.
Public propertyOCRResolution
Resolution of Optical Character Recognition (OCR). Default is 300 DPI.
Public propertyOCRWhiteList
OCRWhiteList property allows to define a list of characters allowed to be recognized from scanned document. Only characters from this list will appear in the result text.

Public methodIsOCRRecommendedForPage
Detects whether OCR is recommended for specified page. OCR (Optical Character Recognition) is recommended when pages has no text objects bat has an image that might contain text.
See Also