use images document image, instead of own rt

Author: hleb-albau

example/example.py

@@ -22,7 +22,7 @@
 
     params = ProcessParams(
         scenario=Scenario.FULL_PROCESS,
-        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
+        result_type_output=[Result.STATUS, Result.TEXT, Result.IMAGES]
     )
     request = RecognitionRequest(process_params=params, images=[input_image])
     response = api.process(request)
@@ -40,9 +40,8 @@
     doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
 
     # images fields example
-    document_image = response.images.document_image()
-    portrait_field = response.images.get_field(GraphicFieldType.PORTRAIT)
-    portrait_from_visual = portrait_field.get_value(Source.VISUAL)
+    document_image = response.images.get_field(GraphicFieldType.DOCUMENT_FRONT).get_value()
+    portrait_from_visual = response.images.get_field(GraphicFieldType.PORTRAIT).get_value(Source.VISUAL)
     with open('portrait.jpg', 'wb') as f:
         f.write(portrait_from_visual)
     with open('document-image.jpg', 'wb') as f:

regula/documentreader/webclient/ext/models/images.py

@@ -7,51 +7,34 @@
 class ImagesField(GetImagesField):
 
     def get_value(self, source: str = None, original=False) -> Optional[bytes]:
-        field_value = None
+
         if not source:
-            field_value = self.get_value(Source.RFID)
-            if not field_value: field_value = self.get_value(Source.VISUAL)
-            if not field_value: field_value = self.get_value(Source.BARCODE)
+            value = self.get_value(Source.RFID)
+            if not value: value = self.get_value(Source.VISUAL)
+            if not value: value = self.get_value(Source.BARCODE)
+            if not value: value = self.get_value("UNKNOWN") # temp fix, will be removed
+            return value
         else:
+            field_value = None
             for v in self.value_list:
                 if v.source == source:
                     field_value = v
 
-        if not field_value:
-            return None
+            if not field_value:
+                return None
 
-        if original:
-            return base64.b64decode(field_value.original_value)
-        return base64.b64decode(field_value.value)
+            if original:
+                return base64.b64decode(field_value.original_value)
+            return base64.b64decode(field_value.value)
 
 
 class Images(GenImages):
-    _document_images_results = None
 
     def get_field(self, field_type: int) -> Optional[ImagesField]:
         for field in self.field_list:
             if field.field_type == field_type:
                 return field
         return None
 
-    def document_image(self) -> Optional[bytes]:
-        """
-           Contains cropped and rotated with perspective compensation image of document.
-           Single input image can contain multiple document side/pages, which will be returned as separated results.
-           Most coordinates in other types defined on that image.
-        """
-        images = self.document_images()
-        if not images:
-            return None
-        return images.pop()
-
-    def document_images(self) -> Optional[List[bytes]]:
-        """
-           Contains cropped and rotated with perspective compensation image of document.
-           Single input image can contain multiple document side/pages, which will be returned as separated results.
-           Most coordinates in other types defined on that image.
-        """
-        if self._document_images_results:
-            return [base64.b64decode(image.raw_image_container.image)
-                    for image in self._document_images_results]
-        return None
+    def get_fields(self, field_type: int) -> List[ImagesField]:
+        return [field for field in self.field_list if field.field_type == field_type]

regula/documentreader/webclient/ext/models/recognition_response.py

@@ -31,7 +31,6 @@ def status(self) -> Optional[Status]:
     def images(self) -> Optional[Images]:
         result = self.result_by_type(Result.IMAGES)
         if result:
-            result.images._document_images_results = self.results_by_type(Result.DOCUMENT_IMAGE)
             return result.images
         return None