Issue384 (#388)

* Initial (untested) support

* Fixed logic, seems to work

Author: danecreekphotography

.devcontainer/triggers.json

@@ -30,6 +30,14 @@
         "minimum": 50,
         "maximum": 100
       },
+      "activateRegions": [
+        {
+          "xMinimum": 124,
+          "xMaximum": 200,
+          "yMinimum": 30,
+          "yMaximum": 200
+        }
+      ],
       "handlers": {
         "webRequest": {
           "triggerUris": ["http://localhost:81/admin?trigger&camera=Dog&memo={{formattedPredictions}}"]

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 5.4.0
+
+- Triggers can now specify `activateRegions` which have the opposite effect of masks. If activateRegions are specified then the triggering
+  object's bounding box must overlap with the activate region for the trigger to fire. Resolves [issue 384](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/384).
+
 ## 5.3.1
 
 - File watching now works on Macs when the folder of images is a mounted network share. Resolves [issue 362](https://github.com/danecreekphotography/node-deepstackai-trigger/issues/362).

src/Trigger.ts

@@ -41,6 +41,7 @@ export default class Trigger {
   public enabled = true;
   public name: string;
   public masks: Rect[];
+  public activateRegions: Rect[];
   public receivedDate: Date;
   public snapshotUri?: string;
   public threshold: {
@@ -214,7 +215,8 @@ export default class Trigger {
     const isTriggered =
       this.isRegisteredForObject(fileName, label) &&
       this.confidenceMeetsThreshold(fileName, scaledConfidence) &&
-      !this.isMasked(fileName, prediction);
+      !this.isMasked(fileName, this.masks, true, prediction) &&
+      this.isMasked(fileName, this.activateRegions, false, prediction);
 
     if (!isTriggered) {
       log.verbose(`Trigger ${this.name}`, `${fileName}: Not triggered by ${label} (${scaledConfidence})`);
@@ -227,21 +229,46 @@ export default class Trigger {
   /**
    * Checks to see if predictions overlap the list of masks defined in the trigger
    * @param fileName The filename of the image being evaluated
+   * @param masks The array of masks to check against
+   * @param block True if this is a blocking mask.
    * @param predictions The list of predictions found in the image
    * @returns True if any of the predictions are masked
    */
-  public isMasked(fileName: string, prediction: IDeepStackPrediction): boolean {
-    if (!this.masks) {
+  public isMasked(fileName: string, masks: Rect[], block: boolean, prediction: IDeepStackPrediction): boolean {
+    // If no masks are specified and this is a blocking mask return false since nothing could possibly be blocked.
+    if (!masks && block) {
+      log.verbose(
+        `Trigger ${this.name}`,
+        "No blocking masks specified and block is true so skipping blocking masks check.",
+      );
       return false;
     }
 
+    // If no masks are specified and this is a non-blocking mask return true since everything should get accepted
+    // to maintain backwards compatibility.
+    if (!masks && !block) {
+      log.verbose(
+        `Trigger ${this.name}`,
+        "No activate masks specified and block is false so skipping activate masks check.",
+      );
+      return true;
+    }
+
     // Loop through the masks to see if any overlap the prediction
-    const result = this.masks.some(mask => {
+    const result = masks.some(mask => {
       const predictionRect = new Rect(prediction.x_min, prediction.y_min, prediction.x_max, prediction.y_max);
       const doesOverlap = mask.overlaps(predictionRect);
 
       if (doesOverlap) {
-        log.verbose(`Trigger ${this.name}`, `Prediction region ${predictionRect} blocked by trigger mask ${mask}.`);
+        log.verbose(
+          `Trigger ${this.name}`,
+          `Prediction region ${predictionRect} ${block ? "blocked" : "activated"} by mask ${mask}.`,
+        );
+      } else {
+        log.verbose(
+          `Trigger ${this.name}`,
+          `Prediction region ${predictionRect} does not overlap with ${block ? "block" : "activate"} region ${mask}.`,
+        );
       }
 
       return doesOverlap;

src/TriggerManager.ts

@@ -89,6 +89,10 @@ export function loadConfiguration(configFilePaths: string[]): string {
     configuredTrigger.masks = triggerJson.masks?.map(
       mask => new Rect(mask.xMinimum, mask.yMinimum, mask.xMaximum, mask.yMaximum),
     );
+    // Set up the masks as real objects
+    configuredTrigger.activateRegions = triggerJson.activateRegions?.map(
+      mask => new Rect(mask.xMinimum, mask.yMinimum, mask.xMaximum, mask.yMaximum),
+    );
 
     // Set up the handlers
     if (triggerJson.handlers.mqtt) {

src/schemas/triggerConfiguration.schema.json

@@ -117,6 +117,14 @@
               "$ref": "https://raw.githubusercontent.com/danecreekphotography/node-deepstackai-trigger/main/src/schemas/maskConfiguration.schema.json"
             }
           },
+          "activateRegions": {
+            "description": "A list of rectangles that activate the trigger if a detected object overlaps the rectangle.",
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "$ref": "https://raw.githubusercontent.com/danecreekphotography/node-deepstackai-trigger/main/src/schemas/maskConfiguration.schema.json"
+            }
+          },
           "watchObjects": {
             "description": "A list of objects the trigger will activate on.",
             "type": "array",

src/types/ITriggerJson.ts

@@ -31,4 +31,5 @@ export default interface ITriggerJson {
   };
 
   masks: Rect[];
+  activateRegions: Rect[];
 }