Skip to content

xfeatures2d_FREAK

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

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

ARGUMENTSConstructor or factory
CLASSxfeatures2d_FREAK
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 FREAK (Fast Retina Keypoint) keypoint descriptor, described in [AOV12] .

The algorithm propose a novel keypoint descriptor inspired by the human visual system and more precisely the retina, coined Fast Retina Key- point (FREAK). A cascade of binary strings is computed by efficiently comparing image intensities over a retinal sampling pattern. FREAKs are in general faster to compute with lower memory load and also more robust than SIFT, SURF or BRISK. They are competitive alternatives to existing keypoints in particular for embedded applications.

Note: - An example on how to use the FREAK descriptor can be found at opencv_source_code/samples/cpp/freak_demo.cpp

Constructors and members

static create

Create an owned xfeatures2d_FREAK instance with the supplied configuration.

Class implementing the FREAK (Fast Retina Keypoint) keypoint descriptor, described in [AOV12] .

create(orientationNormalized: boolean, scaleNormalized: boolean, patternScale: number, nOctaves: number, selectedPairs: IntVector): xfeatures2d_FREAK | null;
6 available overloads
create(): xfeatures2d_FREAK | null;
create(orientationNormalized: boolean): xfeatures2d_FREAK | null;
create(orientationNormalized: boolean, scaleNormalized: boolean): xfeatures2d_FREAK | null;
create(orientationNormalized: boolean, scaleNormalized: boolean, patternScale: number): xfeatures2d_FREAK | null;
create(orientationNormalized: boolean, scaleNormalized: boolean, patternScale: number, nOctaves: number): xfeatures2d_FREAK | null;
create(orientationNormalized: boolean, scaleNormalized: boolean, patternScale: number, nOctaves: number, selectedPairs: IntVector): xfeatures2d_FREAK | null;
orientationNormalized

Enable orientation normalization.

scaleNormalized

Enable scale normalization.

patternScale

Scaling of the description pattern.

nOctaves

Number of octaves covered by the detected keypoints.

selectedPairs

(Optional) user defined selected pairs indexes,

Returns

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

setOrientationNormalized

Set the orientation normalized used by this xfeatures2d_FREAK object.

setOrientationNormalized(orientationNormalized: boolean): void;
orientationNormalized

orientation normalized argument (boolean).

getOrientationNormalized

Return the orientation normalized configured on this xfeatures2d_FREAK object.

getOrientationNormalized(): boolean;
Returns

The boolean result.

setScaleNormalized

Set the scale normalized used by this xfeatures2d_FREAK object.

setScaleNormalized(scaleNormalized: boolean): void;
scaleNormalized

scale normalized argument (boolean).

getScaleNormalized

Return the scale normalized configured on this xfeatures2d_FREAK object.

getScaleNormalized(): boolean;
Returns

The boolean result.

setPatternScale

Set the pattern scale used by this xfeatures2d_FREAK object.

setPatternScale(patternScale: number): void;
patternScale

pattern scale argument (number).

getPatternScale

Return the pattern scale configured on this xfeatures2d_FREAK object.

getPatternScale(): number;
Returns

The number result.

setNOctaves

Set the noctaves used by this xfeatures2d_FREAK object.

setNOctaves(nOctaves: number): void;
nOctaves

n octaves argument (number).

getNOctaves

Return the noctaves configured on this xfeatures2d_FREAK object.

getNOctaves(): number;
Returns

The number result.

getDefaultName

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