DocumentReader-web-js-client/src/models/image-qa.ts at 683098679f9a091357de548bf054ee57d1d32d89 · regulaforensics/DocumentReader-web-js-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/* tslint:disable */
/* eslint-disable */
/**
 * NOTE: This file is auto generated by OpenAPI Generator.
 * Do not edit the file manually.
 */


// May contain unused imports in some cases
// @ts-ignore
import type { GlaresCheckParams } from './glares-check-params';
// May contain unused imports in some cases
// @ts-ignore
import type { InputImageQualityChecks } from './input-image-quality-checks';

/**
 *
 * @export
 * @interface ImageQA
 */
export interface ImageQA {
    /**
     * Set the threshold for an actual document brightness below which the check fails
     * @type {number}
     * @memberof ImageQA
     */
    'brightnessThreshold'?: number;
    /**
     * This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.
     * @type {number}
     * @memberof ImageQA
     */
    'dpiThreshold'?: number;
    /**
     * This parameter sets threshold for Image QA check of the presented document perspective angle in degrees. If actual document perspective angle is above this threshold, check will fail.
     * @type {number}
     * @memberof ImageQA
     */
    'angleThreshold'?: number;
    /**
     * This option enables focus check while performing image quality validation.
     * @type {boolean}
     * @memberof ImageQA
     */
    'focusCheck'?: boolean;
    /**
     * This option enables glares check while performing image quality validation.
     * @type {boolean}
     * @memberof ImageQA
     */
    'glaresCheck'?: boolean;
    /**
     * This option enables colorness check while performing image quality validation.
     * @type {boolean}
     * @memberof ImageQA
     */
    'colornessCheck'?: boolean;
    /**
     * This option enables screen capture (moire patterns) check while performing image quality validation.
     * @type {boolean}
     * @memberof ImageQA
     */
    'moireCheck'?: boolean;
    /**
     * This parameter specifies the necessary margin. Default 0.
     * @type {number}
     * @memberof ImageQA
     */
    'documentPositionIndent'?: number;
    /**
     * This parameter controls the quality checks that the image should pass to be considered a valid input during the scanning process.
     * @type {Array<InputImageQualityChecks>}
     * @memberof ImageQA
     */
    'expectedPass'?: Array<InputImageQualityChecks>;
    /**
     *
     * @type {GlaresCheckParams}
     * @memberof ImageQA
     */
    'glaresCheckParams'?: GlaresCheckParams;
}