Atalasoft MobileImage API Reference
Instance Methods | Properties | List of all members
kfxKEDDocumentDetectionSettings Class Reference

A configuration object for controlling the kfxKCDDocumentDetector object. More...

#import <kfxKEDDocumentDetectionSettings.h>

Inheritance diagram for kfxKEDDocumentDetectionSettings:
kfxKEDDocumentBaseDetectionSettings

Instance Methods

(instancetype) - initWithSettings:
 Initializes a new object using the specified document base detection settings. More...
 

Properties

int longAxisThreshold
 The minimum page size threshold for the long axis of the control. More...
 
int shortAxisThreshold
 The minimum page size threshold for the short axis of the control. More...
 
CGFloat zoomMinFillFraction
 The minimum fill area as a fraction of the target frame. More...
 
CGFloat targetFrameAspectRatio
 The aspect ratio of the rectangular frame that should match the document being searched. More...
 
kfxKEDDocumentEdgeDetection edgeDetection
 The document edge detection algorithm. More...
 
- Properties inherited from kfxKEDDocumentBaseDetectionSettings
CGPoint targetFrameCenter
 The center point within the image of the target frame. More...
 
CGFloat targetFramePaddingPercent
 The minimum padding in percent length to be maintained between the edges of the target frame and image. More...
 
CGFloat targetFrameAspectRatio
 The aspect ratio of the rectangular frame that should match the document being searched. More...
 
CGFloat zoomMinFillFraction
 The minimum fill area as a fraction of the target frame. More...
 
CGFloat zoomMaxFillFraction
 The maximum fill area as a fraction of the target frame. More...
 
CGFloat turnSkewAngleTolerance
 The maximum angle the document can be rotated off from the target frame. More...
 
CGFloat verticalMovementTolerance
 The maximum distance the document can be shifted above or below the target frame. More...
 
CGFloat horizontalMovementTolerance
 The maximum distance the document can be shifted left of right of the target frame. More...
 

Detailed Description

A configuration object for controlling the kfxKCDDocumentDetector object.

Method Documentation

- (instancetype) initWithSettings: (kfxKEDDocumentBaseDetectionSettings *)  settings

Initializes a new object using the specified document base detection settings.

Returns the newly initialized object with the specifide properties.

Property Documentation

- (kfxKEDDocumentEdgeDetection) edgeDetection
readwritenonatomicassign

The document edge detection algorithm.

The supported algorithms are: kfxKEDDocumentEdgeDetection_ISG. ISG document detection algorithm, which is a legacy. kfxKEDDocumentEdgeDetection_GPUBased. GPU based document detection algorithm. Can't be used while application is in background state, since it's using OpenGLES rendering.

The default algorithm is kfxKEDDocumentEdgeDetection_GPUBased.

- (int) longAxisThreshold
readwritenonatomicassign

The minimum page size threshold for the long axis of the control.

This property is a percent value. The valid range is [0 - 100]. Any values outside this range will be interpreted as the closest valid value (0 or 100). When page detection is enabled, this property specifies the minimum size of the page that spans the long axis of the ImageCaptureControl preview area. If the page is smaller than the threshold, it will not be captured. If the detected page is rotated in the preview, it will be aligned to the closest 90 degree orientation before any comparison is made.

The value 0 will disable page long axis threshold check. The default value is 0.85.

Because page detection requires some margin around a page to properly detect it, the useful upper limit of this property is around 90%.

- (int) shortAxisThreshold
readwritenonatomicassign

The minimum page size threshold for the short axis of the control.

This property is a percent value. The valid range is [0 - 100]. Any values outside this range will be interpreted as the closest valid value (0 or 100). When page detection is enabled, this property specifies the minimum size of the page that spans the short axis of the ImageCaptureControl preview area. If the page is smaller than the threshold, it will not be captured. If the detected page is rotated in the preview, it will be aligned to the closest 90 degree orientation before any comparison is made.

The value 0 will disable page short axis threshold check. The default value is 0.85.

Because page detection requires some margin around a page to properly detect it, the useful upper limit of this property is around 90%.

- (CGFloat) targetFrameAspectRatio
readwritenonatomicassign

The aspect ratio of the rectangular frame that should match the document being searched.

The aspect ratio is presented in the format of longEdge/shortEdge, and is used to construct the target frame.

Aspect ratio between 0 and 1 or negative is not recommended. It can result in erroneous detection of target frame. If the targetFrameAspectRatio is set to 0, then it will be automatically reset to an image aspect ratio.

The default value is 0, meaning that the ratio of the input image will be used.

- (CGFloat) zoomMinFillFraction
readwritenonatomicassign

The minimum fill area as a fraction of the target frame.

The minimum fill fraction puts a lower bound on what is considered an acceptable zoom level. If the area of a detected document is less then the area of the target frame multiplied by the minimum fill fraction, guidance will suggest zooming in on the document. The default value is 0.2.


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.