class cv::BRISK

Overview

Class implementing the BRISK keypoint detector and descriptor extractor, described in [46]. More…

#include <features2d.hpp>

class BRISK: public cv::Feature2D
{
public:
    // methods

    static
    Ptr<BRISK>
    create(
        int thresh = 30,
        int octaves = 3,
        float patternScale = 1.0f
        );

    static
    Ptr<BRISK>
    create(
        const std::vector<float>& radiusList,
        const std::vector<int>& numberList,
        float dMax = 5.85f,
        float dMin = 8.2f,
        const std::vector<int>& indexChange = std::vector<int>()
        );
};

Inherited Members

public:
    // methods

    virtual
    void
    clear();

    virtual
    bool
    empty() const;

    virtual
    String
    getDefaultName() const;

    virtual
    void
    read(const FileNode& fn);

    virtual
    void
    save(const String& filename) const;

    virtual
    void
    write(FileStorage& fs) const;

    template <typename _Tp>
    static
    Ptr<_Tp>
    load(
        const String& filename,
        const String& objname = String()
        );

    template <typename _Tp>
    static
    Ptr<_Tp>
    loadFromString(
        const String& strModel,
        const String& objname = String()
        );

    template <typename _Tp>
    static
    Ptr<_Tp>
    read(const FileNode& fn);

    virtual
    void
    compute(
        InputArray image,
        std::vector<KeyPoint>& keypoints,
        OutputArray descriptors
        );

    virtual
    void
    compute(
        InputArrayOfArrays images,
        std::vector<std::vector<KeyPoint>>& keypoints,
        OutputArrayOfArrays descriptors
        );

    virtual
    int
    defaultNorm() const;

    virtual
    int
    descriptorSize() const;

    virtual
    int
    descriptorType() const;

    virtual
    void
    detect(
        InputArray image,
        std::vector<KeyPoint>& keypoints,
        InputArray mask = noArray()
        );

    virtual
    void
    detect(
        InputArrayOfArrays images,
        std::vector<std::vector<KeyPoint>>& keypoints,
        InputArrayOfArrays masks = noArray()
        );

    virtual
    void
    detectAndCompute(
        InputArray image,
        InputArray mask,
        std::vector<KeyPoint>& keypoints,
        OutputArray descriptors,
        bool useProvidedKeypoints = false
        );

    virtual
    bool
    empty() const;

    void
    read(const String& fileName);

    virtual
    void
    read(const FileNode& fn);

    void
    write(const String& fileName) const;

    virtual
    void
    write(FileStorage& fs) const;

protected:
    // methods

    void
    writeFormat(FileStorage& fs) const;

Detailed Documentation

Class implementing the BRISK keypoint detector and descriptor extractor, described in [46].

Methods

static
Ptr<BRISK>
create(
    int thresh = 30,
    int octaves = 3,
    float patternScale = 1.0f
    )

The BRISK constructor.

Parameters:

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.

static
Ptr<BRISK>
create(
    const std::vector<float>& radiusList,
    const std::vector<int>& numberList,
    float dMax = 5.85f,
    float dMin = 8.2f,
    const std::vector<int>& indexChange = std::vector<int>()
    )

The BRISK constructor for a custom pattern.

Parameters:

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.