Skip to content

xfeatures2d_BEBLID

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

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

ARGUMENTSConstructor or factory
CLASSxfeatures2d_BEBLID
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 BEBLID (Boosted Efficient Binary Local Image Descriptor), described in [Suarez2020BEBLID] .

BEBLID [Suarez2020BEBLID] is a efficient binary descriptor learned with boosting. It is able to describe keypoints from any detector just by changing the scale_factor parameter. In several benchmarks it has proved to largely improve other binary descriptors like ORB or BRISK with the same efficiency. BEBLID describes using the difference of mean gray values in different regions of the image around the KeyPoint, the descriptor is specifically optimized for image matching and patch retrieval addressing the asymmetries of these problems.

If you find this code useful, please add a reference to the following paper: <BLOCKQUOTE> Iago Suárez, Ghesn Sfeir, José M. Buenaposada, and Luis Baumela. BEBLID: Boosted efficient binary local image descriptor. Pattern Recognition Letters, 133:366-372, 2020. </BLOCKQUOTE>

The descriptor was trained using 1 million of randomly sampled pairs of patches (20% positives and 80% negatives) from the Liberty split of the UBC datasets [winder2007learning] as described in the paper [Suarez2020BEBLID]. You can check in the AKAZE example how well BEBLID works. Detecting 10000 keypoints with ORB and describing with BEBLID obtains 561 inliers (75%) whereas describing with ORB obtains only 493 inliers (63%).

Constructors and members

static create

Creates the BEBLID descriptor.

create(scale_factor: number, n_bits: number): xfeatures2d_BEBLID | null;
2 available overloads
create(scale_factor: number): xfeatures2d_BEBLID | null;
create(scale_factor: number, n_bits: number): xfeatures2d_BEBLID | null;
scale_factor

Adjust the sampling window around detected keypoints:

  • <b> 1.00f </b> should be the scale for ORB keypoints
  • <b> 6.75f </b> should be the scale for SIFT detected keypoints
  • <b> 6.25f </b> is default and fits for KAZE, SURF detected keypoints
  • <b> 5.00f </b> should be the scale for AKAZE, MSD, AGAST, FAST, BRISK keypoints
n_bits

Determine the number of bits in the descriptor. Should be either BEBLID::SIZE_512_BITS or BEBLID::SIZE_256_BITS.

Returns

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

setScaleFactor

Set the scale factor used by this xfeatures2d_BEBLID object.

setScaleFactor(scale_factor: number): void;
scale_factor

scale factor argument (number).

getScaleFactor

Return the scale factor configured on this xfeatures2d_BEBLID object.

getScaleFactor(): number;
Returns

The number result.

getDefaultName

Return the default name configured on this xfeatures2d_BEBLID 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.