Preprocess Method of the FRPage Object

Preprocess method of the FRPage Object in the ABBYY FineReader Engine API — Preprocesses the page (corrects orientation, inversion, geometrical distortions) before page analysis.

This method preprocesses the page: corrects page orientation, inversion, geometrical distortions. Page preprocessing is performed before page analysis.

Syntax

C++

HRESULT Preprocess(
  IPagePreprocessingParams* PreprocessingParams,
  IObjectsExtractionParams* ExtractionParams,
  IRecognizerParams*        RecognizerParams
);

C#

void Preprocess(
  IPagePreprocessingParams PreprocessingParams,
  IObjectsExtractionParams ExtractionParams,
  IRecognizerParams        RecognizerParams
);

Visual Basic .NET

Sub Preprocess( _
  [PreprocessingParams As IPagePreprocessingParams = Nothing], _
  [ExtractionParams As IObjectsExtractionParams = Nothing], _
  [RecognizerParams As IRecognizerParams = Nothing] _
)

Parameters

PreprocessingParams

[in] Refers to the PagePreprocessingParams object that stores parameters of page preprocessing. This parameter may be 0. In this case, the page is preprocessed 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 page preprocessing (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 page preprocessing is interrupted by the user, this method will return E_ABORT. It also returns the standard return codes of ABBYY FineReader Engine functions.

Remarks

This method may report events to the listeners attached to the IConnectionPointContainer interface of the FRPage object.

See also

FRPage

Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis

Working with Profiles