Redo add images module

Author: hleb-albau

.gitignore

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

example/example.py

@@ -2,8 +2,8 @@
 
 from regula.documentreader.webclient.ext.api import DocumentReaderApi
 from regula.documentreader.webclient.ext.models import RecognitionRequest
-from regula.documentreader.webclient.gen import ProcessParams, Scenario, Result, TextFieldType, Source, \
-    CheckResult
+from regula.documentreader.webclient.gen.models import ProcessParams, Scenario, Result, TextFieldType, Source, \
+    CheckResult, GraphicFieldType
 
 host = os.getenv("API_BASE_PATH", "http://localhost:8080")
 license = os.getenv("TEST_LICENSE", None)  # optional, used here only for smoke test purposes
@@ -16,7 +16,7 @@
 
     params = ProcessParams(
         scenario=Scenario.FULL_PROCESS,
-        result_type_output=[Result.STATUS, Result.TEXT, Result.IMAGES]
+        result_type_output=[Result.RAW_IMAGE, Result.STATUS, Result.TEXT, Result.IMAGES]
     )
     request = RecognitionRequest(process_params=params, images=[input_image])
     response = api.process(request)
@@ -33,7 +33,15 @@
     doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
     doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
 
-    response_images = response.images
+    # images fields example
+    normalized_input_image = response.images.normalized_input_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)
+
+    # low-lvl(original) response
+    response.low_lvl_response
 
     print("""
     ---------------------------------------------------------------------------

regula/documentreader/webclient/ext/__init__.py

@@ -1,8 +1,2 @@
 from regula.documentreader.webclient.ext.api.document_reader_api import DocumentReaderApi
 
-from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
-from regula.documentreader.webclient.ext.models.recognition_request import RecognitionImage
-from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest
-from regula.documentreader.webclient.ext.models.recognition_response import RecognitionResponse
-from regula.documentreader.webclient.ext.models.text import Text
-from regula.documentreader.webclient.ext.models.text_field import TextField

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

@@ -1,3 +1,4 @@
+from regula.documentreader.webclient.ext.models.images import Images, ImagesField
 from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionImage
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest

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

@@ -0,0 +1,47 @@
+import base64
+from typing import Optional, List
+
+from regula.documentreader.webclient.gen.models import Images as GenImages, ImagesField as GetImagesField, Source
+
+
+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)
+        else:
+            for v in self.value_list:
+                if v.source == source:
+                    field_value = v
+
+        if not field_value:
+            return None
+
+        if original:
+            return base64.b64decode(field_value.original_value)
+        return base64.b64decode(field_value.value)
+
+
+class Images(GenImages):
+    _normalized_input_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()
+        if not images:
+            return None
+        return images.pop()
+
+    def normalized_input_images(self) -> Optional[List[bytes]]:
+        if self._normalized_input_images_results:
+            return [base64.b64decode(image.raw_image_container.image)
+                    for image in self._normalized_input_images_results]
+        return None

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

@@ -1,8 +1,8 @@
-from typing import Optional
+from typing import Optional, List
 
+from regula.documentreader.webclient.ext.models.images import Images
 from regula.documentreader.webclient.ext.models.text import Text
 from regula.documentreader.webclient.gen import ResultItem
-from regula.documentreader.webclient.gen.models.images import Images
 from regula.documentreader.webclient.gen.models.process_response import ProcessResponse
 from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.status import Status
@@ -11,7 +11,7 @@
 class RecognitionResponse:
 
     def __init__(self, process_response: ProcessResponse):
-        self.__process_response = process_response
+        self.low_lvl_response = process_response
 
     @property
     def text(self) -> Optional[Text]:
@@ -31,11 +31,15 @@ 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)
             return result.images
         return None
 
     def result_by_type(self, result_type) -> Optional[ResultItem]:
-        for i in self.__process_response.container_list.list:
+        for i in self.low_lvl_response.container_list.list:
             if i.result_type == result_type:
                 return i
         return None
+
+    def results_by_type(self, result_type) -> List[ResultItem]:
+        return [r for r in self.low_lvl_response.container_list.list if r.result_type == result_type]

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

@@ -1,7 +1,7 @@
 from typing import Optional, List
 
 from regula.documentreader.webclient.ext.models.text_field import TextField
-from regula.documentreader.webclient.gen.models.text import Text as GenText
+from regula.documentreader.webclient.gen.models import Text as GenText
 
 
 class Text(GenText):