SynthesisParamsForPage Object (ISynthesisParamsForPage Interface)

This object is used for setting up the parameters of the page synthesis. Particularly, it allows you to specify the parameters of text and background color detection.

The SynthesisParamsForPage 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.
Main settings
BusinessCardSynthesisParams BusinessCardSynthesisParams

Specifies parameters of business card synthesis.

Important! This property must be specified when creating a recognition language in any way except the SetPredefinedTextLanguage method of the RecognizerParams object.

DetectDocumentLinks VARIANT_BOOL

If this property is set to TRUE, document references (e.g., cross-references) are detected during page synthesis.

This property is set to TRUE by default.

DetectFontFormattingAtPageLevel VARIANT_BOOL

If this property is set to TRUE, font parameters are detected at the stage of page synthesis. This property set to TRUE enables detection of subscripts, superscripts, italic-face type, small capital letters at the stage of page synthesis and allows you to set additional parameters using FontFormattingDetectionParams property. If this property is FALSE, the FontFormattingDetectionParams property is ignored.

Important! With the default settings, ABBYY FineReader Engine 12 detects font parameters at the stage of document synthesis. If you set the value of this property to TRUE, you must turn off detection of font parameters during document synthesis. To do this, set the ISynthesisParamsForDocument::DetectFontFormatting property to FALSE. Detection of font parameters during page synthesis enables the program to speed up the subsequent document synthesis and decrease memory usage. However, the quality of font detection may deteriorate.

This property is set to FALSE by default.

DetectHyperlinks VARIANT_BOOL

If this property is set to TRUE, hyperlinks are detected during page synthesis.

This property is set to TRUE by default.

FontFormattingDetectionParams FontFormattingDetectionParams

Specifies additional parameters of font formatting detection at the stage of page synthesis.

This property is used, only if the DetectFontFormattingAtPageLevel property is set to TRUE.

ParagraphExtractionMode ParagraphExtractionModeEnum

Specifies the mode of paragraph extraction.

The default mode is PEM_NormalExtraction.

SaveCharacterCoordinatesForAllVariants VARIANT_BOOL

Specifies if the character coordinates should be saved for all the recognition variants. By default, the symbol coordinates are available only for the first recognition variant, i.e., the one actually chosen.

To access the character coordinates when this property is TRUE, use the GetCharParams method of the WordRecognitionVariant object to receive the CharParams object for the character; its Top, Left, Right, Bottom properties contain the coordinates.

Turning this setting on makes sense only if IRecognizerParams::SaveWordRecognitionVariants is TRUE.

The default value of this property is FALSE.

SynthesizeBusinessCards VARIANT_BOOL

If this property is set to TRUE, FineReader Engine tries to find business cards on the page and fills in the collections of business cards of the document and of each page (IFRDocument::BusinessCards, IFRPage::BusinessCards).

This property is set to FALSE by default.

Color settings
DetectBackgroundColor ThreeStatePropertyValueEnum

If this property is set to TSPV_Yes, the background color is detected during page synthesis.

This property is set to TSPV_Auto by default.

AllowGrayBackgroundColor ThreeStatePropertyValueEnum

If this property is set to TSPV_Yes, the gray color is detected for background. Otherwise, background will be detected as black or white.

The value of this property is taken into account only if the DetectBackgroundColor property is set to TSPV_Yes or TSPV_Auto.

The default value of this property is TSPV_Auto.

DetectTextColor ThreeStatePropertyValueEnum

If this property is set to TSPV_Yes, the text color is detected during page synthesis.

This property is set to TSPV_Auto by default.

AllowGrayTextColor ThreeStatePropertyValueEnum

If this property is set to TSPV_Yes, the gray color is detected for text. Otherwise, text will be detected as black or white.

The value of this property is taken into account only if the DetectTextColor property is set to TSPV_Yes or TSPV_Auto.

The default value of this property is TSPV_Auto.

CorrectDynamicRange ThreeStatePropertyValueEnum

If this property is set to TSPV_Yes, image colors will be corrected so that the background is white and the text is black, or vice versa, which improves image quality. Recognition, however, will slow down.

We recommend using this property only if the DetectBackgroundColor and DetectTextColor properties are set to TSPV_Yes or TSPV_Auto.

This property is set to TSPV_Auto by default.

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

Object Diagram

Output parameter

This object is the output parameter of the CreateSynthesisParamsForPage method of the Engine object.

Input parameter

This object is passed as an input parameter to the following methods:

Samples

The object is used in the following code samples: CommandLineInterface, VisualComponents; and demo tools: User Pattern Training Utility.

See also

Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis

SynthesisParamsForDocument

Working with Properties

24.03.2023 8:51:52

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.