Need better scanning performance?

Get a FREE customized reading template.

QuadrilateralDetectionModes

QuadrilateralDetectionModes controls the quadrilateral detection process on an image. It currently includes only one mode.

JSON Structure

Location in template:

DocumentNormalizerTaskSettingOptions[i]
    └── SectionArray[j] (Section object)
        └── StageArray[k] (Stage object where Stage = "SST_DETECT_QUADS")
            └── QuadrilateralDetectionModes

Parent object: DetectQuadsStage

Example:

{
    "QuadrilateralDetectionModes": [
        {
            "Mode": "QDM_GENERAL",
            "MinQuadrilateralAreaRatio": 30
        }
    ]
}

This snippet shows only the QuadrilateralDetectionModes parameter.

To use it, embed this parameter within a DetectQuadsStage object in the complete JSON structure.

For the complete JSON structure, see:

Full JSON Structure

Minimal Valid JSON

Parameter Details

QuadrilateralDetectionModes consist one or more mode objects. Each mode object contains a candidate mode and other mode arguments.

Mode Arguments

Mode Argument Name	Mode Argument Summary
Mode (Required)	Description Specifies a mode for quadrilateral detection.
	Type String
	Candidate Mode List QDM_GENERAL QDM_SKIP
	Default Value ["QDM_GENERAL"]
MinQuadrilateralAreaRatio (Optional)	Description The minimum ratio between the target document area and the total image area. Only those exceeding this value will be outputted (measured in percentages).
	Type Int
	Value Range [0,100]
	Default Value 0, indicates the use of automatic exclusion logic to filter out small quads. When this value is changed to anything other than 0, the automatic filtering logic will be disabled.

Default Setting

If the QuadrilateralDetectionModes is not configured in your template file, the following setting will be used as the default setting.

{
    "QuadrilateralDetectionModes" : 
    [
        {
            "Mode" : "QDM_GENERAL",
            "MinQuadrilateralAreaRatio" : 0
        }
    ]
}

QuadrilateralDetectionModes

JSON Structure

Parameter Details

Mode Arguments

Default Setting

Candidate Mode Introductions

QDM_GENERAL

QDM_SKIP