Skip to content

xfeatures2d_BoostDesc

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

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

ARGUMENTSConstructor or factory
CLASSxfeatures2d_BoostDesc
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_Feature2D.

Class implementing BoostDesc (Learning Image Descriptors with Boosting), described in [Trzcinski13a] and [Trzcinski13b].

Note: BGM is the base descriptor where each binary dimension is computed as the output of a single weak learner. BGM_HARD and BGM_BILINEAR refers to same BGM but use different type of gradient binning. In the BGM_HARD that use ASSIGN_HARD binning type the gradient is assigned to the nearest orientation bin. In the BGM_BILINEAR that use ASSIGN_BILINEAR binning type the gradient is assigned to the two neighbouring bins. In the BGM and all other modes that use ASSIGN_SOFT binning type the gradient is assigned to 8 nearest bins according to the cosine value between the gradient angle and the bin center. LBGM (alias FP-Boost) is the floating point extension where each dimension is computed as a linear combination of the weak learner responses. BINBOOST and subvariants are the binary extensions of LBGM where each bit is computed as a thresholded linear combination of a set of weak learners. BoostDesc header files (boostdesc_*.i) was exported from original binaries with export-boostdesc.py script from samples subfolder.

Constructors and members

static create

Create an owned xfeatures2d_BoostDesc instance with the supplied configuration.

Class implementing BoostDesc (Learning Image Descriptors with Boosting), described in [Trzcinski13a] and [Trzcinski13b].

create(desc: number, use_scale_orientation: boolean, scale_factor: number): xfeatures2d_BoostDesc | null;
4 available overloads
create(): xfeatures2d_BoostDesc | null;
create(desc: number): xfeatures2d_BoostDesc | null;
create(desc: number, use_scale_orientation: boolean): xfeatures2d_BoostDesc | null;
create(desc: number, use_scale_orientation: boolean, scale_factor: number): xfeatures2d_BoostDesc | null;
desc

desc argument (number).

use_scale_orientation

use scale orientation argument (boolean).

scale_factor

scale factor argument (number).

Returns

The xfeatures2d_BoostDesc | 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.

getDefaultName

Return the default name configured on this xfeatures2d_BoostDesc object.

getDefaultName(): string;
Returns

The string result.

setUseScaleOrientation

Set the use scale orientation used by this xfeatures2d_BoostDesc object.

setUseScaleOrientation(use_scale_orientation: boolean): void;
use_scale_orientation

use scale orientation argument (boolean).

getUseScaleOrientation

Return the use scale orientation configured on this xfeatures2d_BoostDesc object.

getUseScaleOrientation(): boolean;
Returns

The boolean result.

setScaleFactor

Set the scale factor used by this xfeatures2d_BoostDesc object.

setScaleFactor(scale_factor: number): void;
scale_factor

scale factor argument (number).

getScaleFactor

Return the scale factor configured on this xfeatures2d_BoostDesc object.

getScaleFactor(): number;
Returns

The number 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.