Package Exports

@udarrr/template-matcher
@udarrr/template-matcher/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@udarrr/template-matcher) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OpenCV 4.1.1 Template Matching Image Finder

It's plugin for nutjs project or standalone with some features like

increased accuracy
increased performance
added some customOptions for arguments providerData in nutjs implemented in nutjs > version 3, also available in standalone
added standalone

Installation for nutjs

npm i @udarrr/template-matcher

and then just use it in your project once

import "@udarrr/template-matcher"` or `require("@udarrr/template-matcher")

Installation for standalone

npm i @udarrr/template-matcher

and connect finder to your project

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

//some examples
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});

Options

//@udarrr/template-matcher@2.0.1 with nutjs 3.1.1 options 
{
    confidence?: number,
    providerData?: {
                       searchMultipleScales?: boolean,
                       methodType?: MethodNameType; 
                       scaleSteps?: Array<number>; 
                       roi?: Region; 
                       debug?: boolean
                    },
}

//standalone @udarrr/template-matcher@2.0.1
{
    haystack?: string | Image,
    needle: string | Image,
    confidence?: number,
    providerData?: {
                       searchMultipleScales?: boolean,
                       methodType?: MethodNameType; 
                       scaleSteps?: Array<number>; 
                       roi?: Region; 
                       debug?: boolean
                    },
}

// 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

// 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