image-js 1.0.0-alpha.3 → 1.0.0

package/lib/featureMatching/descriptors/getBrief.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBrief.js","sourceRoot":"","sources":["../../../src/featureMatching/descriptors/getBrief.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AAGpF,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAQ/D;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAY,EAAE,UAA2B,EAAE;IAClE,MAAM,EAAE,qBAAqB,GAAG,EAAE,EAAE,aAAa,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7E,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,KAAK,EAAE;QACzD,qBAAqB;KACtB,CAAC,CAAC;IACH,MAAM,eAAe,GAAG,wBAAwB,CAC9C,kBAAkB,EAClB,aAAa,CACd,CAAC;IAEF,MAAM,KAAK,GAAG,mBAAmB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;IAC1D,IAAI,QAAQ,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,QAAQ,EAAE,CAAC;gBACxC,OAAO;oBACL,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;oBAC1C,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;iBAC/C,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/featureMatching/descriptors/getBriefDescriptors.d.ts

@@ -0,0 +1,43 @@
+import type { Image } from '../../Image.js';
+import type { GaussianBlurSigmaOptions } from '../../filters/index.js';
+import type { GetGaussianPointsOptions } from '../../utils/utils.types.js';
+import type { OrientedFastKeypoint } from '../keypoints/getOrientedFastKeypoints.js';
+export interface GetBriefDescriptorsOptions {
+    /**
+     * Options to smooth the image patch before comparing pairs of points.
+     * Default values are the ones recommended in the original BRIEF article.
+     * DOI: https://doi.org/10.1007/978-3-642-15561-1_56.
+     */
+    smoothingOptions?: GaussianBlurSigmaOptions;
+    /**
+     * Options to modify the gaussian distribution used to generate the points to compare.
+     */
+    pointsDistributionOptions?: Omit<GetGaussianPointsOptions, 'nbPoints'>;
+    /**
+     * Size of the patch around the keypoint used to compute the descriptor.
+     * @default `31`
+     */
+    patchSize?: number;
+    /**
+     * Number of bits of the final descriptor. Typically a power or 2: 128, 256, 512.
+     * @default `256`
+     */
+    descriptorLength?: number;
+}
+export type BriefDescriptor = Uint8Array;
+export interface Brief {
+    keypoints: OrientedFastKeypoint[];
+    descriptors: BriefDescriptor[];
+}
+/**
+ * Generate the rBRIEF descriptors for the desired keypoints of an image.
+ * The rBRIEF descriptors are presented in these articles:
+ * - ORB article: DOI: 10.1109/ICCV.2011.6126544
+ * - rBRIEF article: DOI: 10.1007/978-3-642-15561-1_56.
+ * @param image - Source image of the keypoints.
+ * @param keypoints - Keypoints for which the descriptors are wanted.
+ * @param options - Get rotated BRIEF descriptors options.
+ * @returns The descriptors for the given keypoints.
+ */
+export declare function getBriefDescriptors(image: Image, keypoints: OrientedFastKeypoint[], options?: GetBriefDescriptorsOptions): Brief;
+//# sourceMappingURL=getBriefDescriptors.d.ts.map

package/lib/featureMatching/descriptors/getBriefDescriptors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBriefDescriptors.d.ts","sourceRoot":"","sources":["../../../src/featureMatching/descriptors/getBriefDescriptors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAMrF,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAC5C;;OAEG;IACH,yBAAyB,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;IACvE;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC;AACzC,MAAM,WAAW,KAAK;IACpB,SAAS,EAAE,oBAAoB,EAAE,CAAC;IAClC,WAAW,EAAE,eAAe,EAAE,CAAC;CAChC;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,oBAAoB,EAAE,EACjC,OAAO,GAAE,0BAA+B,GACvC,KAAK,CAsDP"}

package/lib/featureMatching/descriptors/getBriefDescriptors.js

@@ -0,0 +1,58 @@
+import checkProcessable from '../../utils/validators/checkProcessable.js';
+import { compareIntensity } from '../utils/compareIntensity.js';
+import { getGaussianPoints } from '../utils/getGaussianPoints.js';
+import { getKeypointPatch } from './utils/getKeypointPatch.js';
+/**
+ * Generate the rBRIEF descriptors for the desired keypoints of an image.
+ * The rBRIEF descriptors are presented in these articles:
+ * - ORB article: DOI: 10.1109/ICCV.2011.6126544
+ * - rBRIEF article: DOI: 10.1007/978-3-642-15561-1_56.
+ * @param image - Source image of the keypoints.
+ * @param keypoints - Keypoints for which the descriptors are wanted.
+ * @param options - Get rotated BRIEF descriptors options.
+ * @returns The descriptors for the given keypoints.
+ */
+export function getBriefDescriptors(image, keypoints, options = {}) {
+    const { patchSize = 31, descriptorLength = 256, smoothingOptions = {
+        sigma: Math.sqrt(2),
+        size: Math.min(image.height, image.width, 9),
+    }, pointsDistributionOptions, } = options;
+    checkProcessable(image, {
+        alpha: false,
+        colorModel: 'GREY',
+    });
+    if (!(patchSize % 2)) {
+        throw new TypeError('patchSize must be an odd integer');
+    }
+    if (Math.min(image.width, image.height) < patchSize) {
+        throw new RangeError(`image is too small for patchSize = ${patchSize}`);
+    }
+    const gaussianPoints = getGaussianPoints(patchSize, patchSize, {
+        ...pointsDistributionOptions,
+        nbPoints: descriptorLength * 2,
+    });
+    const smoothed = image.gaussianBlur(smoothingOptions);
+    const descriptors = [];
+    const filteredKeypoints = [];
+    for (const keypoint of keypoints) {
+        let patch;
+        try {
+            patch = getKeypointPatch(smoothed, keypoint, { patchSize });
+        }
+        catch {
+            continue;
+        }
+        if (patch === null)
+            continue;
+        const descriptor = new Uint8Array(descriptorLength);
+        for (let i = 0; i < descriptorLength; i++) {
+            const p1 = gaussianPoints[i];
+            const p2 = gaussianPoints[i + descriptorLength];
+            descriptor[i] = Number(compareIntensity(patch, p1, p2));
+        }
+        descriptors.push(descriptor);
+        filteredKeypoints.push(keypoint);
+    }
+    return { keypoints: filteredKeypoints, descriptors };
+}
+//# sourceMappingURL=getBriefDescriptors.js.map

package/lib/featureMatching/descriptors/getBriefDescriptors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBriefDescriptors.js","sourceRoot":"","sources":["../../../src/featureMatching/descriptors/getBriefDescriptors.ts"],"names":[],"mappings":"AAGA,OAAO,gBAAgB,MAAM,4CAA4C,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AA+B/D;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAY,EACZ,SAAiC,EACjC,UAAsC,EAAE;IAExC,MAAM,EACJ,SAAS,GAAG,EAAE,EACd,gBAAgB,GAAG,GAAG,EACtB,gBAAgB,GAAG;QACjB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACnB,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;KAC7C,EACD,yBAAyB,GAC1B,GAAG,OAAO,CAAC;IAEZ,gBAAgB,CAAC,KAAK,EAAE;QACtB,KAAK,EAAE,KAAK;QACZ,UAAU,EAAE,MAAM;KACnB,CAAC,CAAC;IAEH,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,CAAC;QACpD,MAAM,IAAI,UAAU,CAAC,sCAAsC,SAAS,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE;QAC7D,GAAG,yBAAyB;QAC5B,QAAQ,EAAE,gBAAgB,GAAG,CAAC;KAC/B,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;IAEtD,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,MAAM,iBAAiB,GAA2B,EAAE,CAAC;IAErD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,KAAY,CAAC;QACjB,IAAI,CAAC;YACH,KAAK,GAAG,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9D,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,IAAI,KAAK,KAAK,IAAI;YAAE,SAAS;QAE7B,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAC;QACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1C,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC;YAChD,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC1D,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7B,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,CAAC;AACvD,CAAC"}

package/lib/featureMatching/descriptors/utils/getKeypointPatch.d.ts

@@ -0,0 +1,18 @@
+import type { Image } from '../../../Image.js';
+import type { OrientedFastKeypoint } from '../../keypoints/getOrientedFastKeypoints.js';
+export interface GetKeypointPatchOptions {
+    /**
+     * Size of the patch around the keypoint used to compute the descriptor.
+     * @default `31`
+     */
+    patchSize?: number;
+}
+/**
+ * Get the patch around the keypoint with given size.
+ * @param image - Image from which to extract the patch.
+ * @param keypoint - Keypoint around which to extract the patch.
+ * @param options - Get keypoint patch options.
+ * @returns The patch around the keypoint.
+ */
+export declare function getKeypointPatch(image: Image, keypoint: OrientedFastKeypoint, options?: GetKeypointPatchOptions): Image;
+//# sourceMappingURL=getKeypointPatch.d.ts.map

package/lib/featureMatching/descriptors/utils/getKeypointPatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getKeypointPatch.d.ts","sourceRoot":"","sources":["../../../../src/featureMatching/descriptors/utils/getKeypointPatch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6CAA6C,CAAC;AAIxF,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,oBAAoB,EAC9B,OAAO,GAAE,uBAA4B,GACpC,KAAK,CAiCP"}

package/lib/featureMatching/descriptors/utils/getKeypointPatch.js

@@ -0,0 +1,32 @@
+import { getRadius } from '../../../utils/getRadius.js';
+import { checkBorderDistance } from '../../utils/checkBorderDistance.js';
+import { extractSquareImage } from '../../utils/extractSquareImage.js';
+/**
+ * Get the patch around the keypoint with given size.
+ * @param image - Image from which to extract the patch.
+ * @param keypoint - Keypoint around which to extract the patch.
+ * @param options - Get keypoint patch options.
+ * @returns The patch around the keypoint.
+ */
+export function getKeypointPatch(image, keypoint, options = {}) {
+    const { patchSize = 31 } = options;
+    // crop smallest square surrounding the tilted patch of the keypoint
+    // we have to handle the fact that this square can have even dimensions
+    const radAngle = (keypoint.angle * Math.PI) / 180;
+    const rawWidth = Math.floor(patchSize * (Math.abs(Math.cos(radAngle)) + Math.abs(Math.sin(radAngle))));
+    const cropWidth = rawWidth % 2 ? rawWidth : rawWidth + 1;
+    // we are not allowing keypoints that are too close to the border of the image
+    const borderDistance = getRadius(cropWidth);
+    if (!checkBorderDistance(image, keypoint.origin, borderDistance)) {
+        throw new RangeError('keypoint is too close to border for given patch size');
+    }
+    const cropped = extractSquareImage(image, keypoint.origin, cropWidth);
+    const rotated = cropped.transformRotate(-keypoint.angle, {
+        center: 'center',
+        interpolationType: 'nearest',
+    });
+    const cropOrigin = rotated.getCoordinates('center');
+    const result = extractSquareImage(rotated, cropOrigin, patchSize);
+    return result;
+}
+//# sourceMappingURL=getKeypointPatch.js.map

package/lib/featureMatching/descriptors/utils/getKeypointPatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getKeypointPatch.js","sourceRoot":"","sources":["../../../../src/featureMatching/descriptors/utils/getKeypointPatch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAExD,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAUvE;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAY,EACZ,QAA8B,EAC9B,UAAmC,EAAE;IAErC,MAAM,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC;IACnC,oEAAoE;IACpE,uEAAuE;IAEvE,MAAM,QAAQ,GAAG,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC;IAElD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,SAAS,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAC1E,CAAC;IAEF,MAAM,SAAS,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC;IAEzD,8EAA8E;IAC9E,MAAM,cAAc,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IAE5C,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,CAAC;QACjE,MAAM,IAAI,UAAU,CAClB,sDAAsD,CACvD,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEtE,MAAM,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE;QACvD,MAAM,EAAE,QAAQ;QAChB,iBAAiB,EAAE,SAAS;KAC7B,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAElE,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/featureMatching/descriptors/utils/sliceBrief.d.ts

@@ -0,0 +1,21 @@
+import type { Brief } from '../getBriefDescriptors.js';
+export interface SliceBriefOptions {
+    /**
+     * Start index.
+     * @default `0`
+     */
+    start?: number;
+    /**
+     * End index.
+     * @default `brief.keypoints.length`
+     */
+    end?: number;
+}
+/**
+ * Slice a Brief to keep only the desired keypoints and the corresponding descriptors.
+ * @param brief - Brief to process.
+ * @param options - Slice Brief options.
+ * @returns The desired keypoints + descriptors.
+ */
+export declare function sliceBrief(brief: Brief, options?: SliceBriefOptions): Brief;
+//# sourceMappingURL=sliceBrief.d.ts.map

package/lib/featureMatching/descriptors/utils/sliceBrief.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceBrief.d.ts","sourceRoot":"","sources":["../../../../src/featureMatching/descriptors/utils/sliceBrief.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,2BAA2B,CAAC;AAEvD,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,KAAK,EACZ,OAAO,GAAE,iBAAsB,GAC9B,KAAK,CASP"}

package/lib/featureMatching/descriptors/utils/sliceBrief.js

@@ -0,0 +1,17 @@
+/**
+ * Slice a Brief to keep only the desired keypoints and the corresponding descriptors.
+ * @param brief - Brief to process.
+ * @param options - Slice Brief options.
+ * @returns The desired keypoints + descriptors.
+ */
+export function sliceBrief(brief, options = {}) {
+    const { start = 0, end = brief.keypoints.length } = options;
+    if (start < 0 || end > brief.keypoints.length) {
+        throw new RangeError('start or end are out of range');
+    }
+    return {
+        keypoints: brief.keypoints.slice(start, end),
+        descriptors: brief.descriptors.slice(start, end),
+    };
+}
+//# sourceMappingURL=sliceBrief.js.map

package/lib/featureMatching/descriptors/utils/sliceBrief.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sliceBrief.js","sourceRoot":"","sources":["../../../../src/featureMatching/descriptors/utils/sliceBrief.ts"],"names":[],"mappings":"AAeA;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACxB,KAAY,EACZ,UAA6B,EAAE;IAE/B,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC;IAC5D,IAAI,KAAK,GAAG,CAAC,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAC9C,MAAM,IAAI,UAAU,CAAC,+BAA+B,CAAC,CAAC;IACxD,CAAC;IACD,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC;QAC5C,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC;KACjD,CAAC;AACJ,CAAC"}

package/lib/featureMatching/featureMatching.types.d.ts

@@ -0,0 +1,26 @@
+export interface GetColorsOptions {
+    /**
+     * Number of shades to generate.
+     * @default `6`
+     */
+    nbShades?: number;
+    /**
+     * Factor between 0 and 1 by which to multiply the maximal value of the color to obtain the minimum value.
+     * @default `0.2`
+     */
+    minValueFactor?: number;
+}
+export interface GetHarrisScoreOptions {
+    /**
+     * Size of the window to compute the Harris score.
+     * Should be an odd number so that the window can be centered on the corner.
+     * @default `7`
+     */
+    windowSize?: number;
+    /**
+     * Constant for the score computation. Should be between 0.04 and 0.06 (empirical values). This consant is commonly called k.
+     * @default `0.04`
+     */
+    harrisConstant?: number;
+}
+//# sourceMappingURL=featureMatching.types.d.ts.map

package/lib/featureMatching/featureMatching.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureMatching.types.d.ts","sourceRoot":"","sources":["../../src/featureMatching/featureMatching.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/lib/featureMatching/featureMatching.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=featureMatching.types.js.map

package/lib/featureMatching/featureMatching.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureMatching.types.js","sourceRoot":"","sources":["../../src/featureMatching/featureMatching.types.ts"],"names":[],"mappings":""}

package/lib/featureMatching/index.d.ts

@@ -0,0 +1,13 @@
+export * from './descriptors/getBriefDescriptors.js';
+export * from './featureMatching.types.js';
+export * from './keypoints/getFastKeypoints.js';
+export * from './keypoints/getIntensityCentroid.js';
+export * from './keypoints/getOrientedFastKeypoints.js';
+export * from './keypoints/getBestKeypointsInRadius.js';
+export * from './matching/bruteForceMatch.js';
+export * from './matching/getCrosscheckMatches.js';
+export * from './visualize/drawKeypoints.js';
+export * from './visualize/drawMatches.js';
+export * from './visualize/Montage.js';
+export * from './visualize/overlapImages.js';
+//# sourceMappingURL=index.d.ts.map

package/lib/featureMatching/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/featureMatching/index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC"}

package/lib/featureMatching/index.js

@@ -0,0 +1,13 @@
+export * from './descriptors/getBriefDescriptors.js';
+export * from './featureMatching.types.js';
+export * from './keypoints/getFastKeypoints.js';
+export * from './keypoints/getIntensityCentroid.js';
+export * from './keypoints/getOrientedFastKeypoints.js';
+export * from './keypoints/getBestKeypointsInRadius.js';
+export * from './matching/bruteForceMatch.js';
+export * from './matching/getCrosscheckMatches.js';
+export * from './visualize/drawKeypoints.js';
+export * from './visualize/drawMatches.js';
+export * from './visualize/Montage.js';
+export * from './visualize/overlapImages.js';
+//# sourceMappingURL=index.js.map

package/lib/featureMatching/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/featureMatching/index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC"}

package/lib/featureMatching/keypoints/getBestKeypointsInRadius.d.ts

@@ -0,0 +1,9 @@
+import type { OrientedFastKeypoint } from './getOrientedFastKeypoints.js';
+/**
+ * Return the best keypoints within the given radius in pixels.
+ * @param keypoints - Keypoints to process.
+ * @param radius - Minimum distance in pixels between two keypoints.
+ * @returns The filtered keypoints.
+ */
+export declare function getBestKeypointsInRadius(keypoints: OrientedFastKeypoint[], radius?: number): OrientedFastKeypoint[];
+//# sourceMappingURL=getBestKeypointsInRadius.d.ts.map

package/lib/featureMatching/keypoints/getBestKeypointsInRadius.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBestKeypointsInRadius.d.ts","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getBestKeypointsInRadius.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAG1E;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,oBAAoB,EAAE,EACjC,MAAM,SAAI,GACT,oBAAoB,EAAE,CA0BxB"}

package/lib/featureMatching/keypoints/getBestKeypointsInRadius.js

@@ -0,0 +1,30 @@
+import { getKeypointsInRadius } from './utils/getKeypointsInRadius.js';
+/**
+ * Return the best keypoints within the given radius in pixels.
+ * @param keypoints - Keypoints to process.
+ * @param radius - Minimum distance in pixels between two keypoints.
+ * @returns The filtered keypoints.
+ */
+export function getBestKeypointsInRadius(keypoints, radius = 5) {
+    const size = keypoints.length;
+    const keypointsInRadius = getKeypointsInRadius(keypoints, radius);
+    const toIgnore = new Uint8Array(size).fill(0);
+    for (let i = 0; i < size; i++) {
+        const keypoint = keypoints[i];
+        for (const secondKeypointIndex of keypointsInRadius[i]) {
+            const secondKeypoint = keypoints[secondKeypointIndex];
+            if (keypoint.score < secondKeypoint.score) {
+                toIgnore[i] = 1;
+                continue;
+            }
+        }
+    }
+    const result = [];
+    for (let i = 0; i < size; i++) {
+        if (!toIgnore[i]) {
+            result.push(keypoints[i]);
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=getBestKeypointsInRadius.js.map

package/lib/featureMatching/keypoints/getBestKeypointsInRadius.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBestKeypointsInRadius.js","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getBestKeypointsInRadius.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACtC,SAAiC,EACjC,MAAM,GAAG,CAAC;IAEV,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC;IAE9B,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAElE,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QAC9B,KAAK,MAAM,mBAAmB,IAAI,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,MAAM,cAAc,GAAG,SAAS,CAAC,mBAAmB,CAAC,CAAC;YACtD,IAAI,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC;gBAC1C,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBAChB,SAAS;YACX,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/featureMatching/keypoints/getFastKeypoints.d.ts

@@ -0,0 +1,53 @@
+import type { Image } from '../../Image.js';
+import type { Point } from '../../geometry/index.js';
+import type { GetHarrisScoreOptions } from '../featureMatching.types.js';
+import type { IsFastKeypointOptions } from './isFastKeypoint.js';
+export interface GetFastKeypointsOptions extends IsFastKeypointOptions {
+    /**
+     * Maximum number of features to return.
+     * @default `500`
+     */
+    maxNbFeatures?: number;
+    /**
+     * Whether to apply non-max suppression to the keypoints.
+     * This removes all keypoints which
+     * don't have the highest value within the adjacent keypoints.
+     * @default `true`
+     */
+    nonMaxSuppression?: boolean;
+    /**
+     * Radius of the circle used for the algorithm.
+     * @default `3`
+     */
+    fastRadius?: number;
+    /**
+     * Algorithm to use to compute corners score.
+     * @default `'FAST'`
+     */
+    scoreAlgorithm?: 'HARRIS' | 'FAST';
+    /**
+     * Options for the Harris score computation.
+     */
+    harrisScoreOptions?: GetHarrisScoreOptions;
+}
+export interface FastKeypoint {
+    /**
+     * Location of the keypoint in the image.
+     */
+    origin: Point;
+    /**
+     * Score of the keypoint, the bigger it is, the better the feature.
+     * It is the criteria used for the non-maximal suppression.
+     */
+    score: number;
+}
+/**
+ * Find the features in a GREY image according to the FAST (Features from Accelerated Segment Test) algorithm.
+ * Based on the paper Machine Learning for High-Speed Corner Detection.
+ * DOI: https://doi.org/10.1007/11744023_34.
+ * @param image - The image to process.
+ * @param options - Get FAST keypoints options.
+ * @returns The FAST keypoints.
+ */
+export declare function getFastKeypoints(image: Image, options?: GetFastKeypointsOptions): FastKeypoint[];
+//# sourceMappingURL=getFastKeypoints.d.ts.map

package/lib/featureMatching/keypoints/getFastKeypoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFastKeypoints.d.ts","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getFastKeypoints.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAQrD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAIzE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAGjE,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACpE;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IACnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;CAC5C;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IACd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,KAAK,EACZ,OAAO,GAAE,uBAA4B,GACpC,YAAY,EAAE,CAsFhB"}

package/lib/featureMatching/keypoints/getFastKeypoints.js

@@ -0,0 +1,71 @@
+import { match } from 'ts-pattern';
+import { getCirclePoints, getCompassPoints, } from '../../utils/geometry/getCirclePoints.js';
+import { getIndex } from '../../utils/getIndex.js';
+import { surroundingPixels } from '../../utils/surroundingPixels.js';
+import checkProcessable from '../../utils/validators/checkProcessable.js';
+import { getFastScore } from './getFastScore.js';
+import { getHarrisScore } from './getHarrisScore.js';
+import { isFastKeypoint } from './isFastKeypoint.js';
+/**
+ * Find the features in a GREY image according to the FAST (Features from Accelerated Segment Test) algorithm.
+ * Based on the paper Machine Learning for High-Speed Corner Detection.
+ * DOI: https://doi.org/10.1007/11744023_34.
+ * @param image - The image to process.
+ * @param options - Get FAST keypoints options.
+ * @returns The FAST keypoints.
+ */
+export function getFastKeypoints(image, options = {}) {
+    const { fastRadius = 3, scoreAlgorithm = 'FAST', harrisScoreOptions, } = options;
+    const circlePoints = getCirclePoints(fastRadius);
+    const compassPoints = getCompassPoints(fastRadius);
+    const { maxNbFeatures = 500, nbContiguousPixels = (3 / 4) * circlePoints.length, threshold = 20, nonMaxSuppression = true, } = options;
+    checkProcessable(image, {
+        channels: [1],
+        alpha: false,
+    });
+    const getScore = match(scoreAlgorithm)
+        .with('HARRIS', () => {
+        return (image, corner) => getHarrisScore(image, corner, harrisScoreOptions);
+    })
+        .with('FAST', () => {
+        return (image, corner) => getFastScore(image, corner, threshold, circlePoints);
+    })
+        .exhaustive();
+    const allKeypoints = [];
+    const scoreArray = new Float64Array(image.size).fill(Number.NEGATIVE_INFINITY);
+    for (let row = 0; row < image.height; row++) {
+        for (let column = 0; column < image.width; column++) {
+            const corner = { row, column };
+            if (isFastKeypoint(corner, image, circlePoints, compassPoints, {
+                nbContiguousPixels,
+                threshold,
+            })) {
+                const score = getScore(image, corner);
+                scoreArray[getIndex(corner.column, corner.row, image, 0)] = score;
+                allKeypoints.push({ origin: corner, score });
+            }
+        }
+    }
+    let keypoints = [];
+    if (!nonMaxSuppression) {
+        keypoints = allKeypoints;
+    }
+    else {
+        // Non-Maximal Suppression
+        for (const keypoint of allKeypoints) {
+            const currentScore = scoreArray[getIndex(keypoint.origin.column, keypoint.origin.row, image, 0)];
+            for (let i = 0; i < surroundingPixels.length; i++) {
+                const neighbour = surroundingPixels[i];
+                const neighbourScore = scoreArray[getIndex(keypoint.origin.column + neighbour.column, keypoint.origin.row + neighbour.row, image, 0)];
+                if (neighbourScore > currentScore)
+                    break;
+                if (i === surroundingPixels.length - 1) {
+                    keypoints.push(keypoint);
+                }
+            }
+        }
+    }
+    keypoints.sort((a, b) => b.score - a.score);
+    return keypoints.slice(0, maxNbFeatures);
+}
+//# sourceMappingURL=getFastKeypoints.js.map

package/lib/featureMatching/keypoints/getFastKeypoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFastKeypoints.js","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getFastKeypoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAInC,OAAO,EACL,eAAe,EACf,gBAAgB,GACjB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,gBAAgB,MAAM,4CAA4C,CAAC;AAG1E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AA2CrD;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAY,EACZ,UAAmC,EAAE;IAErC,MAAM,EACJ,UAAU,GAAG,CAAC,EACd,cAAc,GAAG,MAAM,EACvB,kBAAkB,GACnB,GAAG,OAAO,CAAC;IAEZ,MAAM,YAAY,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;IACjD,MAAM,aAAa,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAEnD,MAAM,EACJ,aAAa,GAAG,GAAG,EACnB,kBAAkB,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,YAAY,CAAC,MAAM,EAClD,SAAS,GAAG,EAAE,EACd,iBAAiB,GAAG,IAAI,GACzB,GAAG,OAAO,CAAC;IAEZ,gBAAgB,CAAC,KAAK,EAAE;QACtB,QAAQ,EAAE,CAAC,CAAC,CAAC;QACb,KAAK,EAAE,KAAK;KACb,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC;SACnC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE;QACnB,OAAO,CAAC,KAAY,EAAE,MAAa,EAAE,EAAE,CACrC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACtD,CAAC,CAAC;SACD,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;QACjB,OAAO,CAAC,KAAY,EAAE,MAAa,EAAE,EAAE,CACrC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC,CAAC;SACD,UAAU,EAAE,CAAC;IAEhB,MAAM,YAAY,GAAmB,EAAE,CAAC;IAExC,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAClD,MAAM,CAAC,iBAAiB,CACzB,CAAC;IACF,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QAC5C,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC;YACpD,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;YAC/B,IACE,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE;gBACzD,kBAAkB;gBAClB,SAAS;aACV,CAAC,EACF,CAAC;gBACD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBACtC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;gBAClE,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,SAAS,GAAmB,EAAE,CAAC;IACnC,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,SAAS,GAAG,YAAY,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,0BAA0B;QAC1B,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;YACpC,MAAM,YAAY,GAChB,UAAU,CACR,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAChE,CAAC;YACJ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClD,MAAM,SAAS,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;gBACvC,MAAM,cAAc,GAClB,UAAU,CACR,QAAQ,CACN,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,EACzC,QAAQ,CAAC,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC,GAAG,EACnC,KAAK,EACL,CAAC,CACF,CACF,CAAC;gBACJ,IAAI,cAAc,GAAG,YAAY;oBAAE,MAAM;gBACzC,IAAI,CAAC,KAAK,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACvC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAE5C,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;AAC3C,CAAC"}

package/lib/featureMatching/keypoints/getFastScore.d.ts

@@ -0,0 +1,13 @@
+import type { Image } from '../../Image.js';
+import type { Point } from '../../geometry/index.js';
+/**
+ * Compute the score of a keypoint using the function described in the FAST article.
+ * DOI: https://doi.org/10.1007/11744023_34.
+ * @param image - Image to process.
+ * @param origin - Keypoint coordinates.
+ * @param threshold - FAST threshold.
+ * @param circlePoints - Coordinates of the points on the circle.
+ * @returns Score of the corner.
+ */
+export declare function getFastScore(image: Image, origin: Point, threshold: number, circlePoints: Point[]): number;
+//# sourceMappingURL=getFastScore.d.ts.map

package/lib/featureMatching/keypoints/getFastScore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFastScore.d.ts","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getFastScore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAErD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,KAAK,EACb,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,KAAK,EAAE,GACpB,MAAM,CAmBR"}

package/lib/featureMatching/keypoints/getFastScore.js

@@ -0,0 +1,25 @@
+/**
+ * Compute the score of a keypoint using the function described in the FAST article.
+ * DOI: https://doi.org/10.1007/11744023_34.
+ * @param image - Image to process.
+ * @param origin - Keypoint coordinates.
+ * @param threshold - FAST threshold.
+ * @param circlePoints - Coordinates of the points on the circle.
+ * @returns Score of the corner.
+ */
+export function getFastScore(image, origin, threshold, circlePoints) {
+    const currentIntensity = image.getValueByPoint(origin, 0);
+    let brighterSum = 0;
+    let darkerSum = 0;
+    for (const point of circlePoints) {
+        const pointIntensity = image.getValue(origin.column + point.column, origin.row + point.row, 0);
+        if (pointIntensity >= currentIntensity + threshold) {
+            brighterSum += Math.abs(pointIntensity - currentIntensity) - threshold; // circle point is lighter
+        }
+        else if (pointIntensity <= currentIntensity - threshold) {
+            darkerSum += Math.abs(currentIntensity - pointIntensity) - threshold; // circle point is darker
+        }
+    }
+    return Math.max(brighterSum, darkerSum);
+}
+//# sourceMappingURL=getFastScore.js.map

package/lib/featureMatching/keypoints/getFastScore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFastScore.js","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getFastScore.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAY,EACZ,MAAa,EACb,SAAiB,EACjB,YAAqB;IAErB,MAAM,gBAAgB,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE1D,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,QAAQ,CACnC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,EAC5B,MAAM,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,EACtB,CAAC,CACF,CAAC;QACF,IAAI,cAAc,IAAI,gBAAgB,GAAG,SAAS,EAAE,CAAC;YACnD,WAAW,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc,GAAG,gBAAgB,CAAC,GAAG,SAAS,CAAC,CAAC,0BAA0B;QACpG,CAAC;aAAM,IAAI,cAAc,IAAI,gBAAgB,GAAG,SAAS,EAAE,CAAC;YAC1D,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,cAAc,CAAC,GAAG,SAAS,CAAC,CAAC,yBAAyB;QACjG,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;AAC1C,CAAC"}

package/lib/featureMatching/keypoints/getHarrisScore.d.ts

@@ -0,0 +1,20 @@
+import type { Image } from '../../Image.js';
+import type { Point } from '../../geometry/index.js';
+import type { GetHarrisScoreOptions } from '../featureMatching.types.js';
+/**
+ * Get the Harris score of a corner. The idea behind the algorithm is that a
+ * slight shift of a window around a corner along x and y shoud result in
+ * a very different image.
+ *
+ * We distinguish 3 cases:
+ * - the score is highly negative: you have an edge
+ * - the abolute value of the score is small: the region is flat
+ * - the score is highly positive: you have a corner.
+ * @see {@link https://en.wikipedia.org/wiki/Harris_corner_detector}
+ * @param image - Image to which the corner belongs. It must be a greyscale image with only one channel.
+ * @param origin - Center of the window, where the corner should be.
+ * @param options - Get Harris score options.
+ * @returns The Harris score.
+ */
+export declare function getHarrisScore(image: Image, origin: Point, options?: GetHarrisScoreOptions): number;
+//# sourceMappingURL=getHarrisScore.d.ts.map

package/lib/featureMatching/keypoints/getHarrisScore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getHarrisScore.d.ts","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getHarrisScore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEzE;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,KAAK,EACb,OAAO,GAAE,qBAA0B,GAClC,MAAM,CA8CR"}

package/lib/featureMatching/keypoints/getHarrisScore.js

@@ -0,0 +1,55 @@
+import { EigenvalueDecomposition, Matrix, WrapperMatrix1D } from 'ml-matrix';
+import { SOBEL_X, SOBEL_Y } from '../../utils/constants/kernels.js';
+/**
+ * Get the Harris score of a corner. The idea behind the algorithm is that a
+ * slight shift of a window around a corner along x and y shoud result in
+ * a very different image.
+ *
+ * We distinguish 3 cases:
+ * - the score is highly negative: you have an edge
+ * - the abolute value of the score is small: the region is flat
+ * - the score is highly positive: you have a corner.
+ * @see {@link https://en.wikipedia.org/wiki/Harris_corner_detector}
+ * @param image - Image to which the corner belongs. It must be a greyscale image with only one channel.
+ * @param origin - Center of the window, where the corner should be.
+ * @param options - Get Harris score options.
+ * @returns The Harris score.
+ */
+export function getHarrisScore(image, origin, options = {}) {
+    const { windowSize = 7, harrisConstant = 0.04 } = options;
+    if (!(windowSize % 2)) {
+        throw new TypeError('windowSize must be an odd integer');
+    }
+    const cropOrigin = {
+        row: origin.row - (windowSize - 1) / 2,
+        column: origin.column - (windowSize - 1) / 2,
+    };
+    const window = image.crop({
+        origin: cropOrigin,
+        width: windowSize,
+        height: windowSize,
+    });
+    const xDerivative = window.gradientFilter({ kernelX: SOBEL_X });
+    const yDerivative = window.gradientFilter({ kernelY: SOBEL_Y });
+    const xMatrix = new WrapperMatrix1D(xDerivative.getRawImage().data, {
+        rows: xDerivative.height,
+    });
+    const yMatrix = new WrapperMatrix1D(yDerivative.getRawImage().data, {
+        rows: yDerivative.height,
+    });
+    const xx = xMatrix.mmul(xMatrix);
+    const xy = yMatrix.mmul(xMatrix);
+    const yy = yMatrix.mmul(yMatrix);
+    const xxSum = xx.sum();
+    const xySum = xy.sum();
+    const yySum = yy.sum();
+    const structureTensor = new Matrix([
+        [xxSum, xySum],
+        [xySum, yySum],
+    ]);
+    const eigenValues = new EigenvalueDecomposition(structureTensor)
+        .realEigenvalues;
+    return (eigenValues[0] * eigenValues[1] -
+        harrisConstant * (eigenValues[0] + eigenValues[1]) ** 2);
+}
+//# sourceMappingURL=getHarrisScore.js.map

package/lib/featureMatching/keypoints/getHarrisScore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getHarrisScore.js","sourceRoot":"","sources":["../../../src/featureMatching/keypoints/getHarrisScore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAI7E,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAGpE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAY,EACZ,MAAa,EACb,UAAiC,EAAE;IAEnC,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,cAAc,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAE1D,IAAI,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,UAAU,GAAG;QACjB,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,CAAC;QACtC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,CAAC;KAC7C,CAAC;IACF,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,MAAM,EAAE,UAAU;QAClB,KAAK,EAAE,UAAU;QACjB,MAAM,EAAE,UAAU;KACnB,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAChE,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAEhE,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE;QAClE,IAAI,EAAE,WAAW,CAAC,MAAM;KACzB,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE;QAClE,IAAI,EAAE,WAAW,CAAC,MAAM;KACzB,CAAC,CAAC;IAEH,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEjC,MAAM,KAAK,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;IAEvB,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC;QACjC,CAAC,KAAK,EAAE,KAAK,CAAC;QACd,CAAC,KAAK,EAAE,KAAK,CAAC;KACf,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,IAAI,uBAAuB,CAAC,eAAe,CAAC;SAC7D,eAAe,CAAC;IAEnB,OAAO,CACL,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;QAC/B,cAAc,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CACxD,CAAC;AACJ,CAAC"}