Merge pull request #58 from nut-tree/bugfix/57/runtime_error

Closes #57

Author: s1hofmann

jest.config.js

@@ -1,18 +1,18 @@
 module.exports = {
-    preset: "ts-jest",
-    testEnvironment: "node",
-    collectCoverageFrom: [
-        "index.ts",
-        "lib/**/*.ts",
-        "!lib/**/*.spec.ts",
-        "!<rootDir>/node_modules/",
-        "!<rootDir>/path/to/dir/"
-    ],
-    testPathIgnorePatterns: [
-      "/node_modules/",
-      "/dist/"
-    ],
-    testMatch: process.env.E2E_TEST ?
-        [ "**/__tests__/?(e2e)/**/*.[jt]s?(x)", "**/?(*.)?(e2e.)+(spec|test).[jt]s?(x)" ] :
-        [ "**/__tests__/!(e2e)/**/*.[jt]s?(x)", "**/!(*.e2e.*)+(spec|test).[jt]s?(x)" ]
-};
+  collectCoverageFrom: [
+    "index.ts",
+    "lib/**/*.ts",
+    "!lib/**/*.spec.ts",
+    "!<rootDir>/node_modules/",
+    "!<rootDir>/path/to/dir/",
+  ],
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: process.env.E2E_TEST ?
+    ["**/__tests__/?(e2e)/**/*.[jt]s?(x)", "**/?(*.)?(e2e.)+(spec|test).[jt]s?(x)"] :
+    ["**/__tests__/!(e2e)/**/*.[jt]s?(x)", "**/!(*.e2e.*)+(spec|test).[jt]s?(x)"],
+  testPathIgnorePatterns: [
+    "/node_modules/",
+    "/dist/",
+  ],
+};

lib/provider/opencv/image-processor.class.spec.ts

@@ -1,4 +1,5 @@
 import { resolve } from "path";
+import { Region } from "../../region.class";
 import { ImageProcessor } from "./image-processor.class";
 import { ImageReader } from "./image-reader.class";
 
@@ -37,3 +38,45 @@ describe("ImageProcessor", () => {
     expect(mat.empty).toBeFalsy();
   });
 });
+
+describe("ImageProcessor with ROI", () => {
+  it("negative left or top values are updated to 0", async () => {
+    // GIVEN
+    const imageReader = new ImageReader();
+    const imagePath = resolve(__dirname, "./__mocks__/mouse.png");
+    const image = await imageReader.load(imagePath);
+
+    // WHEN
+    const mat = await ImageProcessor.fromImageWithoutAlphaChannel(
+      image,
+      new Region(-100, -100, 10, 10)
+    );
+
+    // THEN
+    expect(image.hasAlphaChannel).toBeFalsy();
+    expect(mat.channels).toEqual(3);
+    expect(mat.rows).toEqual(10);
+    expect(mat.cols).toEqual(10);
+    expect(mat.empty).toBeFalsy();
+  });
+
+  it("values bigger than the input are updated to width and height", async () => {
+    // GIVEN
+    const imageReader = new ImageReader();
+    const imagePath = resolve(__dirname, "./__mocks__/mouse.png");
+    const image = await imageReader.load(imagePath);
+
+    // WHEN
+    const mat = await ImageProcessor.fromImageWithoutAlphaChannel(
+      image,
+      new Region(10, 10, image.width * 2, image.height * 2)
+    );
+
+    // THEN
+    expect(image.hasAlphaChannel).toBeFalsy();
+    expect(mat.channels).toEqual(3);
+    expect(mat.rows).toEqual(image.height - 10);
+    expect(mat.cols).toEqual(image.width - 10);
+    expect(mat.empty).toBeFalsy();
+  });
+});

lib/provider/opencv/image-processor.class.ts

@@ -2,6 +2,14 @@ import * as cv from "opencv4nodejs-prebuilt";
 import { Image } from "../../image.class";
 import { Region } from "../../region.class";
 
+const determineROI = (img: Image, roi: Region): cv.Rect => {
+  return new cv.Rect(
+    Math.min(Math.max(roi.left, 0), img.width),
+    Math.min(Math.max(roi.top, 0), img.height),
+    Math.min(roi.width, img.width - roi.left),
+    Math.min(roi.height, img.height - roi.top));
+};
+
 export class ImageProcessor {
   /**
    * fromImageWithAlphaChannel should provide a way to create a library specific
@@ -18,7 +26,7 @@ export class ImageProcessor {
   ): Promise<cv.Mat> {
     const mat = await new cv.Mat(img.data, img.height, img.width, cv.CV_8UC4).cvtColorAsync(cv.COLOR_BGRA2BGR);
     if (roi) {
-      return mat.getRegion(new cv.Rect(roi.left, roi.top, roi.width, roi.height));
+      return mat.getRegion(determineROI(img, roi));
     } else {
       return mat;
     }
@@ -39,7 +47,7 @@ export class ImageProcessor {
   ): Promise<cv.Mat> {
     const mat = new cv.Mat(img.data, img.height, img.width, cv.CV_8UC3);
     if (roi) {
-      return mat.getRegion(new cv.Rect(roi.left, roi.top, roi.width, roi.height));
+      return mat.getRegion(determineROI(img, roi));
     } else {
       return mat;
     }

lib/provider/opencv/template-matching-finder.class.ts

@@ -103,10 +103,10 @@ export class TemplateMatchingFinder implements FinderInterface {
 
   private static async debugResult(image: cv.Mat, result: MatchResult, filename: string, suffix?: string) {
     const roiRect = new cv.Rect(
-      result.location.left,
-      result.location.top,
-      result.location.width,
-      result.location.height);
+      Math.min(Math.max(result.location.left, 0), image.cols),
+      Math.min(Math.max(result.location.top, 0), image.rows),
+      Math.min(result.location.width, image.cols - result.location.left),
+      Math.min(result.location.height, image.rows - result.location.top));
     this.debugImage(image.getRegion(roiRect), filename, suffix);
   }