PrepareImageMode Object (IPrepareImageMode Interface)

PrepareImageMode object (IPrepareImageMode interface) in the ABBYY FineReader Engine API — Attributes that control how an image is prepared during conversion to the internal format (rotation first, then mirroring); persistent object savable to file/memory.

This object contains different attributes specifying how an image will be prepared during conversion to the internal format. All properties of a newly created object of this type are set to reasonable defaults. To know about the default value of this or that property, see its description. The sequence of the transformations upon the prepared image is the following: first the rotation is performed, and then the image is mirrored.

The PrepareImageMode 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, and LoadFromFile

Windows SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.

Properties

Name	Type	Description
Application	Engine, read-only	Returns the Engine object.
CompressImageMode	CompressImageModeEnum	Specifies if the image should be compressed during conversion to the internal format. Applies only to color and gray images, black and white images are always compressed with lossless compression. By default, this property is set to CIM_Auto, which currently means that born-digital images (eg. obtained from PDF files) will use lossless, while others images use max compression.
DocumentType	DocumentTypeEnum	Specifies the type of the document on the image. If you know the document type for certain, you can set this property to bypass the document classifier and save time. By default, this property is DT\_Auto, which means that FineReader Engine should run the document classifier to determine document type.
ImageSourceType	ImageSourceTypeEnum	Specifies the image origin. For example, a photo and a screenshot with some text will need different preprocessing techniques. By default, this property is IST_Auto, which means that FineReader Engine should detect the image origin automatically.
OfficeConversionSettings	OfficeConversionSettings, read-only	Provides access to the settings for importing digital documents using the same methods that open the images. Linux and Windows only.
EnforceOwnerRestrictions	VARIANT_BOOL	Specifies whether owner (permission) restrictions declared in a PDF document are enforced. PDF documents may carry permission flags that restrict certain operations without requiring a password to open the file. When set to TRUE (default), the engine enforces these restrictions and returns an error if they are present. When set to FALSE, the restrictions are ignored and the document is processed normally. Set this property to FALSE only when your application already has authority over the submitted files.
RasterizeFreeText	VARIANT_BOOL	Specifies whether Free Text annotations from the input PDF document should be retained. By default, this property is set to TRUE. Linux and Windows only. In Linux, before using this property, make sure the Arial or Liberation Sans font is available on your workstation.

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. Windows only.
SaveToFile	Saves the object contents into a file on disk.
SaveToMemory	Saves the object contents into the global memory. Windows only.

Related objects

Linux and Windows

Object Diagram

Output parameter

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

Input parameter

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

• AddImageFile, AddImageFileFromAttachment, AddImageFileWithPassword, AddImageFileWithPasswordCallback, AddImageFileFromMemory methods of the FRDocument object
• CreateFRDocumentFromImage, PrepareBitmapBits, OpenImageFileFromMemory, OpenBitmapBits, OpenBitmap, OpenDib, PrepareBitmap, PrepareDib, InjectTextLayer methods of the Engine object
• Start method of the BatchProcessor object in Linux and Windows

Samples

The object is used in the following code samples:

• Linux: CommandLineInterface
• Windows: CommandLineInterface; and demo tools: Engine Predefined Processing Profiles

See also

Working with Images

Working with Properties