fix: resolve conversation

Author: EscapedGibbon

src/geometry/__tests__/getPerspectiveWarp.test.ts

@@ -1,5 +1,5 @@
 import { Image } from '../../Image.js';
-import getPerspectiveWarp, { order4Points } from '../getPerspectiveWarp.js';
+import { getPerspectiveWarp, order4Points } from '../getPerspectiveWarp.js';
 
 describe('4 points sorting', () => {
   test('basic sorting test', () => {
@@ -97,7 +97,7 @@ describe('warping tests', () => {
 
 describe('openCV comparison', () => {
   test('nearest interpolation plants', () => {
-    const image = testUtils.load('various/plants.png');
+    const image = testUtils.load('opencv/plants.png');
     const openCvResult = testUtils.load(
       'opencv/test_perspective_warp_plants_nearest.png',
     );
@@ -134,7 +134,7 @@ describe('openCV comparison', () => {
   });
 
   test('nearest interpolation card', () => {
-    const image = testUtils.load('various/card.png');
+    const image = testUtils.load('opencv/card.png');
     const openCvResult = testUtils.load(
       'opencv/test_perspective_warp_card_nearest.png',
     );
@@ -171,7 +171,7 @@ describe('openCV comparison', () => {
     expect(croppedPiece).toEqual(croppedPieceOpenCv);
   });
   test('nearest interpolation poker card', () => {
-    const image = testUtils.load('various/poker_cards.png');
+    const image = testUtils.load('opencv/poker_cards.png');
     const openCvResult = testUtils.load(
       'opencv/test_perspective_warp_poker_cards_nearest.png',
     );
@@ -215,4 +215,17 @@ describe('error testing', () => {
       'The array pts must have four elements, which are the four corners. Currently, pts have 1 elements',
     );
   });
+  test('should throw if either only width or only height are defined', () => {
+    expect(() => {
+      getPerspectiveWarp(
+        [
+          { column: 1, row: 1 },
+          { column: 2, row: 1 },
+          { column: 2, row: 2 },
+          { column: 1, row: 2 },
+        ],
+        { width: 10 },
+      );
+    }).toThrow('Height is not defined');
+  });
 });

src/geometry/getPerspectiveWarp.ts

@@ -2,6 +2,9 @@ import { Matrix, SingularValueDecomposition } from 'ml-matrix';
 
 import type { Point } from '../utils/geometry/points.js';
 
+/**
+ * Options for getPerspectiveWarp function.
+ */
 interface GetPerspectiveWarpOptions {
   /**
    * The horizontal dimension (in pixels) of the final rectified rectangular image.
@@ -30,7 +33,7 @@ type GetPerspectiveWarpData = Required<GetPerspectiveWarpOptions> & {
  * @param options - PerspectiveWarpOptions
  * @returns - Matrix from 4 points.
  */
-export default function getPerspectiveWarp(
+export function getPerspectiveWarp(
   pts: Point[],
   options: GetPerspectiveWarpOptions = {},
 ): GetPerspectiveWarpData {
@@ -47,13 +50,15 @@ export default function getPerspectiveWarp(
   if (height && width) {
     widthRect = width;
     heightRect = height;
-  } else {
+  } else if (!height && !width) {
     widthRect = Math.ceil(
       Math.max(distance2Points(tl, tr), distance2Points(bl, br)),
     );
     heightRect = Math.ceil(
       Math.max(distance2Points(tl, bl), distance2Points(tr, br)),
     );
+  } else {
+    throw new Error(`${width ? 'Height' : 'Width'} is not defined.`);
   }
 
   const [x1, y1] = [0, 0];

src/geometry/index.ts

@@ -2,4 +2,5 @@ export * from './resize.js';
 export * from './rotate.js';
 export * from './transform.js';
 export * from './transformRotate.js';
+export * from './getPerspectiveWarp.js';
 export type { Point } from '../utils/geometry/points.js';

test/TestImagePath.ts

@@ -66,6 +66,9 @@ export type TestImagePath =
   | 'morphology/alphabetCannyEdge.png'
   | 'morphology/grayscaleCannyEdge.png'
   | 'morphology/grayscaleClearBorder.png'
+  | 'opencv/card.png'
+  | 'opencv/plants.png'
+  | 'opencv/poker_cards.png'
   | 'opencv/test.png'
   | 'opencv/testAffineTransform.png'
   | 'opencv/testAntiClockwiseRot90.png'
@@ -98,10 +101,7 @@ export type TestImagePath =
   | 'ssim/ssim-original.png'
   | 'ssim/ssim-saltPepper.png'
   | 'various/alphabet.jpg'
-  | 'various/card.png'
   | 'various/grayscale_by_zimmyrose.png'
-  | 'various/plants.png'
-  | 'various/poker_cards.png'
   | 'various/screws.png'
   | 'various/sudoku.jpg'
   | 'various/without-metadata.jpg';

test/img/various/card.png renamed to test/img/opencv/card.png

@@ -91,3 +91,72 @@ def writeImg(name, img):
 kernelY = np.float32([[0.4, 0.5, 0.6, -0.3, -0.4]])
 dst = cv.sepFilter2D(img, ddepth=-1, kernelX=kernelX, kernelY=kernelY, borderType=cv.BORDER_REFLECT)
 writeImg('testConvolution.png', dst)
+
+
+# Image perspective warp
+
+img = cv.imread(path.join(dirname,'poker_cards.png'))
+
+# Define source points (4 corners of the document in the image)
+# These points should be in clockwise or counter-clockwise order
+src_points = np.array([
+        [660, 290],
+        [970, 290],
+        [1100,660],
+[680,660],
+    ], dtype=np.float32)
+# Define destination points (rectangle)
+width, height = 420,393
+dst_points = np.array([
+    [0, 0],               # top-left
+    [width-1, 0],         # top-right
+    [width-1, height-1],  # bottom-right
+    [0, height-1]         # bottom-left
+], dtype=np.float32)
+M = cv.getPerspectiveTransform(src_points,dst_points)
+warped = cv.warpPerspective(img, M, (width, height),flags=cv.INTER_NEAREST)
+writeImg('test_perspective_warp_poker_cards_nearest.png',warped)
+
+
+
+img = cv.imread(path.join(dirname,'plants.png'))
+src_points = np.array([
+    [166.5, 195],
+    [858.5,9],
+    [911.5,786],
+    [154.5, 611],
+    ], dtype=np.float32)
+width, height = 1080,810
+dst_points = np.array([
+    [0, 0],               # top-left
+    [width-1, 0],         # top-right
+    [width-1, height-1],  # bottom-right
+    [0, height-1]         # bottom-left
+], dtype=np.float32)
+M = cv.getPerspectiveTransform(src_points,dst_points)
+warped = cv.warpPerspective(img, M, (width, height),flags=cv.INTER_NEAREST
+)
+writeImg('test_perspective_warp_plants_nearest.png',warped)
+
+img = cv.imread(path.join(dirname,'card.png'))
+
+# Define source points (4 corners of the document in the image)
+# These points should be in clockwise or counter-clockwise order
+src_points = np.array([
+    [55, 140],
+    [680,38],
+    [840, 340],
+    [145,  460],
+    ], dtype=np.float32)
+width, height =700,400
+dst_points = np.array([
+    [0, 0],               # top-left
+    [width-1, 0],         # top-right
+    [width-1, height-1],  # bottom-right
+    [0, height-1]         # bottom-left
+], dtype=np.float32)
+
+M = cv.getPerspectiveTransform(src_points,dst_points)
+warped = cv.warpPerspective(img, M, (width, height),flags=cv.INTER_NEAREST
+)
+writeImg('test_perspective_warp_card_nearest.png',warped)