@scanmate/align 0.0.2

package/dist/src/transform-fitting/ransac.use-case.d.ts

@@ -0,0 +1,36 @@
+import type { Matrix3, TransformModel } from '@scanmate/ink';
+import type { Correspondence } from './fit-transform.use-case.js';
+/**
+ * RANSAC: fit the model that the largest number of correspondences agree with.
+ *
+ * Feature matching on a document produces a lot of confident nonsense, because
+ * the page is full of things that genuinely look identical — every lowercase
+ * "e", every corner of every table cell. Least squares over all of them is
+ * dragged wherever the wrong ones point. RANSAC ignores the average: it draws
+ * the smallest sample that determines a transform, counts how many of the rest
+ * that transform explains, and repeats. A wrong sample agrees with almost
+ * nothing; the right one agrees with everything real on the page.
+ */
+export interface RansacOptions {
+    model: TransformModel;
+    /** A correspondence is an inlier when it reprojects within this many pixels. */
+    threshold: number;
+    maxIterations?: number;
+    /** Probability of having drawn at least one all-inlier sample. Drives early exit. */
+    confidence?: number;
+    /** Below this many inliers the answer is rejected outright. */
+    minInliers?: number;
+    seed?: number;
+}
+export interface RansacResult {
+    matrix: Matrix3;
+    /** Indices into the input array. */
+    inliers: number[];
+    inlierRatio: number;
+    iterations: number;
+    /** Mean reprojection error over the inliers, in pixels. */
+    error: number;
+}
+export declare function ransac(matches: readonly Correspondence[], options: RansacOptions): RansacResult | null;
+export declare function findInliers(matches: readonly Correspondence[], matrix: Matrix3, threshold: number): number[];
+//# sourceMappingURL=ransac.use-case.d.ts.map

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@scanmate/align",
+  "version": "0.0.2",
+  "description": "Put a scanned or photographed page back onto the original it came from: deskew, rescale and register, trying transform models until one is good enough.",
+  "license": "MIT",
+  "author": "Eduardo Russo",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/russoedu/scanmate.git",
+    "directory": "packages/align"
+  },
+  "homepage": "https://github.com/russoedu/scanmate/tree/main/packages/align#readme",
+  "bugs": {
+    "url": "https://github.com/russoedu/scanmate/issues"
+  },
+  "keywords": [
+    "scan",
+    "alignment",
+    "image-registration",
+    "deskew",
+    "homography",
+    "orb",
+    "ransac",
+    "document"
+  ],
+  "type": "module",
+  "main": "./dist/index.esm.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "default": "./dist/index.esm.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo",
+    "!**/*.d.ts.map",
+    "!**/*.js.map"
+  ],
+  "dependencies": {
+    "@scanmate/ink": "^0.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}