Atalasoft MobileImage API Reference
Classes | Public Member Functions | List of all members
com.kofax.kmc.ken.engines.data.BasicSettingsProfile Class Reference

The BasicSettingsProfile specifies basic image processing options. This object is serializable. More...

Inheritance diagram for com.kofax.kmc.ken.engines.data.BasicSettingsProfile:

Classes

enum  CropType
 An enum which identifies the crop type. More...
 
enum  OutputBitDepth
 An enum which identifies the output bit depth. More...
 
enum  RotateType
 An enum which identifies the rotation type. More...
 

Public Member Functions

 BasicSettingsProfile ()
 Create a new empty BasicSettingsProfile. More...
 
BasicSettingsProfile clone ()
 Performs a field-for-field copy of instances of this class. More...
 
RotateType getRotateType ()
 Gets the rotation type property. More...
 
void setRotateType (RotateType rotateType)
 Sets the rotation type property. More...
 
CropType getCropType ()
 Gets the crop type property. More...
 
void setCropType (CropType cropType)
 Sets the crop type property. More...
 
BoundingTetragon getCroppingTetragon ()
 Gets the cropping tetragon property. More...
 
void setCroppingTetragon (BoundingTetragon croppingTetragon)
 Sets the cropping tetragon property. More...
 
boolean getDoDeskew ()
 Gets the deskew property. More...
 
void setDoDeskew (boolean doDeskew)
 Sets the deskew property. More...
 
Integer getOutputDPI ()
 Gets the output DPI property. More...
 
void setOutputDPI (Integer outputDPI)
 Sets the output DPI property. More...
 
OutputBitDepth getOutputBitDepth ()
 Gets the output bit depth property. More...
 
void setOutputBitDepth (OutputBitDepth outputBitDepth)
 Sets the output bit depth property. More...
 
Float getInputDocLongEdge ()
 Gets the input doc long edge property. More...
 
void setInputDocLongEdge (Float inputDocLongEdge)
 Sets the input doc long edge property. More...
 
Float getInputDocShortEdge ()
 Gets the input doc short edge property. More...
 
void setInputDocShortEdge (Float inputDocShortEdge)
 Sets the input doc short edge property. More...
 

Detailed Description

The BasicSettingsProfile specifies basic image processing options. This object is serializable.

An instance of this class contains the simple image processing options that you want to perform on an image. These define the standard crop, deskew and rotation options. You can also use this object to specify the output image DPI and the desired color. You specify the output color by setting OutputBitDepth to BITONAL, GRAYSCALE, or COLOR. The cropping tetragon defines bounding corner points of an area of an image that you want to crop, and override automatic page detection.

If the outputDPI is >= 300 DPI, and the OutputBitDepth is BITONAL, then the image processing includes enhanced binarization, otherwise it uses standard binarization.

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

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.data.BasicSettingsProfile.BasicSettingsProfile ( )
inline

Create a new empty BasicSettingsProfile.

Member Function Documentation

BasicSettingsProfile com.kofax.kmc.ken.engines.data.BasicSettingsProfile.clone ( )
inline

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

BoundingTetragon com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getCroppingTetragon ( )
inline

Gets the cropping tetragon property.

Use this property combined with CropType CROP_TETRAGON to specify the corner points of a tetragon for cropping an image. If the tetragon is not a rectangle, the image will be stretched to make it into a rectangle.

CropType com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getCropType ( )
inline

Gets the crop type property.

Provides a simple way to crop an image. Choose from the options specified in the CropType enum.

boolean com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getDoDeskew ( )
inline

Gets the deskew property.

The deskew property specifies whether to deskew the image or not.

Float com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getInputDocLongEdge ( )
inline

Gets the input doc long edge property.

Use this property to set the length of the longer edge of the original document in inches. The library uses this parameter to better estimate the output image DPI and also helps algorithms better detect document corners, especially when one is outside the boundary of the image. You need not set both short and long edges, the algorithm uses one if it is present. If you set it to 0.0 or null, then the library will not use this parameter.

Float com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getInputDocShortEdge ( )
inline

Gets the input doc short edge property.

Use this property to set the length of the shorter edge of the original document in inches. The library uses this parameter to better estimate the output image DPI and also helps algorithms better detect document corners, especially when one is outside the boundary of the image. You need not set both short and long edges, the algorithm uses one if it is present. If you set it to 0.0 or null, then the library will not use this parameter.

OutputBitDepth com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getOutputBitDepth ( )
inline

Gets the output bit depth property.

The output bit depth property specifies the desired bit depth of the output image using the OutputBitDepth enum.

Integer com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getOutputDPI ( )
inline

Gets the output DPI property.

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

RotateType com.kofax.kmc.ken.engines.data.BasicSettingsProfile.getRotateType ( )
inline

Gets the rotation type property.

Provides a simple way to enable rotation using the RotateType enum.

void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setCroppingTetragon ( BoundingTetragon  croppingTetragon)
inline

Sets the cropping tetragon property.

Use this property combined with CropType CROP_TETRAGON to specify the corner points of a tetragon for cropping an image. If the tetragon is not a rectangle, the image will be stretched to make it into a rectangle.

Exceptions
IllegalArgumentException(Cropping tetragon must be larger than 24 pixels).
void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setCropType ( CropType  cropType)
inline

Sets the crop type property.

Provides a simple way to crop an image. Choose from the options specified in the CropType enum.

Exceptions
NullPointerException('cropType' parameter is null).
void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setDoDeskew ( boolean  doDeskew)
inline

Sets the deskew property.

The deskew property specifies whether to deskew the image or not.

Exceptions
NullPointerException('doDeskew' parameter is null).
void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setInputDocLongEdge ( Float  inputDocLongEdge)
inline

Sets the input doc long edge property.

Use this property to set the length of the longer edge of the original document in inches. The library uses this parameter to better estimate the output image DPI and also helps algorithms better detect document corners, especially when one is outside the boundary of the image. You need not set both short and long edges, the algorithm uses one if it is present. If you set it to 0.0 or null, then the library will not use this parameter.

Exceptions
KMC_GN_PARAM_NEGATIVE('inputDocLongEdge' parameter is negative).
void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setInputDocShortEdge ( Float  inputDocShortEdge)
inline

Sets the input doc short edge property.

Use this property to set the length of the shorter edge of the original document in inches. The library uses this parameter to better estimate the output image DPI and also helps algorithms better detect document corners, especially when one is outside the boundary of the image. You need not set both short and long edges, the algorithm uses one if it is present. If you set it to 0.0 or null, then the library will not use this parameter.

Exceptions
KMC_GN_PARAM_NEGATIVE('inputDocShortEdge' parameter is negative).
void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setOutputBitDepth ( OutputBitDepth  outputBitDepth)
inline

Sets the output bit depth property.

The output bit depth property specifies the desired bit depth of the output image using the OutputBitDepth enum.

void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setOutputDPI ( Integer  outputDPI)
inline

Sets the output DPI property.

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

Exceptions
KMC_GN_PARAM_NEGATIVE('outputDPI' parameter is negative).
void com.kofax.kmc.ken.engines.data.BasicSettingsProfile.setRotateType ( RotateType  rotateType)
inline

Sets the rotation type property.

Provides a simple way to enable rotation using the RotateType enum.

Exceptions
NullPointerException('rotateType' parameter is null).

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.