Skip to content

xfeatures2d_VGG

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

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

ARGUMENTSConstructor or factory
CLASSxfeatures2d_VGG
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 VGG (Oxford Visual Geometry Group) descriptor trained end to end using "Descriptor Learning Using Convex Optimisation" (DLCO) aparatus described in [Simonyan14].

Constructors and members

static create

Create an owned xfeatures2d_VGG instance with the supplied configuration.

Class implementing VGG (Oxford Visual Geometry Group) descriptor trained end to end using "Descriptor Learning Using Convex Optimisation" (DLCO) aparatus described in [Simonyan14].

create(desc: number, isigma: number, img_normalize: boolean, use_scale_orientation: boolean, scale_factor: number, dsc_normalize: boolean): xfeatures2d_VGG | null;
7 available overloads
create(): xfeatures2d_VGG | null;
create(desc: number): xfeatures2d_VGG | null;
create(desc: number, isigma: number): xfeatures2d_VGG | null;
create(desc: number, isigma: number, img_normalize: boolean): xfeatures2d_VGG | null;
create(desc: number, isigma: number, img_normalize: boolean, use_scale_orientation: boolean): xfeatures2d_VGG | null;
create(desc: number, isigma: number, img_normalize: boolean, use_scale_orientation: boolean, scale_factor: number): xfeatures2d_VGG | null;
create(desc: number, isigma: number, img_normalize: boolean, use_scale_orientation: boolean, scale_factor: number, dsc_normalize: boolean): xfeatures2d_VGG | null;
desc

desc argument (number).

isigma

isigma argument (number).

img_normalize

img normalize argument (boolean).

use_scale_orientation

use scale orientation argument (boolean).

scale_factor

scale factor argument (number).

dsc_normalize

dsc normalize argument (boolean).

Returns

The xfeatures2d_VGG | 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_VGG object.

getDefaultName(): string;
Returns

The string result.

setSigma

Set the sigma used by this xfeatures2d_VGG object.

setSigma(isigma: number): void;
isigma

isigma argument (number).

getSigma

Return the sigma configured on this xfeatures2d_VGG object.

getSigma(): number;
Returns

The number result.

setUseNormalizeImage

Set the use normalize image used by this xfeatures2d_VGG object.

setUseNormalizeImage(img_normalize: boolean): void;
img_normalize

img normalize argument (boolean).

getUseNormalizeImage

Return the use normalize image configured on this xfeatures2d_VGG object.

getUseNormalizeImage(): boolean;
Returns

The boolean result.

setUseScaleOrientation

Set the use scale orientation used by this xfeatures2d_VGG 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_VGG object.

getUseScaleOrientation(): boolean;
Returns

The boolean result.

setScaleFactor

Set the scale factor used by this xfeatures2d_VGG object.

setScaleFactor(scale_factor: number): void;
scale_factor

scale factor argument (number).

getScaleFactor

Return the scale factor configured on this xfeatures2d_VGG object.

getScaleFactor(): number;
Returns

The number result.

setUseNormalizeDescriptor

Set the use normalize descriptor used by this xfeatures2d_VGG object.

setUseNormalizeDescriptor(dsc_normalize: boolean): void;
dsc_normalize

dsc normalize argument (boolean).

getUseNormalizeDescriptor

Return the use normalize descriptor configured on this xfeatures2d_VGG object.

getUseNormalizeDescriptor(): boolean;
Returns

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