Initial commit of the KAZE & AKAZE docs

pull/2673/head
Ievgen Khvedchenia 11 years ago
parent b42c268164
commit c4e49463a9
  1. 73
      modules/features2d/doc/feature_detection_and_description.rst
  2. 4
      modules/features2d/src/akaze.cpp
  3. 4
      modules/features2d/src/kaze.cpp

@ -249,3 +249,76 @@ We notice that for keypoint matching applications, image content has little effe
:param keypoints: Set of detected keypoints
:param corrThresh: Correlation threshold.
:param verbose: Prints pair selection informations.
KAZE
-----
.. ocv:class:: KAZE : public Feature2D
Class implementing the KAZE keypoint detector and descriptor extractor, described in [ABD12]_. ::
class CV_EXPORTS_W KAZE : public Feature2D
{
public:
/// KAZE Descriptor Type
enum DESCRIPTOR_TYPE {
DESCRIPTOR_MSURF = 1,
DESCRIPTOR_GSURF = 2
};
CV_WRAP KAZE();
explicit KAZE(DESCRIPTOR_TYPE descriptor_type, bool _extended, bool _upright);
....
};
The KAZE constructor
.. ocv:function:: KAZE::KAZE()
.. ocv:function:: KAZE::KAZE(DESCRIPTOR_TYPE descriptor_type, bool extended, bool upright)
:param descriptor_type: Type of the extracted descriptor.
:param extended: Set to enable extraction of extended (128-byte) descriptor.
:param upright: Set to enable use of upright descriptors (non rotation-invariant).
.. [ABD12] KAZE Features. Pablo F. Alcantarilla, Adrien Bartoli and Andrew J. Davison. In European Conference on Computer Vision (ECCV), Fiorenze, Italy, October 2012.
AKAZE
-----
.. ocv:class:: AKAZE : public Feature2D
Class implementing the AKAZE keypoint detector and descriptor extractor, described in [ANB13]_. ::
class CV_EXPORTS_W AKAZE : public Feature2D
{
public:
/// AKAZE Descriptor Type
enum DESCRIPTOR_TYPE {
DESCRIPTOR_KAZE_UPRIGHT = 2, ///< Upright descriptors, not invariant to rotation
DESCRIPTOR_KAZE = 3,
DESCRIPTOR_MLDB_UPRIGHT = 4, ///< Upright descriptors, not invariant to rotation
DESCRIPTOR_MLDB = 5
};
CV_WRAP AKAZE();
explicit AKAZE(DESCRIPTOR_TYPE descriptor_type, int _descriptor_size = 0, int _descriptor_channels = 3);
...
};
The AKAZE constructor
.. ocv:function:: AKAZE::AKAZE()
.. ocv:function:: AKAZE::AKAZE(DESCRIPTOR_TYPE descriptor_type, int descriptor_size = 0, int descriptor_channels = 3)
:param descriptor_type: Type of the extracted descriptor.
:param descriptor_size: Size of the descriptor in bits. 0 -> Full size
:param descriptor_channels: Number of channels in the descriptor (1, 2, 3).
.. [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.

@ -60,8 +60,8 @@ namespace cv
{
}
AKAZE::AKAZE(DESCRIPTOR_TYPE _descriptor, int _descriptor_size, int _descriptor_channels)
: descriptor(_descriptor)
AKAZE::AKAZE(DESCRIPTOR_TYPE descriptor_type, int _descriptor_size, int _descriptor_channels)
: descriptor(descriptor_type)
, descriptor_channels(_descriptor_channels)
, descriptor_size(_descriptor_size)
{

@ -59,8 +59,8 @@ namespace cv
{
}
KAZE::KAZE(DESCRIPTOR_TYPE type, bool _extended, bool _upright)
: descriptor(type)
KAZE::KAZE(DESCRIPTOR_TYPE descriptor_type, bool _extended, bool _upright)
: descriptor(descriptor_type)
, extended(_extended)
, upright(_upright)
{

Loading…
Cancel
Save