feat!: change property name from "corners" to "points" in mbr

close: #234

Author: EscapedGibbon

demo/components/testFunctions/testGetMbr.ts

@@ -24,7 +24,7 @@ export function testGetMbr(image: Image): Image {
       color: [0, 0, 255, 255],
     });
 
-    result = result.drawPolygon(mbr.corners, {
+    result = result.drawPolygon(mbr.points, {
       origin: roi.origin,
       strokeColor: [0, 255, 0, 255],
     });

src/maskAnalysis/__tests__/getMbr.test.ts

@@ -16,7 +16,7 @@ test('verify that angle is correct', () => {
       0 0 0 0 0 0 0 0
     `);
 
-  const result = getMbr(mask).corners;
+  const result = getMbr(mask).points;
   expect(result).toHaveLength(4);
 
   for (let i = 0; i < 4; i++) {
@@ -37,7 +37,7 @@ test('small rectangular ROI', () => {
     [1, 0, 0],
   ]);
 
-  const result = getMbr(mask).corners;
+  const result = getMbr(mask).points;
   expect(result).toBeDeepCloseTo(
     [
       { column: 4, row: 1 },
@@ -61,7 +61,7 @@ test('horizontal MBR', () => {
   const result = getMbr(mask);
 
   expect(result).toBeDeepCloseTo({
-    corners: [
+    points: [
       { column: 8, row: 3 },
       { column: 0, row: 3 },
       { column: 0, row: 0 },
@@ -86,7 +86,7 @@ test('other horizontal MBR', () => {
 
   const result = getMbr(mask);
   expect(result).toBeDeepCloseTo({
-    corners: [
+    points: [
       { column: 6, row: 3 },
       { column: 0, row: 3 },
       { column: 0, row: 0 },
@@ -108,7 +108,7 @@ test('small tilted rectangle', () => {
       `);
 
   const result = getMbr(mask);
-  expect(result.corners).toBeDeepCloseTo(
+  expect(result.points).toBeDeepCloseTo(
     [
       { column: 1.5, row: 3.5 },
       { column: -0.5, row: 1.5 },
@@ -129,7 +129,7 @@ test('large tilted rectangle', () => {
         0 0 1 1 1 0
         0 0 0 1 0 0
       `);
-  const result = getMbr(mask).corners;
+  const result = getMbr(mask).points;
   expect(result).toBeDeepCloseTo(
     [
       { column: 2.5, row: -0.5 },
@@ -143,7 +143,7 @@ test('large tilted rectangle', () => {
 
 test('one point ROI', () => {
   const mask = testUtils.createMask([[1]]);
-  const result = getMbr(mask).corners;
+  const result = getMbr(mask).points;
   expect(result).toBeDeepCloseTo([
     { column: 0, row: 1 },
     { column: 0, row: 0 },
@@ -157,7 +157,7 @@ test('2 points ROI', () => {
     [1, 0],
     [0, 1],
   ]);
-  const result = getMbr(mask).corners;
+  const result = getMbr(mask).points;
 
   expect(result).toBeDeepCloseTo(
     [
@@ -176,7 +176,7 @@ test('small triangular ROI', () => {
     [1, 0],
   ]);
 
-  const result = getMbr(mask).corners;
+  const result = getMbr(mask).points;
 
   expect(result).toBeDeepCloseTo(
     [
@@ -198,7 +198,7 @@ test('empty mask', () => {
   const result = getMbr(mask);
 
   expect(result).toStrictEqual({
-    corners: [],
+    points: [],
     angle: 0,
     width: 0,
     height: 0,
@@ -225,7 +225,7 @@ test('draw mbr on large image', () => {
     color: [0, 0, 255, 255],
   });
 
-  result = result.drawPolygon(mbr.corners, {
+  result = result.drawPolygon(mbr.points, {
     origin: roi.origin,
     strokeColor: [0, 255, 0, 255],
   });

src/maskAnalysis/getMbr.ts

@@ -12,7 +12,7 @@ export interface Mbr {
   /**
    * Vertices of the MBR in clockwise order.
    */
-  corners: Point[];
+  points: Point[];
   /**
    * Perimeter of the MBR.
    */

src/maskAnalysis/utils/__tests__/getMbrFromPoints.test.ts

@@ -174,6 +174,6 @@ test.each([
     ],
   ],
 ])('getMbrFromPoints (%s)', (_, inputPoints, expectedPoints) => {
-  const result = getMbrFromPoints(inputPoints).corners;
+  const result = getMbrFromPoints(inputPoints).points;
   expect(result).toBeDeepCloseTo(expectedPoints);
 });

src/maskAnalysis/utils/getMbrFromPoints.ts

@@ -14,7 +14,7 @@ import { getMbrAngle } from './getMbrAngle';
 export function getMbrFromPoints(points: readonly Point[]): Mbr {
   if (points.length === 0) {
     return {
-      corners: [],
+      points: [],
       angle: 0,
       width: 0,
       height: 0,
@@ -24,7 +24,7 @@ export function getMbrFromPoints(points: readonly Point[]): Mbr {
   }
   if (points.length === 1) {
     return {
-      corners: [points[0], points[0], points[0], points[0]],
+      points: [points[0], points[0], points[0], points[0]],
       perimeter: 0,
       surface: 0,
       angle: 0,
@@ -94,7 +94,7 @@ export function getMbrFromPoints(points: readonly Point[]): Mbr {
   const mbrAngle = getMbrAngle(mbrRotated);
 
   return {
-    corners: mbrRotated,
+    points: mbrRotated,
     surface: minSurface,
     angle: mbrAngle,
     width,

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

@@ -66,7 +66,9 @@ exports[`3x3 mask 1`] = `
     "id": 1,
     "mbr": {
       "angle": -0,
-      "corners": [
+      "height": 2.9999999999999996,
+      "perimeter": 10,
+      "points": [
         {
           "column": 3,
           "row": -3.834758505292834e-17,
@@ -84,8 +86,6 @@ exports[`3x3 mask 1`] = `
           "row": -2.2204460492503128e-16,
         },
       ],
-      "height": 2.9999999999999996,
-      "perimeter": 10,
       "surface": 5.999999999999999,
       "width": 2,
     },
@@ -161,7 +161,9 @@ exports[`3x3 mask 1`] = `
     "id": 2,
     "mbr": {
       "angle": 0,
-      "corners": [
+      "height": 1,
+      "perimeter": 4,
+      "points": [
         {
           "column": 6.123233995736766e-17,
           "row": 1,
@@ -179,8 +181,6 @@ exports[`3x3 mask 1`] = `
           "row": 0.9999999999999999,
         },
       ],
-      "height": 1,
-      "perimeter": 4,
       "surface": 1,
       "width": 1,
     },
@@ -269,7 +269,9 @@ exports[`3x3 mask 2`] = `
     "id": -1,
     "mbr": {
       "angle": -0,
-      "corners": [
+      "height": 2.9999999999999996,
+      "perimeter": 10,
+      "points": [
         {
           "column": 3,
           "row": -3.834758505292834e-17,
@@ -287,8 +289,6 @@ exports[`3x3 mask 2`] = `
           "row": -2.2204460492503128e-16,
         },
       ],
-      "height": 2.9999999999999996,
-      "perimeter": 10,
       "surface": 5.999999999999999,
       "width": 2,
     },