Skip to content

xfeatures2d_TBMR

xfeatures2dclassOpenCV 5.0.0
import { xfeatures2d_TBMR } from '@banou/opencv-wasm'

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

ARGUMENTSConstructor or factory
CLASSxfeatures2d_TBMR
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. Inherits xfeatures2d_AffineFeature2D.

Class implementing the Tree Based Morse Regions (TBMR) as described in [Najman2014] extended with scaled extraction ability.

Note: This algorithm is based on Component Tree (Min/Max) as well as MSER but uses a Morse-theory approach to extract features.

Features are ellipses (similar to MSER, however a MSER feature can never be a TBMR feature and vice versa).

Constructors and members

static create

Creates an instance where keypoint detector and descriptor extractor are identical.

create(min_area: number, max_area_relative: number, scale_factor: number, n_scales: number): xfeatures2d_TBMR | null;
5 available overloads
create(): xfeatures2d_TBMR | null;
create(min_area: number): xfeatures2d_TBMR | null;
create(min_area: number, max_area_relative: number): xfeatures2d_TBMR | null;
create(min_area: number, max_area_relative: number, scale_factor: number): xfeatures2d_TBMR | null;
create(min_area: number, max_area_relative: number, scale_factor: number, n_scales: number): xfeatures2d_TBMR | null;
min_area

min area argument (number).

max_area_relative

max area relative argument (number).

scale_factor

scale factor argument (number).

n_scales

n scales argument (number).

Returns

The xfeatures2d_TBMR | null result.

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.

setMinArea

Set the min area used by this xfeatures2d_TBMR object.

setMinArea(minArea: number): void;
minArea

min area argument (number).

getMinArea

Return the min area configured on this xfeatures2d_TBMR object.

getMinArea(): number;
Returns

The number result.

setMaxAreaRelative

Set the max area relative used by this xfeatures2d_TBMR object.

setMaxAreaRelative(maxArea: number): void;
maxArea

max area argument (number).

getMaxAreaRelative

Return the max area relative configured on this xfeatures2d_TBMR object.

getMaxAreaRelative(): number;
Returns

The number result.

setScaleFactor

Set the scale factor used by this xfeatures2d_TBMR object.

setScaleFactor(scale_factor: number): void;
scale_factor

scale factor argument (number).

getScaleFactor

Return the scale factor configured on this xfeatures2d_TBMR object.

getScaleFactor(): number;
Returns

The number result.

setNScales

Set the nscales used by this xfeatures2d_TBMR object.

setNScales(n_scales: number): void;
n_scales

n scales argument (number).

getNScales

Return the nscales configured on this xfeatures2d_TBMR object.

getNScales(): number;
Returns

The number result.

getDefaultName

Return the default name configured on this xfeatures2d_TBMR object.

getDefaultName(): string;
Returns

The string result.

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.