|
Kofax Mobile SDK API Reference
|
A configuration object for controlling the quick analysis image processing. More...
Public Member Functions | |
| QuickAnalysisSettings () | |
| Default constructor creates a quick analysis 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 | getLegacyBlurDetection () |
| Gets the status of legacy blur detection. More... | |
| void | setLegacyBlurDetection (boolean enabled) |
| Sets the status of legacy 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 confidence threshold for the blur detection algorithm. More... | |
| void | setBlurThreshold (int threshold) |
| Sets the confidence threshold for the blur detection algorithm. More... | |
| int | getLegacyBlurThreshold () |
| Gets the sensibility of the blur detection algorithm. More... | |
| void | setLegacyBlurThreshold (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... | |
| boolean | getSkewDetection () |
| Gets the status of skew detection in the quick analysis process. More... | |
| void | setSkewDetection (boolean enabled) |
| Enable/disable skew detection in the quick analysis process. More... | |
| boolean | getShadowDetection () |
| Gets the status of shadow detection in the quick analysis process. More... | |
| void | setShadowDetection (boolean enabled) |
| Enable/disable shadow detection in the quick analysis process. More... | |
| boolean | getMissingBordersDetection () |
| Gets the status of missing borders detection in the quick analysis process. More... | |
| void | setMissingBordersDetection (boolean enabled) |
| Enable/disable missing borders detection in the quick analysis process. More... | |
| boolean | getLowContrastBackgroundDetection () |
| Gets the status of low contrast background detection in the quick analysis process. More... | |
| void | setLowContrastBackgroundDetection (boolean enabled) |
| Enable/disable low contrast background detection in the quick analysis process. More... | |
| UseMRZPassportDetection | getUseMRZPassportDetection () |
| Gets the status of MRZ passport detection. More... | |
| void | setUseMRZPassportDetection (UseMRZPassportDetection useMRZPassportDetection) |
| Sets the value of MRZ passport detection. More... | |
| UseTargetFrameCrop | getUseTargetFrameCrop () |
| Gets the value of target frame cropping. More... | |
| void | setUseTargetFrameCrop (UseTargetFrameCrop useTargetFrameCrop) |
| Sets the value of target frame cropping. More... | |
| UseDocumentDetectionBasedCrop | getUseDocumentDetectionBasedCrop () |
| Gets the value of document detection based cropping. More... | |
| void | setUseDocumentDetectionBasedCrop (UseDocumentDetectionBasedCrop useDocumentDetectionBasedCrop) |
| Sets the value of document detection based cropping. More... | |
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.
Default constructor creates a quick analysis setting object that has default values.
| int getBlurCountPercentThreshold | ( | ) |
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.
| boolean getBlurDetection | ( | ) |
| int getBlurThreshold | ( | ) |
Gets the confidence threshold for the blur detection algorithm.
An image section is considered blurry when its algorithm confidence exceeds this threshold.
The threshold should be specified as percentage in the [0, 100] range, other values will be clamped to this range.
Defaults to 50.
| double getGlareDetectedThreshold | ( | ) |
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.05.
| boolean getGlareDetection | ( | ) |
| double getGlareDetectionIntensityFraction | ( | ) |
Gets the value of intensity fraction in glare detection.
Return the intensity fraction value used in glare detection.
| int getGlareDetectionIntensityThreshold | ( | ) |
Gets the value of intensity threshold in glare detection.
Return the intensity threshold value used in glare detection.
| double getGlareDetectionMinimumGlareAreaFraction | ( | ) |
Gets the value of minimum intensity glare area fraction in glare detection.
Return the minimum intensity glare area fraction value used in glare detection.
| int getGlareDetectionNumberOfTiles | ( | ) |
Gets the value of number of tiles in glare detection.
Return the number of tiles value used in glare detection.
| boolean getLegacyBlurDetection | ( | ) |
| int getLegacyBlurThreshold | ( | ) |
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.
| boolean getLowContrastBackgroundDetection | ( | ) |
Gets the status of low contrast background detection in the quick analysis process.
| boolean getMissingBordersDetection | ( | ) |
Gets the status of missing borders detection in the quick analysis process.
| boolean getSaturationDetection | ( | ) |
| boolean getShadowDetection | ( | ) |
Gets the status of shadow detection in the quick analysis process.
| boolean getSkewDetection | ( | ) |
Gets the status of skew detection in the quick analysis process.
| UseDocumentDetectionBasedCrop getUseDocumentDetectionBasedCrop | ( | ) |
Gets the value of document detection based cropping.
| UseMRZPassportDetection getUseMRZPassportDetection | ( | ) |
Gets the status of MRZ passport detection.
| UseTargetFrameCrop getUseTargetFrameCrop | ( | ) |
Gets the value of target frame cropping.
| void setBlurCountPercentThreshold | ( | int | threshold | ) |
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.
| threshold | the threshold for blurry areas |
| void setBlurDetection | ( | boolean | enabled | ) |
Sets the status of blur detection.
This is to enable or disable blur detection in quick analysis The default value is true.
| enabled | : boolean |
| void setBlurThreshold | ( | int | threshold | ) |
Sets the confidence threshold for the blur detection algorithm.
An image section is considered blurry when its algorithm confidence exceeds this threshold.
The threshold should be specified as percentage in the [0, 100] range, other values will be clamped to this range.
Defaults to 50.
| threshold | the confidence threshold of the blur detection algorithm |
| void setGlareDetectedThreshold | ( | double | threshold | ) |
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.
| threshold | the threshold for the area of the glare |
| void setGlareDetection | ( | boolean | enabled | ) |
Sets the status of glare detection.
This is to enable or disable glare detection in quick analysis. The default value is true.
| enabled | : boolean |
| void setGlareDetectionIntensityFraction | ( | double | fraction | ) |
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.
| fraction | : double |
| void setGlareDetectionIntensityThreshold | ( | int | threshold | ) |
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.
| threshold | : int |
| void setGlareDetectionMinimumGlareAreaFraction | ( | double | fraction | ) |
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.
| fraction | : double |
| void setGlareDetectionNumberOfTiles | ( | int | tiles | ) |
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.
| tiles | : int |
| void setLegacyBlurDetection | ( | boolean | enabled | ) |
Sets the status of legacy blur detection.
This is to enable or disable legacy blur detection in quick analysis process, when enabled, the analysis is performed on legacy algorithm. If user enables this and wants to set a threshold of his own, user should be using {setLegacyBlurThreshold(int)}. The default value is false.
| enabled | : boolean |
| void setLegacyBlurThreshold | ( | int | threshold | ) |
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.
| threshold | the sensibility of the blur detection algorithm |
| void setLowContrastBackgroundDetection | ( | boolean | enabled | ) |
Enable/disable low contrast background detection in the quick analysis process.
When disabled, the QuickAnalysisFeedback will always return isLowContrastBackground as false. The default value is true (enabled).
| enabled | : boolean |
| void setMissingBordersDetection | ( | boolean | enabled | ) |
Enable/disable missing borders detection in the quick analysis process.
When disabled, the QuickAnalysisFeedback will always return isMissingBorders as false. The default value is true (enabled).
| enabled | : boolean |
| void setSaturationDetection | ( | boolean | enabled | ) |
Sets the status of saturation detection.
This is to enable or disable saturation detection in quick analysis The default value is true.
| enabled | : boolean |
| void setShadowDetection | ( | boolean | enabled | ) |
Enable/disable shadow detection in the quick analysis process.
When disabled, the QuickAnalysisFeedback will always return isShadowed as false. The default value is true (enabled).
| enabled | : boolean |
| void setSkewDetection | ( | boolean | enabled | ) |
Enable/disable skew detection in the quick analysis process.
When disabled, the QuickAnalysisFeedback will always return isOverlySkewed as false. The default value is true (enabled).
| enabled | : boolean |
| void setUseDocumentDetectionBasedCrop | ( | UseDocumentDetectionBasedCrop | useDocumentDetectionBasedCrop | ) |
Sets the value of document detection based cropping.
Specify quick analysis to use document detection based cropping or not The default value is UseDocumentDetectionBasedCrop.OFF
| useDocumentDetectionBasedCrop | : UseDocumentDetectionBasedCrop |
| void setUseMRZPassportDetection | ( | UseMRZPassportDetection | useMRZPassportDetection | ) |
Sets the value of MRZ passport detection.
Specify quick analysis to use MRZ passport detection for cropping process or not The default value is UseMRZPassportDetection.OFF
| useMRZPassportDetection | : UseMRZPassportDetection |
| void setUseTargetFrameCrop | ( | UseTargetFrameCrop | useTargetFrameCrop | ) |
Sets the value of target frame cropping.
Specify quick analysis to use target frame cropping or not The default value is UseTargetFrameCrop.OFF
| useTargetFrameCrop | : UseTargetFrameCrop |