BFMatcher_create

Features and matchingfunctionOpenCV 5.0.0

import { BFMatcher_create } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

Explore visually: Brute-force descriptor matching →

Compare each query descriptor with every training descriptor using a chosen distance.

VISUAL WALKTHROUGHMatching

REFERENCE INPUTOne query, six descriptors

A short binary descriptor makes pairwise differences visible. Orange is the query; violet rows are candidates.

→

RESULTKeep the nearest candidates

The best match is evidence of similar appearance. Ambiguity filtering and geometric verification remain separate steps.

Illustrative example. The stages explain the method; they are not a live OpenCV execution.

Brute-force matcher create method.

BFMatcher_create(normType: number, crossCheck: boolean): BFMatcher | null;

3 available overloads

BFMatcher_create(): BFMatcher | null;

BFMatcher_create(normType: number): BFMatcher | null;

BFMatcher_create(normType: number, crossCheck: boolean): BFMatcher | null;

normType

One of NORM_L1, NORM_L2, NORM_HAMMING, NORM_HAMMING2. L1 and L2 norms are preferable choices for SIFT and SURF descriptors, NORM_HAMMING should be used with ORB, BRISK and BRIEF, NORM_HAMMING2 should be used with ORB when WTA_K==3 or 4 (see ORB::ORB constructor description).

crossCheck

If it is false, this is will be default BFMatcher behaviour when it finds the k nearest neighbors for each query descriptor. If crossCheck==true, then the knnMatch() method with k=1 will only return pairs (i,j) such that for i-th query descriptor the j-th descriptor in the matcher's collection is the nearest and vice versa, i.e. the BFMatcher will only return consistent pairs. Such technique usually produces best results with minimal number of outliers when there are enough matches. This is alternative to the ratio test, used by D. Lowe in SIFT paper.

Returns

The BFMatcher | null result.

Upstream declaration ↗

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.