3.1.0 (#50)

* Set version and fix crash

* Add ratio filters for config

* Filter based on ratio

* Formatting

* Add ratio config to config

* Set version

Author: NickM-27

Makefile

@@ -1,7 +1,7 @@
 default_target: local
 
 COMMIT_HASH := $(shell git log -1 --pretty=format:"%h"|tail -1)
-VERSION = 3.0.4
+VERSION = 3.1.0
 
 local:
 	cd web; flutter build web;

docs/config.md

@@ -28,13 +28,17 @@ objects:
           after: "00:00"
           # OPTIONAL: Color variant is valid if current time is < this 24H time (Default: shown below).
           before: "24:00"
-    # OPTIONAL: the min number of pixels with R, G, B values within the bounds to be
-    # considered a true positive. This is recommended to be set as a super small amount
+    # OPTIONAL: the min area of the bounding box around groups of matching R, G, B pixels
+    # considered a true positive. This is not recommended to be set as a super small amount
     # could be a false positive. (Default: shown below)
     min_area: 1000
-    # OPTIONAL: the max number of pixels with R, G, B values within the bounds to be
-    # considered a true positive (Default: shown below).
+    # OPTIONAL: the max area of the bounding box around groups of pixels with R, G, B
+    # values within the bounds to be considered a true positive (Default: shown below).
     max_area: 100000
+    # OPTIONAL: the min ratio of width/height of bounding box for valid object detection (default: shown below).
+    min_ratio: 0
+     # OPTIONAL: the max ratio of width/height of bounding box for valid object detection (default: shown below).
+    max_ratio: 24000000
 ```
 
 ### `cameras`

swatch/config.py

@@ -75,6 +75,12 @@ class ObjectConfig(SwatchBaseModel):
     )
     min_area: int = Field(title="Min Area", default=0)
     max_area: int = Field(title="Max Area", default=240000)
+    min_ratio: float = Field(
+        title="Min ratio of width/height for valid detection.", default=0
+    )
+    max_ratio: float = Field(
+        title="Max ratio of width/height for valid detection.", default=24000000
+    )
 
 
 class ZoneConfig(SwatchBaseModel):

swatch/util.py

@@ -54,12 +54,14 @@ def detect_objects(mask: Any, obj: ObjectConfig) -> Set[Dict[str, Any]]:
         area = w * h
 
         if obj.min_area < area < obj.max_area:
-            detected.append(
-                {
-                    "box": [x, y, x + w, y + h],
-                    "area": area,
-                }
-            )
+            if obj.min_ratio < (w / h) < obj.max_ratio:
+                detected.append(
+                    {
+                        "box": [x, y, x + w, y + h],
+                        "area": area,
+                        "ratio": (w / h),
+                    }
+                )
 
     return detected