Analyze Method of the FRDocument Object
This method performs the layout analysis of all pages in a document.
Syntax
C++
HRESULT Analyze( IPageAnalysisParams* AnalysisParams, IObjectsExtractionParams* ExtractionParams, IRecognizerParams* RecognizerParams );
C#
void Analyze(
IPageAnalysisParams AnalysisParams,
IObjectsExtractionParams ExtractionParams,
IRecognizerParams RecognizerParams
);
Visual Basic .NET
Sub Analyze( _ [AnalysisParams As IPageAnalysisParams = Nothing], _ [ExtractionParams As IObjectsExtractionParams = Nothing], _ [RecognizerParams As IRecognizerParams = Nothing] _ )
Parameters
- AnalysisParams
- [in] Refers to the PageAnalysisParams object that stores parameters of layout analysis of the document. This parameter may be 0. In this case, the document is analyzed with default parameters, or, if a profile has been loaded, the parameters set by this profile are used.
- ExtractionParams
- [in] Refers to the ObjectsExtractionParams object that stores parameters of objects extraction. This parameter may be 0. In this case, the objects are extracted with default parameters, or, if a profile has been loaded, the parameters set by this profile are used.
- RecognizerParams
- [in] Refers to the RecognizerParams object that stores recognition parameters necessary for layout analysis (e.g., recognition language). This parameter may be 0. In this case, the default parameters are used, or, if a profile has been loaded, the parameters set by this profile are used.
Return values
If layout analysis is interrupted by the user, this method will return E_ABORT. It also returns the standard return codes of ABBYY FineReader Engine functions.
Remarks
- Depending on the value of the IEngine::MultiProcessingParams property, ABBYY FineReader Engine can distribute layout analysis of multi-page documents to CPU cores.
- This method may report events to the listeners attached to the IConnectionPointContainer interface of the FRDocument object.
See also
17.09.2024 15:14:41