Public Member Functions | |
| PassportDetectionSettings () | |
| PassportDetectionSettings (PassportDetectionSettings detectionSettings) | |
| double | getTargetFrameAspectRatio () |
| Gets the aspect ratio of the rectangular frame that should match the passport being searched. More... | |
| void | setTargetFrameAspectRatio (double targetFrameAspectRatio) |
| Sets the aspect ratio of the rectangular frame that should match the document being searched. More... | |
 Public Member Functions inherited from 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 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 PassportDetector object.
Constructor & Destructor Documentation
| PassportDetectionSettings | ( | PassportDetectionSettings | detectionSettings | ) |
Copy constructor. Creates a copy object for the document detection settings.
- Parameters
-
detectionSettings the settings object to copy from
Member Function Documentation
| double getTargetFrameAspectRatio | ( | ) |
Gets the aspect ratio of the rectangular frame that should match the passport being searched.
- Returns
- double
| void setTargetFrameAspectRatio | ( | double | targetFrameAspectRatio | ) |
Sets the aspect ratio of the rectangular frame that should match the document being searched.
The aspect ratio should be in the format of longEdge/shortEdge (i.e. targetFrameAspectRatio >= 1). The long edge of the target frame is align with the long edge of the camera preview or image. If 0 < targetFrameAspectRatio < 1 it will be inverted. For example: the ratio 0.4 (or 2.0/5.0) will be inverted to 2.5 (5.0/2.0).
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 1.45.
- Parameters
-
targetFrameAspectRatio : double
The documentation for this class was generated from the following file: