Skip to content

xfeatures2d_LUCID

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

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

ARGUMENTSConstructor or factory
CLASSxfeatures2d_LUCID
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 the locally uniform comparison image descriptor, described in [LUCID]

An image descriptor that can be computed very fast, while being about as robust as, for example, SURF or BRIEF.

Note: It requires a color image as input.

Constructors and members

static create

Create an owned xfeatures2d_LUCID instance with the supplied configuration.

Class implementing the locally uniform comparison image descriptor, described in [LUCID]

create(lucid_kernel: number, blur_kernel: number): xfeatures2d_LUCID | null;
3 available overloads
create(): xfeatures2d_LUCID | null;
create(lucid_kernel: number): xfeatures2d_LUCID | null;
create(lucid_kernel: number, blur_kernel: number): xfeatures2d_LUCID | null;
lucid_kernel

kernel for descriptor construction, where 1=3x3, 2=5x5, 3=7x7 and so forth

blur_kernel

kernel for blurring image prior to descriptor construction, where 1=3x3, 2=5x5, 3=7x7 and so forth

Returns

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

setLucidKernel

Set the lucid kernel used by this xfeatures2d_LUCID object.

setLucidKernel(lucid_kernel: number): void;
lucid_kernel

lucid kernel argument (number).

getLucidKernel

Return the lucid kernel configured on this xfeatures2d_LUCID object.

getLucidKernel(): number;
Returns

The number result.

setBlurKernel

Set the blur kernel used by this xfeatures2d_LUCID object.

setBlurKernel(blur_kernel: number): void;
blur_kernel

blur kernel argument (number).

getBlurKernel

Return the blur kernel configured on this xfeatures2d_LUCID object.

getBlurKernel(): number;
Returns

The number result.

getDefaultName

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