A configuration object for controlling the Fixed Aspect Ratio Detector. More...
#import <KFXFixedAspectRatioDetectionSettings.h>
Instance Methods | |
| (instancetype) | - initWithSettings: |
| Initializes a new object using the specified document base detection settings. More... | |
Properties | |
| CGFloat | targetFrameAspectRatio |
| The aspect ratio of the rectangular frame that should match the document being searched. More... | |
| CGFloat | targetFramePaddingPercent |
| The minimum padding in percent length to be maintained between the edges of the target frame and image. 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... | |
 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 Fixed Aspect Ratio Detector.
Method Documentation
◆ initWithSettings:()
| - (instancetype) initWithSettings: | (kfxKEDDocumentBaseDetectionSettings *) | settings |
Initializes a new object using the specified document base detection settings.
Returns the newly initialized object with the specified properties.
Property Documentation
◆ horizontalMovementTolerance
|
readwritenonatomicassign |
The maximum distance the document can be shifted left of right of the target frame.
Not supported. Setting this property do nothing. Returns 0 whatever is set.
◆ targetFrameAspectRatio
|
readwritenonatomicassign |
The aspect ratio of the rectangular frame that should match the document being searched.
The aspect ratio is used to construct the target frame that should match the document being searched. If targetFrameAspectRatio > 1, the long edge of the target frame will align with the long edge of the camera preview. If 0 < targetFrameAspectRatio < 1, the long edge of the target frame will align with the short edge of the camera preview.
If the targetFrameAspectRatio is set to 0, then it will be automatically reset to an image aspect ratio. Setting negative values has the same effect as if 0 was set.
The default value is 2.125 / 3.375.
◆ targetFramePaddingPercent
|
readwritenonatomicassign |
The minimum padding in percent length to be maintained between the edges of the target frame and image.
Given a center point and aspect ratio, a rectangular frame will be constructed to cover as much of the image as possible without any the distances between a frame edge and image edge falling below the padding distance, calculated as percent of the perpendicular image edge length. Values will be clamped to the range [1-50].
The default value is 8.
◆ turnSkewAngleTolerance
|
readwritenonatomicassign |
The maximum angle the document can be rotated off from the target frame.
Not supported. Setting this property do nothing. Returns 0 whatever is set.
◆ verticalMovementTolerance
|
readwritenonatomicassign |
The maximum distance the document can be shifted above or below the target frame.
Not supported. Setting this property do nothing. Returns 0 whatever is set.
◆ zoomMaxFillFraction
|
readwritenonatomicassign |
The maximum fill area as a fraction of the target frame.
Not supported. Setting this property do nothing. Returns 0 whatever is set.
◆ zoomMinFillFraction
|
readwritenonatomicassign |
The minimum fill area as a fraction of the target frame.
Not supported. Setting this property do nothing. Returns 0 whatever is set.
The documentation for this class was generated from the following file: