@repeato/native-cv 0.2.0 → 0.2.2

package/README.internal.md

@@ -8,7 +8,7 @@ Native OpenCV-based template matching module for Node.js with static linking for
 - **Electron Ready**: Pre-built for Electron applications
 - **Cross-Platform**: Supports macOS, Windows, and Linux
 - **Template Matching**: High-performance template matching using OpenCV
-- **SIFT Features**: Advanced feature detection and matching
+- **ORB Features**: Advanced feature detection and matching
 
 ## Installation
 
@@ -27,8 +27,8 @@ npm run build:electron
 ```javascript
 const native = require('./build/Release/repeato-native-cv.node');
 
-// SiftObjectFinder requires parameters
-const sof = new native.SiftObjectFinder({
+// OrbObjectFinder requires parameters
+const sof = new native.OrbObjectFinder({
   kMinMatches: 10,        // Minimum matches required
   goodMatchTh: 0.75,      // Good match threshold (0.0-1.0)
   clusterSearchRadius: 50  // Cluster search radius in pixels
@@ -44,7 +44,7 @@ const tmw = new native.TemplateMatcher();
 const path = require('path');
 const native = require(path.join(__dirname, 'native', 'repeato-native-cv.node'));
 
-const sof = new native.SiftObjectFinder({
+const sof = new native.OrbObjectFinder({
   kMinMatches: 10,
   goodMatchTh: 0.75,
   clusterSearchRadius: 50
@@ -129,7 +129,7 @@ repeato-native-cv/
 ├── src/
 │   ├── module.cc              # Main N-API module
 │   ├── template_matcher.cc    # Template matching implementation
-│   └── sift_object_finder.cc  # SIFT/ORB object detection
+│   └── orb_object_finder.cc   # ORB object detection
 ├── scripts/
 │   ├── download-opencv.js     # OpenCV download/build
 │   ├── build-electron.js      # Electron build script

package/index.d.ts

@@ -67,8 +67,11 @@ export function calcImageDiffPercentage(options: CalcImageDiffPercentageOptions)
 /** Thread-safe template matching using per-call native instances. */
 export function findObjectViaTemplate(options: FindObjectViaTemplateOptions): Promise<MatchResult[]>;
 
-/** Thread-safe SIFT/ORB matching using per-call native instances. */
-export function findObjectViaSift(options: FindObjectViaSiftOptions): Promise<ObjectResult[]>;
+/** Thread-safe ORB matching using per-call native instances. */
+export function findObjectViaOrb(options: FindObjectViaOrbOptions): Promise<ObjectResult[]>;
+
+/** Smart finder that combines template matching with ORB/SIFT support scoring. */
+export function findObjectSmart(options: FindObjectSmartOptions): Promise<MatchResult[]>;
 
 export interface FindObjectViaTemplateOptions {
   templateBuffer: Buffer;
@@ -83,7 +86,7 @@ export interface FindObjectViaTemplateOptions {
   debug?: boolean;
 }
 
-export interface FindObjectViaSiftOptions {
+export interface FindObjectViaOrbOptions {
   templateBuffer: Buffer;
   frameBuffer: Buffer;
   minMatches: number;
@@ -96,6 +99,14 @@ export interface FindObjectViaSiftOptions {
   debug?: boolean;
 }
 
+export interface FindObjectSmartOptions extends FindObjectViaTemplateOptions {
+  kMinMatches?: number;
+  goodMatchTh?: number;
+  clusterSearchRadius?: number;
+  smartRelaxedAccuracy?: number;
+  smartUseOrbForNonScaleInvariant?: boolean;
+}
+
 export interface DiffBoundingBox {
   x: number;
   y: number;

package/index.js

@@ -328,8 +328,8 @@ const findObjectViaTemplate = async options => {
   }])
 }
 
-const findObjectViaSift = async options => {
-  assertOptionsObject(options, 'findObjectViaSift')
+const findObjectViaOrb = async options => {
+  assertOptionsObject(options, 'findObjectViaOrb')
   const {
     templateBuffer,
     frameBuffer,
@@ -342,7 +342,7 @@ const findObjectViaSift = async options => {
     roi,
     debug = false
   } = options
-  return runNative('findObjectViaSift', [{
+  return runNative('findObjectViaOrb', [{
     templateBuffer: toBuffer(templateBuffer, 'templateBuffer'),
     frameBuffer: toBuffer(frameBuffer, 'frameBuffer'),
     minMatches,
@@ -356,6 +356,45 @@ const findObjectViaSift = async options => {
   }])
 }
 
+const findObjectSmart = async options => {
+  assertOptionsObject(options, 'findObjectSmart')
+  const {
+    templateBuffer,
+    frameBuffer,
+    minMatches,
+    optimalMatches,
+    timeout,
+    resolutionFixScale = 1,
+    scaleInvariant = false,
+    accuracy = 1,
+    kMinMatches = 10,
+    goodMatchTh = 0.75,
+    clusterSearchRadius = 50,
+    smartRelaxedAccuracy,
+    smartUseOrbForNonScaleInvariant,
+    roi,
+    debug = false
+  } = options
+
+  return runNative('findObjectSmart', [{
+    templateBuffer: toBuffer(templateBuffer, 'templateBuffer'),
+    frameBuffer: toBuffer(frameBuffer, 'frameBuffer'),
+    minMatches,
+    optimalMatches,
+    timeout,
+    resolutionFixScale,
+    scaleInvariant,
+    accuracy,
+    kMinMatches,
+    goodMatchTh,
+    clusterSearchRadius,
+    smartRelaxedAccuracy,
+    smartUseOrbForNonScaleInvariant,
+    roi,
+    debug
+  }])
+}
+
 const shutdown = async () => {
   if (nativeCvPool) {
     await nativeCvPool.shutdown()
@@ -370,7 +409,8 @@ module.exports = {
   calcImageDiffBoundingBox,
   calcImageDiffPercentage,
   findObjectViaTemplate,
-  findObjectViaSift,
+  findObjectViaOrb,
+  findObjectSmart,
   shutdown,
 
   // JavaScript wrapper classes
@@ -384,7 +424,8 @@ module.exports = {
     calcImageDiffBoundingBox,
     calcImageDiffPercentage,
     findObjectViaTemplate,
-    findObjectViaSift,
+    findObjectViaOrb,
+    findObjectSmart,
     shutdown
   }
 };

package/native.js

@@ -37,11 +37,11 @@ if (!native) {
     calcImageDiffBoundingBox: makeMissing('calcImageDiffBoundingBox'),
     calcImageDiffPercentage: makeMissing('calcImageDiffPercentage'),
     findObjectViaTemplate: makeMissing('findObjectViaTemplate'),
-    findObjectViaSift: makeMissing('findObjectViaSift')
+    findObjectViaOrb: makeMissing('findObjectViaOrb')
   }
 } else {
   // Ensure expected helper exports are present; if not, provide explicit error placeholders.
-  const expected = ['getMeanStdDev', 'getImageSize', 'calcImageDiffBoundingBox', 'calcImageDiffPercentage', 'findObjectViaTemplate', 'findObjectViaSift']
+  const expected = ['getMeanStdDev', 'getImageSize', 'calcImageDiffBoundingBox', 'calcImageDiffPercentage', 'findObjectViaTemplate', 'findObjectViaOrb']
   for (const key of expected) {
     if (!Object.prototype.hasOwnProperty.call(native, key)) {
       const msg = `Native build missing expected export '${key}'.`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repeato/native-cv",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Native OpenCV-based template matching module for Node.js, replacing opencv4nodejs-m1.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -37,6 +37,7 @@
     "url": "git+https://github.com/repeato-qa/repeato-native-cv.git"
   },
   "dependencies": {
+    "jimp": "^0.22.12",
     "node-addon-api": "^7.0.0",
     "node-gyp-build": "^4.8.4"
   },