ImagePerfectionProfile Class Reference

The ImagePerfectionProfile object encapsulates advanced image processing settings. This object is serializable. More...

Inheritance diagram for ImagePerfectionProfile:

Classes
enum	UseDocumentDetectionBasedCrop
	An enum used with the useDocumentDetectionBasedCrop property. More...
enum	UseMRZPassportDetection
	An enum used with the useMRZPassportDetection property. More...
enum	UseTargetFrameCrop
	An enum used with the useTargetFrameCrop property. More...

Public Member Functions
	ImagePerfectionProfile ()
ImagePerfectionProfile	clone ()
	Performs a field-for-field copy of instances of this class. More...
String	getName ()
	Gets the application-defined name for this ImagePerfectionProfile object. More...
void	setName (String name)
	Sets the application-defined name for this ImagePerfectionProfile object. More...
String	getIpOperations ()
	Gets the image processing operations string. More...
void	setIpOperations (String ipOperations)
	Sets the image processing operations string. More...
String	getIpOperationsFilePath ()
	Gets the image processing settings file. More...
void	setIpOperationsFilePath (String ipOperationsFilePath)
	Sets the image processing settings file. More...
UseMRZPassportDetection	getUseMRZPassportDetection ()
	Gets the useMRZPassportDetection property. More...
void	setUseMRZPassportDetection (UseMRZPassportDetection useMRZPassportDetection)
	Sets the useMRZPassportDetection property. More...
UseTargetFrameCrop	getUseTargetFrameCrop ()
	Gets the useTargetFrameCrop property. More...
void	setUseTargetFrameCrop (UseTargetFrameCrop useTargetFrameCrop)
	Sets the useTargetFrameCrop property. More...
UseDocumentDetectionBasedCrop	getUseDocumentDetectionBasedCrop ()
	Gets the useDocumentDetectionBasedCrop property. More...
void	setUseDocumentDetectionBasedCrop (UseDocumentDetectionBasedCrop useDocumentDetectionBasedCrop)
	Sets the useDocumentDetectionBasedCrop property. More...

Detailed Description

The ImagePerfectionProfile object encapsulates advanced image processing settings. This object is serializable.

Use this ImagePerfectionProfile object to specify advanced image processing settings to the ImageProcessor. These advanced image processing settings may have originated from a KFS Server, a TotalAgility Server or the application itself. The ImagePerfectionProfile allows for two ways of specifying those settings:

ImageProcessor operations string (ipOperations)
ImageProcessor operations XML file (ipOperationsFilePath)

If both ipOperations and ipOperationsFilePath are specified as non-blank, the ipOperations string is used and the other one is ignored.

ImagePerfectionProfile objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.

Deprecated:

Deprecated in SDK 3.3. Please use ImageProcessorConfiguration

Constructor & Destructor Documentation

ImagePerfectionProfile

(

)

Member Function Documentation

ImagePerfectionProfile clone

(

)

Performs a field-for-field copy of instances of this class.

String getIpOperations

(

)

Gets the image processing operations string.

This specifies the image processing operations to be performed by the ImageProcessor. Please refer to the developers guide for a list of image processing operations tokens.

String getIpOperationsFilePath

(

)

Gets the image processing settings file.

This specifies the file containing image processing operations to be performed by the ImageProcessor.

String getName

(

)

Gets the application-defined name for this ImagePerfectionProfile object.

An application could use the name to describe the purpose of the image processing settings in this object.

UseDocumentDetectionBasedCrop getUseDocumentDetectionBasedCrop

(

)

Gets the useDocumentDetectionBasedCrop property.

Use this property to enable or disable document detection based cropping using the UseDocumentDetectionBasedCrop enum. UseDocumentDetectionBasedCrop.OFF means to disable document detection based cropping (default value). UseDocumentDetectionBasedCrop.ON means to enable document detection based cropping.

UseMRZPassportDetection getUseMRZPassportDetection

(

)

Gets the useMRZPassportDetection property.

Use this property to enable or disable MRZ passport detection using the UseMRZPassportDetection enum. UseMRZPassportDetection.OFF means to disable MRZ passport detection for cropping (default value). UseMRZPassportDetection.ON means to disable MRZ passport detection for cropping.

UseTargetFrameCrop getUseTargetFrameCrop

(

)

Gets the useTargetFrameCrop property.

Use this property to enable or disable target frame cropping using the UseTargetFrameCrop enum. UseTargetFrameCrop.OFF means to disable target frame cropping (default value). UseTargetFrameCrop.ON means to enable target frame cropping.

void setIpOperations

(

String

ipOperations

)

Sets the image processing operations string.

This specifies the image processing operations to be performed by the ImageProcessor. Please refer to the developers guide for a list of image processing operations tokens.

Exceptions

NullPointerException

(ipOperations parameter is null).

void setIpOperationsFilePath

(

String

ipOperationsFilePath

)

Sets the image processing settings file.

This specifies the file containing image processing operations to be performed by the ImageProcessor.

Exceptions

NullPointerException

(ipOperationsFilePath parameter is null).

void setName

(

String

name

)

Sets the application-defined name for this ImagePerfectionProfile object.

An application could use the name to describe the purpose of the image processing settings in this object.

Exceptions

NullPointerException

(name parameter is null).

void setUseDocumentDetectionBasedCrop

(

UseDocumentDetectionBasedCrop

useDocumentDetectionBasedCrop

)

Sets the useDocumentDetectionBasedCrop property.

Use this property to enable or disable document detection based cropping using the UseDocumentDetectionBasedCrop enum. UseDocumentDetectionBasedCrop.OFF means to disable document detection based cropping (default value). UseDocumentDetectionBasedCrop.ON means to enable document detection based cropping.

Exceptions

NullPointerException

('useDocumentDetectionBasedCrop' parameter is null).

void setUseMRZPassportDetection

(

UseMRZPassportDetection

useMRZPassportDetection

)

Sets the useMRZPassportDetection property.

Use this property to enable or disable MRZ passport detection using the UseMRZPassportDetection enum. UseMRZPassportDetection.OFF means to disable MRZ passport detection for cropping (default value). UseMRZPassportDetection.ON means to disable MRZ passport detection for cropping.

Exceptions

NullPointerException

('useMRZPassportDetection' parameter is null).

void setUseTargetFrameCrop

(

UseTargetFrameCrop

useTargetFrameCrop

)

Sets the useTargetFrameCrop property.

Use this property to enable or disable target frame cropping using the UseTargetFrameCrop enum. UseTargetFrameCrop.OFF means to disable target frame cropping (default value). UseTargetFrameCrop.ON means to enable target frame cropping.

Exceptions

NullPointerException

('useTargetFrameCrop' parameter is null).

---

The documentation for this class was generated from the following file:

• ImagePerfectionProfile.java