Merge pull request #1508 from VWS-Python/processed-tracking-rating-callable

Processed tracking rating - more realistic

Author: adamtheturtle

docs/source/differences-to-vws.rst

@@ -29,16 +29,13 @@ Image quality and ratings
 -------------------------
 
 Targets are assigned a rating between 0 and 5 of how good they are for tracking purposes.
-In the mock this is a random number between 0 and 5.
+In the mock this is calculated from the image quality, differently to how Vuforia does this.
 
 Image targets which are not suited to detection are given 'failed' statuses.
 The criteria for these images is not defined by the Vuforia documentation.
 The mock is more forgiving than the real Vuforia Web Services.
 Therefore, an image given a 'success' status by the mock may not be given a 'success' status by the real Vuforia Web Services.
 
-When updating an image for a target on the real Vuforia Web Services, the rating may stay the same.
-The mock changes the rating for a target to a different random number when the image is changed.
-
 Matching targets in the processing state
 ----------------------------------------
 

pyproject.toml

@@ -140,6 +140,7 @@ warn_untyped_fields = true
 [[tool.mypy.overrides]]
 
 module = [
+    "brisque",
     "docker",
     "docker.errors",
     "docker.models.networks",
@@ -250,8 +251,10 @@ readme = { file = "README.rst", content-type = "text/x-rst"}
 requires-python = ">=3.10"
 dependencies = [
     "Pillow",
+    "brisque",
     "flask",
     "multipart",
+    "numpy",
     "pydantic",
     "requests",
     "requests-mock",

src/mock_vws/_flask_server/dockerfiles/target_manager/Dockerfile

@@ -1,12 +1,13 @@
 FROM python:3.11-slim-buster
+RUN apt update && apt install -y gcc g++ libgl1-mesa-glx libglib2.0-0
 # We set this pretend version as we do not have Git in our path, and we do
 # not care enough about having the version correct inside the Docker container
 # to install it.
 ENV SETUPTOOLS_SCM_PRETEND_VERSION=0.0.0
 ENV TARGET_MANAGER_HOST=0.0.0.0
 COPY . /app
 WORKDIR /app
-RUN pip install .
+RUN pip install --upgrade .
 EXPOSE 5000
 ENTRYPOINT ["python"]
 CMD ["src/mock_vws/_flask_server/target_manager.py"]

src/mock_vws/_flask_server/dockerfiles/vwq/Dockerfile

@@ -1,12 +1,13 @@
 FROM python:3.11-slim-buster
+RUN apt update && apt install -y gcc g++ libgl1-mesa-glx libglib2.0-0
 # We set this pretend version as we do not have Git in our path, and we do
 # not care enough about having the version correct inside the Docker container
 # to install it.
 ENV SETUPTOOLS_SCM_PRETEND_VERSION=0.0.0
 ENV VWQ_HOST=0.0.0.0
 COPY . /app
 WORKDIR /app
-RUN pip install .
+RUN pip install --upgrade .
 EXPOSE 5000
 ENTRYPOINT ["python"]
 CMD ["src/mock_vws/_flask_server/vwq.py"]

src/mock_vws/_flask_server/dockerfiles/vws/Dockerfile

@@ -1,12 +1,13 @@
 FROM python:3.11-slim-buster
+RUN apt update && apt install -y gcc g++ libgl1-mesa-glx libglib2.0-0
 COPY . /app
 # We set this pretend version as we do not have Git in our path, and we do
 # not care enough about having the version correct inside the Docker container
 # to install it.
 ENV SETUPTOOLS_SCM_PRETEND_VERSION=0.0.0
 ENV VWS_HOST=0.0.0.0
 WORKDIR /app
-RUN pip install .
+RUN pip install --upgrade .
 EXPOSE 5000
 ENTRYPOINT ["python"]
 CMD ["src/mock_vws/_flask_server/vws.py"]

src/mock_vws/_flask_server/target_manager.py

@@ -5,7 +5,6 @@
 import base64
 import dataclasses
 import datetime
-import random
 from http import HTTPStatus
 from zoneinfo import ZoneInfo
 
@@ -212,12 +211,6 @@ def update_target(database_name: str, target_id: str) -> tuple[str, int]:
     if "image" in request.json:
         image_value = base64.b64decode(s=request.json["image"])
 
-    # In the real implementation, the tracking rating can stay the same.
-    # However, for demonstration purposes, the tracking rating changes but
-    # when the target is updated.
-    available_values = list(set(range(6)) - {target.tracking_rating})
-    processed_tracking_rating = random.choice(available_values)
-
     gmt = ZoneInfo("GMT")
     last_modified_date = datetime.datetime.now(tz=gmt)
 
@@ -228,7 +221,6 @@ def update_target(database_name: str, target_id: str) -> tuple[str, int]:
         active_flag=active_flag,
         application_metadata=application_metadata,
         image_value=image_value,
-        processed_tracking_rating=processed_tracking_rating,
         last_modified_date=last_modified_date,
     )
 

src/mock_vws/_requests_mock_server/mock_web_services_api.py

@@ -11,7 +11,6 @@
 import dataclasses
 import datetime
 import email.utils
-import random
 import uuid
 from http import HTTPStatus
 from typing import TYPE_CHECKING
@@ -590,12 +589,6 @@ def update_target(
             context.status_code = fail_exception.status_code
             return fail_exception.response_text
 
-        # In the real implementation, the tracking rating can stay the same.
-        # However, for demonstration purposes, the tracking rating changes but
-        # when the target is updated.
-        available_values = list(set(range(6)) - {target.tracking_rating})
-        processed_tracking_rating = random.choice(available_values)
-
         gmt = ZoneInfo("GMT")
         last_modified_date = datetime.datetime.now(tz=gmt)
 
@@ -606,7 +599,6 @@ def update_target(
             active_flag=active_flag,
             application_metadata=application_metadata,
             image_value=image_value,
-            processed_tracking_rating=processed_tracking_rating,
             last_modified_date=last_modified_date,
         )
 

src/mock_vws/target.py

@@ -6,13 +6,15 @@
 import base64
 import datetime
 import io
-import random
+import math
 import statistics
 import uuid
 from dataclasses import dataclass, field
 from typing import TypedDict
 from zoneinfo import ZoneInfo
 
+import brisque
+import numpy as np
 from PIL import Image, ImageStat
 
 from mock_vws._constants import TargetStatuses
@@ -28,7 +30,6 @@ class TargetDict(TypedDict):
     image_base64: str
     active_flag: bool
     processing_time_seconds: int | float
-    processed_tracking_rating: int
     application_metadata: str | None
     target_id: str
     last_modified_date: str
@@ -51,11 +52,24 @@ def _time_now() -> datetime.datetime:
     return datetime.datetime.now(tz=gmt)
 
 
-def _random_tracking_rating() -> int:
+def _quality(image_content: bytes) -> int:
     """
-    Return a random tracking rating.
+    Args:
+        image_content: The image content.
+
+    Returns:
+        The quality of the image.
     """
-    return random.randint(0, 5)
+    image_file = io.BytesIO(initial_bytes=image_content)
+    image = Image.open(fp=image_file)
+    image_array = np.asarray(a=image)
+    obj = brisque.BRISQUE(url=False)
+    # We avoid a barrage of warnings from the BRISQUE library.
+    with np.errstate(divide="ignore", invalid="ignore"):
+        score = obj.score(img=image_array)
+    if math.isnan(score):
+        return 0
+    return int(score / 20)
 
 
 @dataclass(frozen=True, eq=True)
@@ -75,9 +89,6 @@ class Target:
     delete_date: datetime.datetime | None = None
     last_modified_date: datetime.datetime = field(default_factory=_time_now)
     previous_month_recos: int = 0
-    processed_tracking_rating: int = field(
-        default_factory=_random_tracking_rating,
-    )
     reco_rating: str = ""
     target_id: str = field(default_factory=_random_hex)
     total_recos: int = 0
@@ -158,7 +169,7 @@ def tracking_rating(self) -> int:
             return -1
 
         if self._post_processing_status == TargetStatuses.SUCCESS:
-            return self.processed_tracking_rating
+            return _quality(image_content=self.image_value)
 
         return 0
 
@@ -173,7 +184,6 @@ def from_dict(cls, target_dict: TargetDict) -> Target:
         width = target_dict["width"]
         image_base64 = target_dict["image_base64"]
         image_value = base64.b64decode(image_base64)
-        processed_tracking_rating = target_dict["processed_tracking_rating"]
         processing_time_seconds = target_dict["processing_time_seconds"]
         application_metadata = target_dict["application_metadata"]
         target_id = target_dict["target_id"]
@@ -202,7 +212,6 @@ def from_dict(cls, target_dict: TargetDict) -> Target:
             delete_date=delete_date,
             last_modified_date=last_modified_date,
             upload_date=upload_date,
-            processed_tracking_rating=processed_tracking_rating,
         )
 
     def to_dict(self) -> TargetDict:
@@ -221,7 +230,6 @@ def to_dict(self) -> TargetDict:
             "image_base64": image_base64,
             "active_flag": self.active_flag,
             "processing_time_seconds": self.processing_time_seconds,
-            "processed_tracking_rating": self.processed_tracking_rating,
             "application_metadata": self.application_metadata,
             "target_id": self.target_id,
             "last_modified_date": self.last_modified_date.isoformat(),