Return to previous page Explore PDF Extractor SDK

OCRAnalyzer Class

Free Trial Web API version Licensing Request A Quote

HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM

Represents OCR Analyzer. It is designed for analysis of scanned documents in PDF or raster image formats to find best parameters for Optical Character Recognition (OCR) that provide highest recognition quality.

Inheritance Hierarchy

SystemObject
Bytescout.PDFExtractorBaseExtractor
Bytescout.PDFExtractorOCRAnalyzer

Namespace:Bytescout.PDFExtractor
Assembly: Bytescout.PDFExtractor (in Bytescout.PDFExtractor.dll) Version: 13.4.0.4760-master

Syntax

C++

Copy

public class OCRAnalyzer : BaseExtractor, 
	IOCRAnalyzer, IBaseExtractor, IDisposable

Public Class OCRAnalyzer
	Inherits BaseExtractor
	Implements IOCRAnalyzer, IBaseExtractor, IDisposable

public ref class OCRAnalyzer : public BaseExtractor, 
	IOCRAnalyzer, IBaseExtractor, IDisposable

type OCRAnalyzer =  
    class
        inherit BaseExtractor
        interface IOCRAnalyzer
        interface IBaseExtractor
        interface IDisposable
    end

The OCRAnalyzer type exposes the following members.

Constructors

	Name	Description
	OCRAnalyzer	Default constructor.
	OCRAnalyzer(String, String)	Initializes a new instance of the extractor class.

Top

Properties

	Name	Description
	CheckPermissions	Defines whether to respect permissions set by document owner. If True, extractor throws exception when the extraction is prohibited. IMPORTANT: THIS OPTION HAVE TO BE ENABLED AND SET TO "TRUE" TO RESPECT OWNERS OF PDF DOCUMENTS. IF YOU SET IT TO FALSE TO IGNORE PERMISSIONS WHICH ARE SET IN PDF DOCUMENT THEN YOU ARE SOLELY LIABLE FOR THIS ACTION AND ANY COPYRIGHT OR OTHER VIOLATIONS AT YOUR OWN RISK. BYTESCOUT IS NOT LIABLE FOR ANY DAMAGES, LOSSES, COPYRIGHT INFRINGEMENTS OR ANY OTHER CONSEQUENCES CAUSED BY IGNORING PERMISSIONS OF PDF DOCUMENT. BY CHANGING THIS OPTION YOU ARE CONFIRMING YOU ARE UNDERSTANDING ALL WRITTEN ABOVE AND DOING IT AT YOUR OWN RISK. (Inherited from BaseExtractor.)
	ComHelpers	Set of utility functions and properties to use from COM/ActiveX. (Inherited from BaseExtractor.)
	ContentType	Returns content type of PDF document: normal document, portfolio or XFA form. To extract files from PDF portfolio use AttachmentExtractor class. To extract XFA form content use XFAFormExtractor class. (Inherited from BaseExtractor.)
	EmbeddedFileCount	Obsolete. Property is disabled to speed up the document loading. Use AttachmentExtractor to work with attachments. (Inherited from BaseExtractor.)
	Encrypted	Gets whether the document is encrypted. (Inherited from BaseExtractor.)
	ExtractionArea	Sets the extraction area by coordinates and dimensions (left, top, width, height). (Inherited from BaseExtractor.)
	ExtractionAreaRect	Sets the extraction area by rectangle. (Inherited from BaseExtractor.)
	ExtractionAreaUsageMode	Gets or sets how to use the ExtractionArea: whether to extract any object intersecting with the area or only objects completely located inside the area. (Inherited from BaseExtractor.)
	IsDocumentLoaded	Get the document loaded state. (Inherited from BaseExtractor.)
	LicenseInfo	Gets license information. (Inherited from BaseExtractor.)
	OCRDetectPageRotation	Detect scanned page rotation. Slightly slows down the processing time.
	OCRLanguage	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.
	OCRLanguageDataFolder	Folder containing OCR language data files.
	OCRMaximizeCPUUtilization	Gets or sets maximum OCR performance using Intel OpenMP (if available) to accelerate to approximately 30%. Default is false.
	OCRResolution	Resolution of Optical Character Recognition (OCR). Default is 300 DPI.
	PageDataCaching	Controls page data caching behavior. (Inherited from BaseExtractor.)
	Password	PDF document password. (Inherited from BaseExtractor.)
	Profiles	Comma-separated list of profiles to apply to the extractor. Profiles must be previously loaded. (Inherited from BaseExtractor.)
	RegistrationKey	Registration key. (Inherited from BaseExtractor.)
	RegistrationName	Registration name. (Inherited from BaseExtractor.)
	Version	Gets the component version number. (Inherited from BaseExtractor.)

Top

Methods

	Name	Description
	AnalyzeByOCRConfidence	Performs OCR analysis on the specified document page. You can use SetExtractionArea(RectangleF) method to limit the analysis by the rectangular area of the page.
	ApplyResults(OCRAnalysisResults, BaseTextExtractor)	Applies analysis results to extractors supporting OCR: TextExtractor, CSVExtractor,XMLExtractor, JSONExtractor, XLSExtractor.
	ApplyResults(OCRAnalysisResults, SearchablePDFMaker)	Applies analysis results to SearchablePDFMaker objects.
	CreateProfile(String, Boolean, Boolean, Boolean)	Creates JSON profile will all extractor properties with current values. (Inherited from BaseExtractor.)
	CreateProfile(String, String, Boolean, Boolean, Boolean)	Creates JSON profile will all extractor properties with current values. (Inherited from BaseExtractor.)
	Dispose	Releases the unmanaged resources used by the instance and optionally releases the managed resources. (Inherited from BaseExtractor.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FireParsingError	(Inherited from BaseExtractor.)
	FireProgressChanged(String, Double)
	FireProgressChanged(OngoingOperation, Double, Boolean)	(Inherited from BaseExtractor.)
	GetHashCode	(Inherited from Object.)
	GetPageCount	Returns document page count. (Inherited from BaseExtractor.)
	GetPageRect_Height	Gets the specified page height. (Inherited from BaseExtractor.)
	GetPageRect_Left	Gets the specified page left coordinate. (Inherited from BaseExtractor.)
	GetPageRect_Top	Gets the specified page top coordinate. (Inherited from BaseExtractor.)
	GetPageRect_Width	Gets the specified page width. (Inherited from BaseExtractor.)
	GetPageRectangle(Int32)	Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseExtractor.)
	GetPageRectangle(Int32, Boolean)	Gets the page rectangle in PDF Points (1 Point = 1/72 in.). (Inherited from BaseExtractor.)
	GetPageRotationAngle	Returns the rotation angle of specified page. (Inherited from BaseExtractor.)
	GetType	(Inherited from Object.)
	IsEncrypted	Gets the document encrypted state. (Inherited from BaseExtractor.)
	LoadAndApplyProfiles	Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction. (Inherited from BaseExtractor.)
	LoadDocumentFromFile	Loads PDF document from specified file. (Inherited from BaseExtractor.)
	LoadDocumentFromStream	Loads PDF document from provided stream. (Inherited from BaseExtractor.)
	LoadDocumentFromVariant	Loads PDF document from byte array presented as array of Variant or Byte objects ('Variant()' or 'Byte()'). This is COM/ActiveX-compatible version of the method LoadDocumentFromStream(Stream) for in-memory processing of PDF files. (Inherited from BaseExtractor.)
	LoadProfiles	Loads profiles from JSON file. (Inherited from BaseExtractor.)
	LoadProfilesFromString	Loads profiles from JSON string. (Inherited from BaseExtractor.)
	MemberwiseClone	(Inherited from Object.)
	Reset	Resets the instance, disposes internal resources and releases the file. Use this method before loading another PDF file. (Overrides BaseExtractorReset.)
	ResetExtractionArea	Resets the extraction area to the full page. (Inherited from BaseExtractor.)
	SetExtractionArea(RectangleF)	Sets the extraction area by rectangle. (Inherited from BaseExtractor.)
	SetExtractionArea(Double, Double, Double, Double)	Sets the extraction area by coordinates and dimensions. (Inherited from BaseExtractor.)
	SetExtractionArea(Single, Single, Single, Single)	Sets the extraction area by coordinates and dimensions. (Inherited from BaseExtractor.)
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	ParsingError	Raised on PDF document parsing errors. This usually indicates a damaged document. (Inherited from BaseExtractor.)
	PasswordRequired	Occurs when the password required to decrypt the document. (Inherited from BaseExtractor.)
	ProgressChanged	Raised for each reported progress value. Allows to cancel the processing.

Top

Fields

	Name	Description
	ExtractionAreaInternal	(Inherited from BaseExtractor.)

Top

Reference

Bytescout.PDFExtractor Namespace