Added FPS counter

README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-# blokbot.io | OpenBlok
+# OpenBlok | blokbot.io
 
 [![CI | Pylint](https://github.com/blokbot-io/OpenBlok/actions/workflows/pylint.yml/badge.svg)](https://github.com/blokbot-io/OpenBlok/actions/workflows/pylint.yml)
 &nbsp;
@@ -12,7 +12,7 @@
 
 ## Table of Contents
 
-- [blokbot.io | OpenBlok](#blokbotio--openblok)
+- [OpenBlok | blokbot.io](#openblok--blokbotio)
   - [Table of Contents](#table-of-contents)
   - [Hardware Requirements](#hardware-requirements)
   - [Installation](#installation)

bloks/display.py

@@ -14,18 +14,12 @@
 import numpy as np
 from screeninfo import get_monitors  # Required to get monitor info
 
-
 from bloks import camera, serial  # , upload
-
-
-from bloks.utils import annotate, preprocess, bounding_boxes, crop_square
-
+from bloks.utils import annotate, preprocess, stats, bounding_boxes, crop_square
 
 from modeled import location, e2e
 
-
-# if os.environ.get('DISPLAY', '') == '':
-#     os.environ.__setitem__('DISPLAY', ':0.0')
+STATS = stats.Stats()
 
 
 def predict_and_show():
@@ -48,6 +42,8 @@ def predict_and_show():
         frame, frame_time = camera.grab_frame()  # Grab frame
         frame_time = Decimal(frame_time)        # Copy frame & time
 
+        STATS.add_frame_time(frame_time)        # Add frame time to stats
+
         preprocessed_frame = preprocess.capture_regions(
             frame)      # Preprocess frame
         # Frame to add annotations to
@@ -195,13 +191,13 @@ def predict_and_show():
             cv2.FONT_HERSHEY_DUPLEX, 3, (255, 0, 0), 5
         )
 
-        # Note: Extra?
-        # Display the resulting frame
-        # cv2.imshow('frame', combined_layers)
-
-        # Press Q on keyboard to  exit
-        # if cv2.waitKey(1) & 0xFF == ord('q'):
-        # break
+        # Display FPS in the upper right
+        combined_layers = cv2.putText(
+            combined_layers,
+            f"FPS: {STATS.fps}",
+            (combined_layers.shape[1]-300, 100),
+            cv2.FONT_HERSHEY_DUPLEX, 3, (255, 0, 0), 5
+        )
 
         # ----------------------------- Display ----------------------------- #
         # Resize image to fit monitor (does not maintain aspect ratio)

bloks/utils/stats.py

@@ -0,0 +1,24 @@
+''' OpenBlok | bloks | utils | stats.py '''
+
+
+class Stats:
+    ''' Running statistics '''
+
+    def __init__(self):
+        self.frame_time_log = []
+
+    def add_frame_time(self, frame_time):
+        '''
+        Stores time stamps for 1 second of frames
+        '''
+        time_difference = frame_time - self.frame_time_log[0]
+        if time_difference > 1:
+            self.frame_time_log.pop(0)
+
+        self.frame_time_log.append(frame_time)
+
+    def fps(self):
+        '''
+        Calculate frames per second
+        '''
+        return len(self.frame_time_log)