Skip to content
opencv-wasm

detail_FeaturesMatcher

stitchingclassOpenCV 5.0.0
import { detail_FeaturesMatcher } from '@banou/opencv-wasm'

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

ARGUMENTSConstructor or factory
CLASSdetail_FeaturesMatcher
RETURN TYPEOwned native handle
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Native object: release it with using or delete(). Factories can return null; check before calling methods.

Feature matchers base class.

Upstream declaration ↗

Constructors and members

clone

Create another handle to the same native object. This retains the object without copying its pixels or algorithm state; dispose both handles separately.

clone(): this;
Returns

The this result.

apply

Performs images matching.

See: detail::MatchesInfo

apply(features1: detail_ImageFeatures, features2: detail_ImageFeatures, matches_info: detail_MatchesInfo): void;
features1

First image features

features2

Second image features

matches_info

Output destination, filled by the native operation. Found matches

Upstream declaration ↗

apply2

Performs images matching.

See: detail::MatchesInfo

apply2(features: detail__ImageFeaturesVector, pairwise_matches: detail__MatchesInfoVector, mask: UMat): void;
2 available overloads
apply2(features: detail__ImageFeaturesVector, pairwise_matches: detail__MatchesInfoVector): void;
apply2(features: detail__ImageFeaturesVector, pairwise_matches: detail__MatchesInfoVector, mask: UMat): void;
features

Features of the source images

pairwise_matches

Output destination, filled by the native operation. Found pairwise matches

mask

Mask indicating which image pairs must be matched

The function is parallelized with the TBB library.

Upstream declaration ↗

isThreadSafe

Return whether the native matcher reports that its implementation supports concurrent use.

isThreadSafe(): boolean;
Returns

True, if it's possible to use the same matcher instance in parallel, false otherwise

Upstream declaration ↗

collectGarbage

Frees unused memory allocated before if there is any.

collectGarbage(): void;

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.