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

A configuration object for controlling the quick analysis image processing. More...

Public Member Functions

 QuickAnalysisSettings ()
 Default constructor creates a check detection setting object that has default values. More...
 
boolean getBlurDetection ()
 Gets the status of blur detection. More...
 
void setBlurDetection (boolean enabled)
 Sets the status of blur detection. More...
 
boolean getSaturationDetection ()
 Gets the status of saturation detection. More...
 
void setSaturationDetection (boolean enabled)
 Sets the status of saturation detection. More...
 
boolean getGlareDetection ()
 Gets the status of glare detection. More...
 
void setGlareDetection (boolean enabled)
 Sets the status of glare detection. More...
 
double getGlareDetectionIntensityFraction ()
 Gets the value of intensity fraction in glare detection. More...
 
void setGlareDetectionIntensityFraction (double fraction)
 Sets the value of intensity fraction of glare detection. More...
 
double getGlareDetectionMinimumGlareAreaFraction ()
 Gets the value of minimum intensity glare area fraction in glare detection. More...
 
void setGlareDetectionMinimumGlareAreaFraction (double fraction)
 Sets the value of minimum glare area fraction of glare detection. More...
 
int getGlareDetectionIntensityThreshold ()
 Gets the value of intensity threshold in glare detection. More...
 
void setGlareDetectionIntensityThreshold (int threshold)
 Sets the value of intensity threshold fraction of glare detection. More...
 
int getGlareDetectionNumberOfTiles ()
 Gets the value of number of tiles in glare detection. More...
 
void setGlareDetectionNumberOfTiles (int tiles)
 Sets the value of number of tiles of glare detection. More...
 
double getGlareDetectedThreshold ()
 Gets the threshold for the area of the glare. More...
 
void setGlareDetectedThreshold (double threshold)
 Sets the threshold for the area of the glare. More...
 
int getBlurThreshold ()
 Gets the sensibility of the blur detection algorithm. More...
 
void setBlurThreshold (int threshold)
 Sets the sensibility of the blur detection algorithm. More...
 
int getBlurCountPercentThreshold ()
 Gets the threshold for blurry areas. More...
 
void setBlurCountPercentThreshold (int threshold)
 Sets the threshold for blurry areas. More...
 
int get_blurThreshold ()
 
void set_blurThreshold (int threshold)
 
int get_blurCountPercentThreshold ()
 
void set_blurCountPercentThreshold (int threshold)
 

Detailed Description

A configuration object for controlling the quick analysis image processing.

The primary purpose of the settings object is to define properties for quick analysis image processing.

Constructor & Destructor Documentation

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

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

Member Function Documentation

int com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.get_blurCountPercentThreshold ( )
inline
int com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.get_blurThreshold ( )
inline
Deprecated:
as of 3.0, use getBlurThreshold() instead.
int com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getBlurCountPercentThreshold ( )
inline

Gets the threshold for blurry areas.

An image is considered blurry when the amount of blurry areas exceeds this threshold.
The threshold should be specified as percentage of the image area.

Threshold values should be in the [0, 100] range, other values will be clamped to this range.
Defaults to 80.

Returns
the threshold for blurry areas
See also
getBlurThreshold()
boolean com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getBlurDetection ( )
inline

Gets the status of blur detection.

Returns
boolean
See also
setBlurDetection(boolean)
int com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getBlurThreshold ( )
inline

Gets the sensibility of the blur detection algorithm.

An image section is considered blurry when its blurriness exceeds this threshold.

Threshold values should be in the [0, 100] range, other values will be clamped to this range.
Defaults to 15.
Rising this threshold increases the number of sections marked as blurry.

Detected blurry sections are used in conjunction with blurCountPercentThreshold to calculate the percentage of blurry areas and decide if the whole image should be considered blurry.

Returns
the sensibility of the blur detection algorithm
See also
getBlurCountPercentThreshold()
double com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getGlareDetectedThreshold ( )
inline

Gets the threshold for the area of the glare.

An image is considered to have a glare when the area of the glare exceeds this threshold.
The threshold should be specified as a fraction of the image area.

Threshold values should be in the [0.01, 0.99] range, other values will be clamped to this range.
Defaults to 0.02.

Returns
the threshold for the area of the glare
See also
setGlareDetectedThreshold(double)
boolean com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getGlareDetection ( )
inline

Gets the status of glare detection.

Returns
boolean
See also
setGlareDetection(boolean)
double com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getGlareDetectionIntensityFraction ( )
inline

Gets the value of intensity fraction in glare detection.

Return the intensity fraction value used in glare detection.

Returns
double
See also
setGlareDetectionIntensityFraction(double)
int com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getGlareDetectionIntensityThreshold ( )
inline

Gets the value of intensity threshold in glare detection.

Return the intensity threshold value used in glare detection.

Returns
int
See also
setGlareDetectionIntensityThreshold(int)
double com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getGlareDetectionMinimumGlareAreaFraction ( )
inline

Gets the value of minimum intensity glare area fraction in glare detection.

Return the minimum intensity glare area fraction value used in glare detection.

Returns
double
See also
setGlareDetectionMinimumGlareAreaFraction(double)
int com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getGlareDetectionNumberOfTiles ( )
inline

Gets the value of number of tiles in glare detection.

Return the number of tiles value used in glare detection.

Returns
int
See also
setGlareDetectionNumberOfTiles(int)
boolean com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.getSaturationDetection ( )
inline

Gets the status of saturation detection.

Returns
boolean
See also
setSaturationDetection(boolean)
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.set_blurCountPercentThreshold ( int  threshold)
inline
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.set_blurThreshold ( int  threshold)
inline
Deprecated:
as of 3.0, use setBlurThreshold(int) instead.
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setBlurCountPercentThreshold ( int  threshold)
inline

Sets the threshold for blurry areas.

An image is considered blurry when the amount of blurry areas exceeds this threshold.
The threshold should be specified as percentage of the image area.

Threshold values should be in the [0, 100] range, other values will be clamped to this range.
Defaults to 80.

Parameters
thresholdthe threshold for blurry areas
See also
setBlurThreshold(int)
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setBlurDetection ( boolean  enabled)
inline

Sets the status of blur detection.

This is to enable or disable blur detection in quick analysis The default value is true.

Parameters
enabled: boolean
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setBlurThreshold ( int  threshold)
inline

Sets the sensibility of the blur detection algorithm.

An image section is considered blurry when its blurriness exceeds this threshold.

Threshold values should be in the [0, 100] range, other values will be clamped to this range.
Defaults to 15.
Rising this threshold increases the number of sections marked as blurry.

Detected blurry sections are used in conjunction with blurCountPercentThreshold to calculate the percentage of blurry areas and decide if the whole image should be considered blurry.

Parameters
thresholdthe sensibility of the blur detection algorithm
See also
setBlurCountPercentThreshold(int)
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setGlareDetectedThreshold ( double  threshold)
inline

Sets the threshold for the area of the glare.

An image is considered to have a glare when the area of the glare exceeds this threshold.
The threshold should be specified as a fraction of the image area.

Threshold values should be in the [0.01, 0.99] range, other values will be clamped to this range.
Defaults to 0.02.

Parameters
thresholdthe threshold for the area of the glare
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setGlareDetection ( boolean  enabled)
inline

Sets the status of glare detection.

This is to enable or disable glare detection in quick analysis. The default value is true.

Parameters
enabled: boolean
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setGlareDetectionIntensityFraction ( double  fraction)
inline

Sets the value of intensity fraction of glare detection.

The fraction of pixels with the highest intensity that are assumed to be glare. Valid values: 0.01-0.99 The default value is 0.03d.

Parameters
fraction: double
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setGlareDetectionIntensityThreshold ( int  threshold)
inline

Sets the value of intensity threshold fraction of glare detection.

The absolute lower threshold for high intensity pixels. No pixel below this threshold is perceived as glare. Valid values: 0-255 The default value is 230.

Parameters
threshold: int
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setGlareDetectionMinimumGlareAreaFraction ( double  fraction)
inline

Sets the value of minimum glare area fraction of glare detection.

The minimum area of an image that needs to be affected by glare to be included in the glare area. Valid values: 0.01-0.99 The default value is 0.01d.

Parameters
fraction: double
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setGlareDetectionNumberOfTiles ( int  tiles)
inline

Sets the value of number of tiles of glare detection.

The number of tiles into which an edge of the image is divided for glare detection. Valid values: 1-1000 The default value is 100.

Parameters
tiles: int
void com.kofax.kmc.ken.engines.data.QuickAnalysisSettings.setSaturationDetection ( boolean  enabled)
inline

Sets the status of saturation detection.

This is to enable or disable saturation detection in quick analysis The default value is true.

Parameters
enabled: boolean

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.