Kofax Mobile SDK API Reference
Public Member Functions | Public Attributes | List of all members
ImageProcessorConfiguration Class Reference
Inheritance diagram for ImageProcessorConfiguration:

Public Member Functions

ImageProcessorConfiguration clone ()
 Performs a field-for-field copy of instances of this class. More...
 
 ImageProcessorConfiguration ()
 
 ImageProcessorConfiguration (String ipOperations) throws KmcException
 

Public Attributes

RotateType rotateType = RotateType.ROTATE_NONE
 
ColorDepth outputColorDepth = ColorDepth.COLOR
 
CropType cropType = CropType.CROP_NONE
 
TargetFrameCropType targetFrameCropType = TargetFrameCropType.TARGET_FRAME_CROP_OFF
 
DeskewType deskewType = DeskewType.DESKEW_NONE
 
DocumentDimensions documentDimensions = null
 
Integer outputDPI = 0
 
final String ippString
 
BoundingTetragon croppingTetragon = null
 

Constructor & Destructor Documentation

◆ ImageProcessorConfiguration() [1/2]

Creates a new image processor configuration with default values.

◆ ImageProcessorConfiguration() [2/2]

ImageProcessorConfiguration ( String  ipOperations) throws KmcException

Creates a new image processor configuration based on an image perfection operation string. Applicable tokens will be converted into configuration properties. Remaining tokens will be stored, and used in a secondary processing operation.

Parameters
ipOperationsImage perfection operation string
Exceptions
KmcExceptionif ipOperations is invalid

Member Function Documentation

◆ clone()

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

Member Data Documentation

◆ croppingTetragon

BoundingTetragon croppingTetragon = null

Use this property to set the bounding tetragon. Set cropType to CROP_TETRAGON to crop an image to this tetragon.

◆ cropType

Crop image to a user specified option

◆ deskewType

Deskew an output image

◆ documentDimensions

DocumentDimensions documentDimensions = null

Use this property to set the length of the short and long edges of the original document in inches.

◆ ippString

final String ippString

The ippString that will be used for a secondary processing operation

◆ outputColorDepth

ColorDepth outputColorDepth = ColorDepth.COLOR

Use this property to set the desired output colordepth.

◆ outputDPI

Integer outputDPI = 0

Use this property to set the desired output image DPI (Dots Per Inch). If you set it to 0, then the library will automatically detect the output image DPI and indicate it in the output object. Default: 0

◆ rotateType

Rotate automatically or by 90 degree options

◆ targetFrameCropType

Use this property to enable or disable target frame cropping.


The documentation for this class was generated from the following file:
Untitled Document © 2021 Kofax, Inc. All rights reserved. Use is subject to license terms.