DocumentReader-web-openapi/rt-image-quality.yml at develop · regulaforensics/DocumentReader-web-openapi · 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
openapi: 3.0.4
components:
  schemas:
    ImageQualityCheckListItem:
      title: "ImageQualityCheckListItem"
      type: object
      required:
        - ImageQualityCheckList
      properties:
        ImageQualityCheckList:
          $ref: "#/components/schemas/ImageQualityCheckList"

    ImageQualityCheckList:
      title: "ImageQualityCheckList"
      type: object
      required:
        - result
        - List
        - Count
      properties:
        result: # Overall image quality status, combined from check statuses in the list.
          $ref: "./common.yml#/components/schemas/CheckResult"
        List:
          type: array
          items:
            $ref: "#/components/schemas/ImageQualityCheck"
        Count:
          description: "Number of List array elements"
          type: number

    ImageQualityCheckType:
      title: "ImageQualityCheckType"
      type: integer
      description: "Image quality check type"
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 7
        - 8
        - 9
        - 10
      x-enum-varnames:
        - "ImageGlares"
        - "ImageFocus"
        - "ImageResolution"
        - "ImageColorness"
        - "Perspective"
        - "Bounds"
        - "Portrait"
        - "Handwritten"
        - "Brightness"
        - "Occlusion"
      x-enum-descriptions:
        - "Signals glare presence on the image"
        - "Signals whether image is in focus"
        - "Signals if image resolution is below threshold"
        - "Signals if image is colorless"
        - "Signals if document in the image has prespective distortion above threshold"
        - "Signals if document is not fully present in the image"
        - "Signals if the portrait is present"
        - "Signals if the document contains handwritten text in the scanned fields"
        - "Signals if the document image is bright enough"
        - "Signals if the document image has occlusion"

    InputImageQualityChecks:
      title: "InputImageQualityChecks"
      type: string
      description: "Input image quality checks for the document processing"
      enum:
        - "glaresCheck"
        - "focusCheck"
        - "dpiThreshold"
        - "colornessCheck"
        - "perspectiveCheck"
        - "documentPosition"
        - "portraitCheck"
        - "brightnessCheck"
        - "occlusionCheck"
      x-enum-varnames:
        - "Glares"
        - "Focus"
        - "Resolution"
        - "Colorness"
        - "Perspective"
        - "Bounds"
        - "Portrait"
        - "Brightness"
        - "Occlusion"
      x-enum-descriptions:
        - "Signals glare presence on the image"
        - "Signals whether image is in focus"
        - "Signals if image resolution is below threshold"
        - "Signals if image is colorless"
        - "Signals if document in the image has prespective distortion above threshold"
        - "Signals if document is not fully present in the image"
        - "Signals if the portrait is present"
        - "Signals if the document image is bright enough"
        - "Signals if the document image has occlusion"

    AreaArray:
      title: "AreaArray"
      type: object
      required:
        - Count
        - List
        - Points
      properties:
        Count:
          description: "Number of elements in List and Points"
          type: number
        List:
          type: array
          items:
            $ref: "./common.yml#/components/schemas/RectangleCoordinates"
        Points:
          type: array
          items:
            $ref: "#/components/schemas/PointArray"

    PointArray:
      title: "PointArray"
      type: object
      required:
        - PointsList
      properties:
        PointsList:
          type: array
          items:
            $ref: "./common.yml#/components/schemas/Point"

    ImageQualityCheck:
      title: "ImageQualityCheck"
      type: object
      required:
        - type
        - result
        - featureType
        - mean
        - std_dev
        - probability
      properties:
        type:
          $ref: "#/components/schemas/ImageQualityCheckType"
        result:
          $ref: "./common.yml#/components/schemas/CheckResult"
        featureType:
          $ref: "./e-security-feature-type.yml#/components/schemas/SecurityFeatureType"
        areas:
          $ref: "#/components/schemas/AreaArray"
        mean:
          description: "Check mean value"
          type: number
          format: float
        std_dev:
          description: "Check deviation value"
          type: number
          format: float
        probability:
          description: "Check probability value"
          type: integer