Skip to content

xfeatures2d_AKAZE

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

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

Native object: release it with using or delete(). Factories can return null; check before calling methods. Inherits xfeatures2d_Feature2D.

Class implementing the AKAZE keypoint detector and descriptor extractor, described in [ANB13].

AKAZE descriptors can only be used with KAZE or AKAZE keypoints. This class is thread-safe.

Note: When you need descriptors use Feature2D::detectAndCompute, which provides better performance. When using Feature2D::detect followed by Feature2D::compute scale space pyramid is computed twice.

Note: AKAZE implements T-API. When image is passed as UMat some parts of the algorithm will use OpenCL.

Note: [ANB13] Fast Explicit Diffusion for Accelerated Features in Nonlinear Scale Spaces. Pablo F. Alcantarilla, Jesús Nuevo and Adrien Bartoli. In British Machine Vision Conference (BMVC), Bristol, UK, September 2013.

Constructors and members

static create

The AKAZE constructor

create(descriptor_type: number, descriptor_size: number, descriptor_channels: number, threshold: number, nOctaves: number, nOctaveLayers: number, diffusivity: number, max_points: number): xfeatures2d_AKAZE | null;
9 available overloads
create(): xfeatures2d_AKAZE | null;
create(descriptor_type: number): xfeatures2d_AKAZE | null;
create(descriptor_type: number, descriptor_size: number): xfeatures2d_AKAZE | null;
create(descriptor_type: number, descriptor_size: number, descriptor_channels: number): xfeatures2d_AKAZE | null;
create(descriptor_type: number, descriptor_size: number, descriptor_channels: number, threshold: number): xfeatures2d_AKAZE | null;
create(descriptor_type: number, descriptor_size: number, descriptor_channels: number, threshold: number, nOctaves: number): xfeatures2d_AKAZE | null;
create(descriptor_type: number, descriptor_size: number, descriptor_channels: number, threshold: number, nOctaves: number, nOctaveLayers: number): xfeatures2d_AKAZE | null;
create(descriptor_type: number, descriptor_size: number, descriptor_channels: number, threshold: number, nOctaves: number, nOctaveLayers: number, diffusivity: number): xfeatures2d_AKAZE | null;
create(descriptor_type: number, descriptor_size: number, descriptor_channels: number, threshold: number, nOctaves: number, nOctaveLayers: number, diffusivity: number, max_points: number): xfeatures2d_AKAZE | null;
descriptor_type

Type of the extracted descriptor: DESCRIPTOR_KAZE, DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT.

descriptor_size

Size of the descriptor in bits. 0 -> Full size

descriptor_channels

Number of channels in the descriptor (1, 2, 3)

threshold

Detector response threshold to accept point

nOctaves

Maximum octave evolution of the image

nOctaveLayers

Default number of sublevels per scale level

diffusivity

Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or DIFF_CHARBONNIER

max_points

Maximum amount of returned points. In case if image contains more features, then the features with highest response are returned. Negative value means no limitation.

Returns

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

setDescriptorType

Set the descriptor type used by this xfeatures2d_AKAZE object.

setDescriptorType(dtype: number): void;
dtype

dtype argument (number).

getDescriptorType

Return the descriptor type configured on this xfeatures2d_AKAZE object.

getDescriptorType(): number;
Returns

The number result.

setDescriptorSize

Set the descriptor size used by this xfeatures2d_AKAZE object.

setDescriptorSize(dsize: number): void;
dsize

dsize argument (number).

getDescriptorSize

Return the descriptor size configured on this xfeatures2d_AKAZE object.

getDescriptorSize(): number;
Returns

The number result.

setDescriptorChannels

Set the descriptor channels used by this xfeatures2d_AKAZE object.

setDescriptorChannels(dch: number): void;
dch

dch argument (number).

getDescriptorChannels

Return the descriptor channels configured on this xfeatures2d_AKAZE object.

getDescriptorChannels(): number;
Returns

The number result.

setThreshold

Set the threshold used by this xfeatures2d_AKAZE object.

setThreshold(threshold: number): void;
threshold

threshold argument (number).

getThreshold

Return the threshold configured on this xfeatures2d_AKAZE object.

getThreshold(): number;
Returns

The number result.

setNOctaves

Set the noctaves used by this xfeatures2d_AKAZE object.

setNOctaves(octaves: number): void;
octaves

octaves argument (number).

getNOctaves

Return the noctaves configured on this xfeatures2d_AKAZE object.

getNOctaves(): number;
Returns

The number result.

setNOctaveLayers

Set the noctave layers used by this xfeatures2d_AKAZE object.

setNOctaveLayers(octaveLayers: number): void;
octaveLayers

octave layers argument (number).

getNOctaveLayers

Return the noctave layers configured on this xfeatures2d_AKAZE object.

getNOctaveLayers(): number;
Returns

The number result.

setDiffusivity

Set the diffusivity used by this xfeatures2d_AKAZE object.

setDiffusivity(diff: number): void;
diff

diff argument (number).

getDiffusivity

Return the diffusivity configured on this xfeatures2d_AKAZE object.

getDiffusivity(): number;
Returns

The number result.

getDefaultName

Return the default name configured on this xfeatures2d_AKAZE object.

getDefaultName(): string;
Returns

The string result.

setMaxPoints

Set the max points used by this xfeatures2d_AKAZE object.

setMaxPoints(max_points: number): void;
max_points

max points argument (number).

getMaxPoints

Return the max points configured on this xfeatures2d_AKAZE object.

getMaxPoints(): 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.