Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.data.CheckDetectionSettings Class Reference
Inheritance diagram for com.kofax.kmc.ken.engines.data.CheckDetectionSettings:
com.kofax.kmc.ken.engines.data.DetectionSettings

Public Member Functions

 CheckDetectionSettings ()
 Default constructor creates a check detection setting object that has default values. More...
 
 CheckDetectionSettings (DetectionSettings settings)
 
 CheckDetectionSettings (CheckDetectionSettings settings)
 
 CheckDetectionSettings (Point targetFrameCenter, double targetFrameAspectRatio, double targetFramePaddingPercent)
 Constructor creates a check detection setting object that has specified values. More...
 
CheckSide getSide ()
 
void setSide (CheckSide side)
 
void setAspectRatioFraction (double aspectRatioFraction)
 
double getAspectRatioFraction ()
 
- Public Member Functions inherited from com.kofax.kmc.ken.engines.data.DetectionSettings
 DetectionSettings (Point targetFrameCenter, double targetFrameAspectRatio, double targetFramePaddingPercent)
 Constructor creates a document detection setting object that has specified values. More...
 
Point getCenterPoint ()
 Gets the center point within the image of the target frame. More...
 
void setCenterPoint (Point targetFrameCenter)
 Sets the center point within the image of the target frame. More...
 
double getTargetFrameAspectRatio ()
 Gets the aspect ratio of the rectangular frame that should match the document being searched. More...
 
void setTargetFrameAspectRatio (double targetFrameAspectRatio)
 Sets the aspect ratio of the rectangular frame that should match the document being searched. More...
 
double getTargetFramePaddingPercent ()
 Gets the minimum padding in percent length to be maintained between the edges of the target frame and image. More...
 
void setTargetFramePaddingPercent (double paddingPercent)
 Sets the minimum padding in percent length to be maintained between the edges of the target frame and image. More...
 
double getMinFillFraction ()
 Gets the minimum fill area as a fraction of the target frame. More...
 
void setMinFillFraction (double minFillFraction)
 Sets the minimum fill area as a fraction of the target frame. More...
 
double getMaxFillFraction ()
 Gets the maximum fill area as a fraction of the target frame. More...
 
void setMaxFillFraction (double maxFillFraction)
 Sets the maximum fill area as a fraction of the target frame. More...
 
double getMaxSkewAngle ()
 Gets the maximum angle the document can be rotated off from the target frame. More...
 
void setMaxSkewAngle (double maxSkewAngle)
 Sets the maximum angle the document can be rotated off from the target frame. More...
 
double getToleranceFraction ()
 Gets the maximum distance the document can be shifted from the target frame. More...
 
void setToleranceFraction (double toleranceFraction)
 Sets the maximum distance the document can be shifted from the target frame. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.kofax.kmc.ken.engines.data.DetectionSettings
 DetectionSettings ()
 Default constructor creates a detection setting object that has default values. More...
 
 DetectionSettings (DetectionSettings settings)
 

Detailed Description

A configuration object for controlling the CheckDetector object.

Note
Target frame aspect ratio is set for Personal Check by default (6.0 / 2.75 ≈ 2.18). For Business Check use: (9.25 / 3.67) ≈ 2.52

Constructor & Destructor Documentation

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

Default constructor creates a check detection setting object that has default values.

  • Center Point: null
  • Aspect Ratio: ≈ 2.18
  • Padding: 5
  • minFillFraction: 0.65
  • maxFillFraction: 1.3
  • maxSkewAngle: 10
  • toleranceFraction: 0.15
  • side: front
  • aspectRatioFraction: 0
com.kofax.kmc.ken.engines.data.CheckDetectionSettings.CheckDetectionSettings ( DetectionSettings  settings)
inline

Constructor that copies base settings defined in DetectionSettings class and sets all other settings to their default values.

Parameters
settingsthe settings object to copy from
com.kofax.kmc.ken.engines.data.CheckDetectionSettings.CheckDetectionSettings ( CheckDetectionSettings  settings)
inline

Copy constructor.

Parameters
settingsthe settings object to copy from
com.kofax.kmc.ken.engines.data.CheckDetectionSettings.CheckDetectionSettings ( Point  targetFrameCenter,
double  targetFrameAspectRatio,
double  targetFramePaddingPercent 
)
inline

Constructor creates a check detection setting object that has specified values.

Parameters
targetFrameCenterSet the target rectangle center point. Should just be a point with in the bounds of the image height and width.
targetFrameAspectRatioSet the aspect ratio the target rectangle should have. Must be greater than 0.
targetFramePaddingPercentSet the padding around the target rectangle. must be greater than or equal to 0 and less then 100.

Member Function Documentation

double com.kofax.kmc.ken.engines.data.CheckDetectionSettings.getAspectRatioFraction ( )
inline

Returns the tolerance fraction value used for verification of aspect ratio for detected check.

Returns
the fraction value
See also
setAspectRatioFraction(double)
CheckSide com.kofax.kmc.ken.engines.data.CheckDetectionSettings.getSide ( )
inline

Returns the check side.

Returns
the check side
void com.kofax.kmc.ken.engines.data.CheckDetectionSettings.setAspectRatioFraction ( double  aspectRatioFraction)
inline

The maximum fractional error allowed between the target frame aspect ratio defined in setTargetFrameAspectRatio(double) and aspect ratio of detected check. Used to obtain the acceptable aspect ratio during detection.

This setting is applicable only for back side of check since for front side aspect ratio is calculated based on MICR.

The value 0.1 assumes that error of aspect ratio will be within 10%.

Default value 0 means that verification of aspect ratio for detected check is disabled.

Parameters
aspectRatioFractionthe fraction value
void com.kofax.kmc.ken.engines.data.CheckDetectionSettings.setSide ( CheckSide  side)
inline

Sets the side of a check that needs to be detected.

Parameters
sidethe check side

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.