> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PageAnalysisParams Object (IPageAnalysisParams Interface)

This object provides access to parameters used for tuning the layout analysis process. It is passed as an input parameter or as a member of the [PageProcessingParams](/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/pageprocessingparams) object into FineReader Engine processing methods.

The PageAnalysisParams object is a persistent object. This means that the object's current state can be written to persistent storage. Later, the object can be re-created by reading the object's state from the persistent storage. The following methods provide persistence of the object:

Linux: [SaveToFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method), and [LoadFromFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfromfile-method)

Windows [SaveToFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method), [LoadFromFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfromfile-method), [SaveToMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetomemory-method), and [LoadFromMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfrommemory-method).

## Properties

<table><thead><tr><th><p><strong>Name</strong></p></th><th><p><strong>Type</strong></p></th><th><p><strong>Description</strong></p></th></tr></thead><tbody><tr><td><p><strong>Application</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/engine-object-iengine-interface">Engine</a></strong>, <a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties">read-only</a></p></td><td><p>Returns the <strong>Engine</strong> object.</p></td></tr><tr><td><p><a name="analysismode" /><strong>AnalysisMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/pageanalysismodeenum">PageAnalysisModeEnum</a></strong></p></td><td><p>Specifies layout analysis mode. For documents with tables, complex layouts, or many different objects to be extracted, we recommend setting this property to PAM\_TextExtraction.</p><p>The default value is PAM\_DocumentConversion.</p></td></tr><tr><td colspan="3"><p><em>Block detection settings</em></p></td></tr><tr><td><p><a name="detecttext" /><strong>DetectText</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>If this property is TRUE, the text areas are detected during layout analysis.</p><p>This property is TRUE by default.</p></td></tr><tr><td><p><a name="speedqualitymode" /><strong>SpeedQualityMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/speedqualitymodeenum">SpeedQualityModeEnum</a></strong></p></td><td><p>This property manages the balance between analysis accuracy and speed. You may need the SQM\_Accurate setting when processing documents with complex backgrounds or watermarks.</p><p>The default value is SQM\_Fast.</p></td></tr><tr><td><p><a name="detecthandwritten" /><strong>DetectHandwritten</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>This property set to TRUE enables detection of handwritten text. Handwritten text can only be detected if the <strong>SpeedQualityMode</strong> property is set to SQM\_Accurate, otherwise this setting is ignored.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="detecttables" /><strong>DetectTables</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>If this property is TRUE, the tables are detected during layout analysis.</p><p>This property is TRUE by default.</p></td></tr><tr><td><p><a name="tableanalysisparams" /><strong>TableAnalysisParams</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/tableanalysisparams">TableAnalysisParams</a></strong></p></td><td><p>Provides access to the subset of page processing parameters that affect the process of table analysis. If the <strong>DetectTables</strong> property is FALSE, these parameters are ignored.</p></td></tr><tr><td><p><a name="detectbarcodes" /><strong>DetectBarcodes</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>Specifies if barcodes are detected and, accordingly, barcode blocks created, during layout analysis. If this property is FALSE, barcodes may be detected as blocks of some other type (e.g., pictures).</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="barcodeparams" /><strong>BarcodeParams</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/barcodeparams">BarcodeParams</a></strong></p></td><td><p>Provides access to the subset of page processing parameters, affecting the process of barcode blocks recognition.</p><p>These parameters are ignored, if the value of the <strong>DetectBarcodes</strong> property is FALSE.</p></td></tr><tr><td><p><a name="detectcheckmarks" /><strong>DetectCheckmarks</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>If this property is TRUE, checkmarks are detected during layout analysis.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="detectseparators" /><strong>DetectSeparators</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>If this property is TRUE, separators are detected during layout analysis.</p><p>This property is TRUE by default.</p></td></tr><tr><td><p><a name="detectpictures" /><strong>DetectPictures</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>If this property is TRUE, pictures are detected during layout analysis.</p><p>This property is TRUE by default.</p></td></tr><tr><td><p><a name="detectvectorgraphics" /><strong>DetectVectorGraphics</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>If this property is TRUE, vector pictures are detected during layout analysis. <a href="/fine-reader/engine/api-reference/layout-related-objects/vectorpictureblock">Vector picture blocks</a> can appear in the layout only if this property has been set to TRUE during layout analysis.</p><p>This property is TRUE by default.</p></td></tr><tr><td><p><a name="detectstamps" /><strong>DetectStamps</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>If this property is TRUE, stamps are detected during layout analysis and put into blocks of <a href="/fine-reader/engine/api-reference/enumerations/blocktypeenum#bt_rasterpicture">BT\_RasterPicture</a> type. The text on the detected stamps will not be recognized.</p><p>Stamps can only be detected if the <strong>SpeedQualityMode</strong> property is set to SQM\_Accurate, otherwise this setting is ignored.</p><p>This property is FALSE by default.</p></td></tr><tr><td colspan="3"><p><em>Additional settings</em></p></td></tr><tr><td><p><a name="noshadowsmode" /><strong>NoShadowsMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>This property set to TRUE tells ABBYY FineReader Engine to presume that an image has no shadows from scanning.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="papersizedetectionmode" /><strong>PaperSizeDetectionMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/api-reference/enumerations/papersizedetectionmodeenum">PaperSizeDetectionModeEnum</a></strong></p></td><td><p>This property indicates if the whole preprocessed image can contain information for analysis. In case <strong>PaperSizeDetectionMode</strong> is set to PSDM\_CloseToImageSize, the area for analysis will be defined close to the original image size.</p><Note>For correct operation of this property, the NoShadowsMode property must be set to FALSE.</Note><p>The default value of this property is PSDM\_Auto.</p></td></tr><tr><td><p><a name="detecttextonpictures" /><strong>DetectTextOnPictures</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>This property set to TRUE tells ABBYY FineReader Engine to detect all text on a page image, including text embedded into figures and pictures. Reading order is not changed to provide ability for full-text search later.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="detectverticaleuropeantext" /><strong>DetectVerticalEuropeanText</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>This property set to TRUE makes FineReader Engine look for vertically oriented text. It applies to all languages other than <a href="/fine-reader/engine/guided-tour/advanced-techniques/recognizing-cjk-languages#cjk">CJK</a>. For CJK languages, vertical text detection is managed by the <strong>ProhibitCJKColumns</strong> property.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="prohibitcjkcolumns" /><strong>ProhibitCJKColumns</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>The text in <a href="/fine-reader/engine/guided-tour/advanced-techniques/recognizing-cjk-languages#cjk">CJK languages</a> can be written vertically as well as horizontally. Setting this property to TRUE tells ABBYY FineReader Engine to ignore the possibility of vertical text and recognize the image with the supposition that all text is arranged horizontally.</p><p>This property is valid only for CJK languages.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="prohibitdoublepagemode" /><strong>ProhibitDoublePageMode</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>This property set to TRUE tells ABBYY FineReader Engine to presume that an image is not a book double page.</p><p>This property is FALSE by default.</p></td></tr><tr><td><p><a name="collectpdfexportdata" /><strong>CollectPdfExportData</strong></p></td><td><p><strong><a href="/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties">VARIANT\_BOOL</a></strong></p></td><td><p>This property set to TRUE tells FineReader Engine to collect data for PDF export during layout analysis. The collected data is used during export to image-only PDF (<a href="/fine-reader/engine/api-reference/enumerations/pdfexportmodeenum#imageonly">PEM\_ImageOnly</a> mode) with MRC compression.</p><Note>With this property set to TRUE, recognition is not supported. The recognized text is not needed to export the document to image-only PDF.</Note><p>This property is FALSE by default.</p></td></tr></tbody></table>

## Methods

| Name                                                                                                                                               | Description                                                                                       |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| [CopyFrom](/fine-reader/engine/visual-components-reference/supplementary-objects/spellwordcollection/copyfrom-method)                              | Initializes properties of the current object with values of similar properties of another object. |
| [LoadFromFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfromfile-method)                                            | Restores the object contents from a file on disk.                                                 |
| [LoadFromMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/loadfrommemory-method) <br /><br /> **Note:** *Windows only.* | Restores the object contents from the global memory.                                              |
| [SaveToFile](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetofile-method)                                                | Saves the object contents into a file on disk.                                                    |
| [SaveToMemory](/fine-reader/engine/api-reference/supplementary-objects-and-methods/savetomemory-method) <br /><br /> **Note:** *Windows only.*     | Saves the object contents into the global memory.                                                 |

## Related objects

<img src="https://mintcdn.com/abbyy/i-EfCQVmseNiPQcp/images/fine-reader/engine/pageanalysisparams.gif?s=dab6978e8726a16839b7ebf6d3842bfb" alt="PageAnalysisParams" width="204" height="115" data-path="images/fine-reader/engine/pageanalysisparams.gif" />[](/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/barcodeparams)[](/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/pageprocessingparams#pageanalysisparams)[](/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/tableanalysisparams)[](/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/pageprocessingparams)

[Object Diagram](/fine-reader/engine/api-reference/object-diagram)

## Output parameter

This object is the output parameter of the [CreatePageAnalysisParams](/fine-reader/engine/api-reference/engine-object-iengine-interface/creation-methods/createlessobjectgreater-methods) method of the [Engine](/fine-reader/engine/api-reference/engine-object-iengine-interface) object.

## Input parameter

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

* [Analyze](/fine-reader/engine/api-reference/document-related-objects/frdocument/analyze-method), [AnalyzePages](/fine-reader/engine/api-reference/document-related-objects/frdocument/analyzepages-method) method of the [FRDocument](/fine-reader/engine/api-reference/document-related-objects/frdocument) object
* [Analyze](/fine-reader/engine/api-reference/document-related-objects/frpage/analyze-method), [AnalyzeRegion](/fine-reader/engine/api-reference/document-related-objects/frpage/analyzeregion-method), [AnalyzeTable](/fine-reader/engine/api-reference/document-related-objects/frpage/analyzetable-method) method of the [FRPage](/fine-reader/engine/api-reference/document-related-objects/frpage) object

## Samples

The object is used in the following code samples: [CommandLineInterface](/fine-reader/engine/guided-tour/samples#commandlineinterface) (Windows and Linux)

## See also

[Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis](/fine-reader/engine/guided-tour/advanced-techniques/tuning-parameters-of-preprocessing-analysis-recognition-and-synthesis)

[PageProcessingParams](/fine-reader/engine/api-reference/parameter-objects/preprocessing-analysis-recognition-and-synthesis-parameters/pageprocessingparams#pageanalysisparams)

[Working with Properties](/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)