OrientationDetectionParams Object (IOrientationDetectionParams Interface)
This object provides access to the parameters used for tuning the page orientation detection. It is passed as a parameter into the DetectOrientation method of the FRPage object. Besides, this object is passed as a subobject of the PagePreprocessingParams object into FineReader Engine processing methods.
The OrientationDetectionParams 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. |
OrientationDetectionMode | OrientationDetectionModeEnum |
Specifies the mode of page orientation detection. This property is ODM_Normal by default. |
ProhibitClockwiseRotation | VARIANT_BOOL |
Disables clockwise page rotation when selecting the page orientation. Note: This property must not be set to TRUE if the ProhibitCounterclockwiseRotation and ProhibitUpsidedownRotation properties are set to TRUE. This property is FALSE by default. |
ProhibitCounterclockwiseRotation | VARIANT_BOOL |
Disables counterclockwise page rotation when selecting the page orientation. Note: This property must not be set to TRUE if the ProhibitClockwiseRotation and ProhibitUpsidedownRotation properties are set to TRUE. This property is FALSE by default. |
ProhibitUpsidedownRotation | VARIANT_BOOL |
Disables upside-down page rotation when selecting the page orientation. Note: This property must not be set to TRUE if the ProhibitClockwiseRotation and ProhibitCounterclockwiseRotation properties are set to TRUE. This property is FALSE 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
Output parameter
This object is the output parameter of the CreateOrientationDetectionParams method of the Engine object.
Input parameter
This object is the input parameter of the following methods and properties:
- DetectOrientation method of the FRPage object
Samples
The object is used in the following code samples: CommandLineInterface.
See also
Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis
17.09.2024 15:14:41