Skip to content

xfeatures2d_BRISK

xfeatures2dclassOpenCV 5.0.0
import { xfeatures2d_BRISK } 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 BRISK keypoint detector and descriptor extractor, described in [LCS11] .

Constructors and members

static create

The BRISK constructor

create(thresh: number, octaves: number, patternScale: number): xfeatures2d_BRISK | null;
4 available overloads
create(): xfeatures2d_BRISK | null;
create(thresh: number): xfeatures2d_BRISK | null;
create(thresh: number, octaves: number): xfeatures2d_BRISK | null;
create(thresh: number, octaves: number, patternScale: number): xfeatures2d_BRISK | null;
thresh

AGAST detection threshold score.

octaves

detection octaves. Use 0 to do single scale.

patternScale

apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

Returns

The xfeatures2d_BRISK | null result.

static create1

The BRISK constructor for a custom pattern

create1(radiusList: FloatVector, numberList: IntVector, dMax: number, dMin: number, indexChange: IntVector): xfeatures2d_BRISK | null;
4 available overloads
create1(radiusList: FloatVector, numberList: IntVector): xfeatures2d_BRISK | null;
create1(radiusList: FloatVector, numberList: IntVector, dMax: number): xfeatures2d_BRISK | null;
create1(radiusList: FloatVector, numberList: IntVector, dMax: number, dMin: number): xfeatures2d_BRISK | null;
create1(radiusList: FloatVector, numberList: IntVector, dMax: number, dMin: number, indexChange: IntVector): xfeatures2d_BRISK | null;
radiusList

defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).

numberList

defines the number of sampling points on the sampling circle. Must be the same size as radiusList..

dMax

threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).

dMin

threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).

indexChange

index remapping of the bits.

Returns

The xfeatures2d_BRISK | null result.

static create2

The BRISK constructor for a custom pattern, detection threshold and octaves

create2(thresh: number, octaves: number, radiusList: FloatVector, numberList: IntVector, dMax: number, dMin: number, indexChange: IntVector): xfeatures2d_BRISK | null;
4 available overloads
create2(thresh: number, octaves: number, radiusList: FloatVector, numberList: IntVector): xfeatures2d_BRISK | null;
create2(thresh: number, octaves: number, radiusList: FloatVector, numberList: IntVector, dMax: number): xfeatures2d_BRISK | null;
create2(thresh: number, octaves: number, radiusList: FloatVector, numberList: IntVector, dMax: number, dMin: number): xfeatures2d_BRISK | null;
create2(thresh: number, octaves: number, radiusList: FloatVector, numberList: IntVector, dMax: number, dMin: number, indexChange: IntVector): xfeatures2d_BRISK | null;
thresh

AGAST detection threshold score.

octaves

detection octaves. Use 0 to do single scale.

radiusList

defines the radii (in pixels) where the samples around a keypoint are taken (for keypoint scale 1).

numberList

defines the number of sampling points on the sampling circle. Must be the same size as radiusList..

dMax

threshold for the short pairings used for descriptor formation (in pixels for keypoint scale 1).

dMin

threshold for the long pairings used for orientation determination (in pixels for keypoint scale 1).

indexChange

index remapping of the bits.

Returns

The xfeatures2d_BRISK | 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_BRISK object.

getDefaultName(): string;
Returns

The string result.

setThreshold

Set detection threshold.

setThreshold(threshold: number): void;
threshold

AGAST detection threshold score.

getThreshold

Read the threshold.

Set detection threshold.

getThreshold(): number;
Returns

The number result.

setOctaves

Set detection octaves.

setOctaves(octaves: number): void;
octaves

detection octaves. Use 0 to do single scale.

getOctaves

Read the octaves.

Set detection octaves.

getOctaves(): number;
Returns

The number result.

setPatternScale

Set detection patternScale.

setPatternScale(patternScale: number): void;
patternScale

apply this scale to the pattern used for sampling the neighbourhood of a keypoint.

getPatternScale

Read the pattern scale.

Set detection patternScale.

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