I04_1-156: moved some overlays to utils

Author: IsabellaRey

dls_barcode/camera/camera_scanner.py

@@ -5,16 +5,16 @@
 import queue
 
 # TODO: tidy up
-from dls_util.image import Image, Color
+from dls_util.image import Image
 from dls_util import Beeper
 from dls_util.message import MessageType, Message
 from dls_barcode.scan import GeometryScanner, SlotScanner, OpenScanner
 from dls_barcode.datamatrix import DataMatrix
-from .overlay import PlateOverlay, TextOverlay
 from .capture_worker import CaptureWorker
 from .camera_position import CameraPosition
 from .stream_action import StreamAction
 from .capture_command import CaptureCommand
+from .plate_overlay import PlateOverlay
 
 Q_LIMIT = 1
 SCANNED_TAG = "Scan Complete"

dls_barcode/camera/capture_worker.py

@@ -1,7 +1,7 @@
 import time
 import queue
 
-from .overlay import Overlay
+from dls_util.image import Overlay
 from .stream_action import StreamAction
 from dls_util.image import Image
 from dls_util.cv import CameraStream

dls_barcode/camera/plate_overlay.py

@@ -0,0 +1,23 @@
+from dls_util.image import Overlay, Image, Color
+
+
+class PlateOverlay(Overlay):
+    """ Represents an overlay that can be drawn on top of an image. Used to draw the outline of a plate
+    on the continuous scanner camera image to highlight to the user which barcodes on the plate have
+    already been scanned.
+    """
+    def __init__(self, plate, options, lifetime=2):
+        Overlay.__init__(self, lifetime)
+
+        self._plate = plate
+        self._options = options
+
+    def draw_on_image(self, img):
+        """ Draw the plate highlight  to the image.
+        """
+        image = Image(img)
+
+        # If the overlay has not expired, draw on the plate highlight and/or the status message
+        if not self.has_expired():
+            self._plate.draw_plate(image, Color.Blue())
+            self._plate.draw_pins(image, self._options)

dls_barcode/gui/main_window.py

@@ -7,6 +7,7 @@
 from dls_barcode.camera import CameraScanner, CameraSwitch
 from dls_util import Beeper
 from dls_util.file import FileManager
+from dls_util.message import MessageType, Message
 from .barcode_table import BarcodeTable
 from .image_frame import ImageFrame
 from .record_table import ScanRecordTable
@@ -190,7 +191,6 @@ def _read_view_queue(self):
             except queue.Empty:
                 pass
 
-    # todo: refactor this uglyness (above too)
     def _read_message_queue(self):
         if not self._message_queue.empty():
             try:
@@ -230,6 +230,7 @@ def _read_side_scan(self):
     def _read_top_scan(self):
         if self._result_queue.empty():
             if self._camera_switch.is_top_scan_timeout():
+                self._message_display.display_message(Message(MessageType.INFO, "Scan timeout"))
                 print("\n*** Scan timeout ***")
                 self._camera_switch.restart_live_capture_from_side()
             return

dls_util/image/__init__.py

@@ -1,2 +1,3 @@
 from .color import Color
 from .image import Image
+from .overlay import Overlay

dls_barcode/camera/overlay.py dls_util/image/overlay.pydls_barcode/camera/overlay.py renamed to dls_util/image/overlay.py

@@ -1,22 +1,19 @@
 import time
 
 from dls_util.image import Image, Color
+from dls_util.object_with_lifetime import ObjectWithLifetime
 
 
-class Overlay:
+class Overlay(ObjectWithLifetime):
     """ Abstract base class. Represents an overlay that can be drawn on top of an image. Has a specified lifetime
     so that the overlay will only be displayed for a short time.
     """
     def __init__(self, lifetime):
-        self._lifetime = lifetime
-        self._start_time = time.time()
+        ObjectWithLifetime.__init__(self, lifetime)
 
     def draw_on_image(self, img):
         pass
 
-    def has_expired(self):
-        return (time.time() - self._start_time) > self._lifetime
-
 
 class TextOverlay(Overlay):
     """ Represents an overlay that can be drawn on top of an image. Used to write status text messages.
@@ -40,24 +37,5 @@ def draw_on_image(self, img):
                             centered=True, scale=2, thickness=3)
 
 
-class PlateOverlay(Overlay):
-    """ Represents an overlay that can be drawn on top of an image. Used to draw the outline of a plate
-    on the continuous scanner camera image to highlight to the user which barcodes on the plate have
-    already been scanned.
-    """
-    def __init__(self, plate, options, lifetime=2):
-        Overlay.__init__(self, lifetime)
-
-        self._plate = plate
-        self._options = options
-
-    def draw_on_image(self, img):
-        """ Draw the plate highlight  to the image.
-        """
-        image = Image(img)
 
-        # If the overlay has not expired, draw on the plate highlight and/or the status message
-        if not self.has_expired():
-            self._plate.draw_plate(image, Color.Blue())
-            self._plate.draw_pins(image, self._options)
 

dls_util/object_with_lifetime.py

@@ -0,0 +1,12 @@
+import time
+
+
+class ObjectWithLifetime:
+    """ Abstract base class. Has a specified lifetime.
+    """
+    def __init__(self, lifetime):
+        self._lifetime = lifetime
+        self._start_time = time.time()
+
+    def has_expired(self):
+        return (time.time() - self._start_time) > self._lifetime