251 add property aspectratio (#271)

* feat!: add aspectRatio property to mbr

* feat!: add aspectRatio property to mbr

close: #251

* feat: add aspectRatio property to mbr

close: #251

* chore: change ratio formula for mbr

* test: add testing cases for aspectRatio

* test: update snapshot to pass tests

* test: update snapshots

* chore: change version of ml-spectra-processing to pass the test

Author: EscapedGibbon

src/maskAnalysis/__tests__/getMbr.test.ts

@@ -70,6 +70,7 @@ test('horizontal MBR', () => {
     height: 3,
     perimeter: 22,
     surface: 24,
+    aspectRatio: 3 / 8,
   });
 });
 
@@ -95,6 +96,7 @@ test('other horizontal MBR', () => {
     height: 3,
     surface: 18,
     perimeter: 18,
+    aspectRatio: 0.5,
   });
 });
 
@@ -202,6 +204,7 @@ test('empty mask', () => {
     height: 0,
     surface: 0,
     perimeter: 0,
+    aspectRatio: 0,
   });
 });
 
@@ -230,3 +233,49 @@ test('draw mbr on large image', () => {
 
   expect(result).toMatchImageSnapshot();
 });
+
+test('other horizontal MBR', () => {
+  const mask = testUtils.createMask(
+    `
+      1 0 0 0 1 0 
+      0 1 1 1 1 0 
+      1 0 1 1 0 1 
+    `,
+  );
+
+  const result = getMbr(mask);
+  expect(result.aspectRatio).toBeCloseTo(0.5);
+});
+
+test('small triangular ROI', () => {
+  const mask = testUtils.createMask([
+    [0, 1, 0],
+    [1, 1, 1],
+    [0, 1, 0],
+  ]);
+
+  const result = getMbr(mask).aspectRatio;
+
+  expect(result).toBeCloseTo(1);
+});
+
+test('small triangular ROI', () => {
+  const mask = testUtils.createMask([
+    [0, 1, 0],
+    [0, 1, 0],
+    [0, 1, 0],
+    [0, 1, 0],
+  ]);
+
+  const result = getMbr(mask).aspectRatio;
+
+  expect(result).toStrictEqual(0.25);
+});
+
+test('small triangular ROI', () => {
+  const mask = testUtils.createMask([[1, 1, 1, 1]]);
+
+  const result = getMbr(mask).aspectRatio;
+
+  expect(result).toStrictEqual(0.25);
+});

src/maskAnalysis/getMbr.ts

@@ -33,6 +33,10 @@ export interface Mbr {
    * Angle between the rectangle and a horizontal line in radians.
    */
   angle: number;
+  /**
+   *Ratio between width and height.
+   */
+  aspectRatio: number;
 }
 
 /**

src/maskAnalysis/utils/getMbrFromPoints.ts

@@ -20,6 +20,7 @@ export function getMbrFromPoints(points: readonly Point[]): Mbr {
       height: 0,
       surface: 0,
       perimeter: 0,
+      aspectRatio: 0,
     };
   }
   if (points.length === 1) {
@@ -30,6 +31,7 @@ export function getMbrFromPoints(points: readonly Point[]): Mbr {
       angle: 0,
       width: 0,
       height: 0,
+      aspectRatio: 1,
     };
   }
 
@@ -92,6 +94,7 @@ export function getMbrFromPoints(points: readonly Point[]): Mbr {
   const width = mbr[0].column - mbr[2].column;
   const height = mbr[0].row - mbr[2].row;
   const mbrAngle = getMbrAngle(mbrRotated);
+  const ratio = height / width;
 
   return {
     points: mbrRotated,
@@ -100,5 +103,6 @@ export function getMbrFromPoints(points: readonly Point[]): Mbr {
     width,
     height,
     perimeter: 2 * width + 2 * height,
+    aspectRatio: ratio,
   };
 }

src/roi/__tests__/__snapshots__/computeRois.test.ts.snap

@@ -71,6 +71,7 @@ exports[`3x3 mask 1`] = `
     "id": 1,
     "mbr": {
       "angle": -0,
+      "aspectRatio": 1.4999999999999998,
       "height": 2.9999999999999996,
       "perimeter": 10,
       "points": [
@@ -171,6 +172,7 @@ exports[`3x3 mask 1`] = `
     "id": 2,
     "mbr": {
       "angle": 0,
+      "aspectRatio": 1,
       "height": 1,
       "perimeter": 4,
       "points": [
@@ -284,6 +286,7 @@ exports[`3x3 mask 2`] = `
     "id": -1,
     "mbr": {
       "angle": -0,
+      "aspectRatio": 1.4999999999999998,
       "height": 2.9999999999999996,
       "perimeter": 10,
       "points": [