@udarrr/template-matcher

OpenCV 4.1.1 Template Matching Image Finder

It's either standalone or plugin for nutjs project

Standalone findMatch,findMatches

npm i @udarrr/template-matcher

import finder from "@udarrr/template-matcher";

(async () => {
const matcheImages = await finder.findMatch({haystack: 'pathToImage', needle: 'pathToTemplate'});
const matcheWithScreen = await finder.findMatch({needle: pathToTemplate});

const matchesImages = await finder.findMatches({haystack: 'pathToImage', needle: 'pathToTemplate'});
const matchesWithScreen = await finder.findMatches({needle: 'pathToTemplate'});
})();

@udarrr/template-matcher standalone API

{
    haystack?: string | Image,
    needle: string | Image,
    confidence?: number,
    searchMultipleScales?: boolean,
    customOptions?: {
                       methodType?: MethodNameType; 
                       scaleSteps?: Array<number>; 
                       roi?: Region; 
                       debug?: boolean
                    },
}

Nutjs v3 find,findAll

npm i @udarrr/template-matcher@2.0.4

import { imageResource, screen } from '@nut-tree/nut-js';
import { CustomOptionsType } from '@udarrr/template-matcher/lib/template-matching-finder.class';
import "@udarrr/template-matcher"; //once wherever

(async () => {
  const img = await screen.find<CustomOptionsType>(imageResource("path"),{ providerData: {...}});
  const imgs = await screen.findAll<CustomOptionsType>(imageResource("path"),{ providerData: {...}});
})();

@udarrr/template-matcher providerData nutjs v3 Api

{
  providerData?: {
    searchMultipleScales?: boolean;
    methodType?: MethodNameType;
    scaleSteps?: Array<number>;
    roi?: Region;
    debug?: boolean;
  };
};

Values by default

methodType: "TM_CCOEFF" | "TM_CCOEFF_NORMED" | "TM_CCORR" | "TM_CCORR_NORMED" | "TM_SQDIFF" | "TM_SQDIFF_NORMED" by default "TM_CCOEFF_NORMED"
scaleSteps:  [0.9]; by default  [1, 0.9, 0.8, 0.7, 0.6, 0.5]
debug: true | false by default false
confidence: for "TM_SQDIFF" | "TM_SQDIFF_NORMED" confidence by default 0.98 for "TM_CCOEFF" | "TM_CCOEFF_NORMED" | "TM_CCORR" | "TM_CCORR_NORMED" by default 0.8

Disclaimer for nutjs v3

In case using the package with nutjs v3 or above please use precise 2.0.4 version of the package it could be prevented in package.json lile

 "@udarrr/template-matcher": "~2.0.4",