refactor: rename getMathAngle and fix docs

Author: opatiny

src/featureMatching/keypoints/getOrientedFastKeypoints.ts

@@ -1,5 +1,5 @@
 import { Image } from '../../Image';
-import { getMathAngle } from '../../maskAnalysis/utils/getAngle';
+import { getClockwiseAngle } from '../../maskAnalysis/utils/getAngle';
 import { toDegrees } from '../../utils/geometry/angles';
 import { getRadius } from '../../utils/getRadius';
 import { checkBorderDistance } from '../utils/checkBorderDistance';
@@ -62,7 +62,7 @@ export function getOrientedFastKeypoints(
       center: keypoint.origin,
       radius,
     })[0];
-    const angle = toDegrees(getMathAngle({ column: 0, row: 0 }, centroid));
+    const angle = toDegrees(getClockwiseAngle({ column: 0, row: 0 }, centroid));
     orientedFastKeypoints.push({ ...keypoint, angle });
   }
   return orientedFastKeypoints;

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

@@ -1,6 +1,6 @@
 import { toBeDeepCloseTo } from 'jest-matcher-deep-close-to';
 
-import { getAngle, getMathAngle } from '../getAngle';
+import { getAngle, getClockwiseAngle } from '../getAngle';
 
 expect.extend({ toBeDeepCloseTo });
 
@@ -82,6 +82,6 @@ test.each([
     Math.PI / 4,
   ],
 ])('getMathAngle (%s)', (_, point1, point2, expectedAngle) => {
-  const result = getMathAngle(point1, point2);
+  const result = getClockwiseAngle(point1, point2);
   expect(result).toBeCloseTo(expectedAngle);
 });

src/maskAnalysis/utils/getAngle.ts

@@ -19,13 +19,13 @@ export function getAngle(p1: Point, p2: Point): number {
 }
 
 /**
- * Compute the mathematical angle in radians of the segment p1-p2.
+ * Compute the clockwise angle in radians between the x-axis and the segment p1-p2.
  *
  * @param p1 - First point.
  * @param p2 - Second point.
- * @returns The angle of the segment in radians.
+ * @returns Clockwise angle between x-axis and the segment.
  */
-export function getMathAngle(p1: Point, p2: Point): number {
+export function getClockwiseAngle(p1: Point, p2: Point): number {
   const diff = difference(p2, p1);
   const vector = normalize(diff);
   const atan = -Math.atan(vector.row / vector.column);