PageProcessingParams Object (IPageProcessingParams Interface)
This object is used for tuning different parameters of page preprocessing, layout analysis, recognition, and page synthesis. It comprises child objects of PagePreprocessingParams, PageAnalysisParams, ObjectsExtractionParams, RecognizerParams, and SynthesisParamsForPage types that are available through the corresponding properties. A pointer to this object is passed to different processing methods along with other parameters.
The PageProcessingParams object is a persistent object. This means that the object's current state can be written to persistent storage: an area in the global memory or a disk file. Later, the object can be re-created by reading the object's state from persistent storage. The following methods provide persistence of the object: SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.
Properties
| Name | Type | Description |
|---|---|---|
| Application | Engine, read-only | Returns the Engine object. |
| Preprocessing settings | ||
| PerformPreprocessing | VARIANT_BOOL |
Specifies if page preprocessing is to be performed. Page preprocessing is performed before page analysis and includes correction of orientation, inversion, geometrical distortions. If this property is FALSE, the PagePreprocessingParams property is ignored. This property is TRUE by default. |
| PagePreprocessingParams | PagePreprocessingParams |
Provides access to the subset of page processing parameters that affect the process of page preprocessing. Page preprocessing is performed before page analysis and includes correction of orientation, inversion, geometrical distortions. These parameters are ignored, if the value of the PerformPreprocessing property is FALSE. |
| ProhibitColorObjectsAtProcessing | VARIANT_BOOL |
Specifies if color objects must be filtered out on the image before layout analysis and recognition. If this property is set to FALSE, the ColorObjectsProhibitingParams property is ignored. The default value of this property is FALSE. |
| ColorObjectsProhibitingParams | ColorObjectsProhibitingParams, read-only |
Provides access to the parameters of color objects filtering. The parameters are only taken into account if the ProhibitColorObjectsAtProcessing is set to TRUE. |
| Analysis and objects extraction settings | ||
| PerformAnalysis | VARIANT_BOOL |
Specifies if page analysis is to be performed. If this property is FALSE, the PageAnalysisParams property is ignored. This property is TRUE by default.
|
| PageAnalysisParams | PageAnalysisParams |
Provides access to the subset of page processing parameters that affect the process of page analysis. These parameters are ignored, if the value of the PerformAnalysis property is FALSE. |
| ObjectsExtractionParams | ObjectsExtractionParams | Provides access to the subset of page processing parameters that affect extraction of objects. |
| Recognition and page synthesis settings | ||
| PerformRecognition | VARIANT_BOOL |
Specifies if recognition is to be performed. If this property is FALSE, the RecognizerParams property is ignored. This property is TRUE by default.
|
| RecognizerParams | RecognizerParams | Provides access to the subset of page processing parameters that affect the process of page recognition. |
| SynthesisParamsForPage | SynthesisParamsForPage | Provides access to the subset of page processing parameters that affect the process of page synthesis. |
Methods
| Name | Description |
|---|---|
| CopyFrom | Initializes properties of the current object with values of similar properties of another object. |
| LoadFromFile | Restores the object contents from a file on disk. |
| LoadFromMemory | Restores the object contents from the global memory. |
| SaveToFile | Saves the object contents into a file on disk. |
| SaveToMemory | Saves the object contents into the global memory. |
Related objects
Output parameter
This object is the output parameter of the CreatePageProcessingParams method of the Engine object.
Input parameter
This object is passed as an input parameter to the following methods:
- PreprocessAnalyzeRecognize method of the FRPage object
- Start, ProcessPageAsync methods of the BatchProcessor object
Samples
C# code
The object is used in the following code samples: CustomLanguage, CommandLineInterface; and demo tools: BatchProcessingRecognition, Camera OCR, Image Preprocessing, MultiProcessingRecognition, PDFExportProfiles, User Pattern Training Utility.
See also
Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis
17.09.2024 15:14:41