Rename raw-image to document-image

Author: hleb-albau

.gitignore

@@ -1,6 +1,6 @@
 .idea
-example/portraitFromVisual.jpg
-example/normalizedInputImage.jpg
+example/portrait.jpg
+example/document-image.jpg
 
 
 # Byte-compiled / optimized / DLL files

example/example.py

@@ -12,11 +12,11 @@
     input_image = f.read()
 
 with DocumentReaderApi(host) as api:
-    api.license = license  # used here only for smoke test purposes, most of clients will attach license on server side
+    api.license = license  # used here only for smoke test purposes, most clients will attach license on server side
 
     params = ProcessParams(
         scenario=Scenario.FULL_PROCESS,
-        result_type_output=[Result.RAW_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
+        result_type_output=[Result.DOCUMENT_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
     )
     request = RecognitionRequest(process_params=params, images=[input_image])
     response = api.process(request)
@@ -34,11 +34,11 @@
     doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
 
     # images fields example
-    normalized_input_image = response.images.normalized_input_image()
+    document_image = response.images.document_image()
     portrait_Field = response.images.get_field(GraphicFieldType.PORTRAIT)
     portrait_From_Visual = portrait_Field.get_value(Source.VISUAL)
-    with open('portraitFromVisual.jpg', 'wb') as f: f.write(portrait_From_Visual)
-    with open('normalizedInputImage.jpg', 'wb') as f: f.write(normalized_input_image)
+    with open('portrait.jpg', 'wb') as f: f.write(portrait_From_Visual)
+    with open('document-image.jpg', 'wb') as f: f.write(document_image)
 
     # low-lvl(original) response
     response.low_lvl_response

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

@@ -26,22 +26,32 @@ def get_value(self, source: str = None, original=False) -> Optional[bytes]:
 
 
 class Images(GenImages):
-    _normalized_input_images_results = None
+    _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 normalized_input_image(self) -> Optional[bytes]:
-        images = self.normalized_input_images()
+    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 normalized_input_images(self) -> Optional[List[bytes]]:
-        if self._normalized_input_images_results:
+    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._normalized_input_images_results]
+                    for image in self._document_images_results]
         return None

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

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