generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added documentation

Browse Source
This commit is contained in:
Matthias Bady 2013-12-20 10:53:21 +01:00
parent 74dfa668e2
commit 6e4715309b
2 changed files with 58 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
modules/ocl/doc/feature_detection_and_description.rst
View File

@ -450,7 +450,59 @@ Gets final array of keypoints.
The function performs non-max suppression if needed and returns the final amount of keypoints. The function performs non-max suppression if needed and returns the final amount of keypoints.
ocl::BRIEF_OCL
------------------
.. ocv:class:: ocl::BRIEF_OCL
Class for computing BRIEF descriptors described in a paper of Calonder M., Lepetit V.,
Strecha C., Fua P. *BRIEF: Binary Robust Independent Elementary Features* ,
11th European Conference on Computer Vision (ECCV), Heraklion, Crete. LNCS Springer, September 2010. ::
class CV_EXPORTS BRIEF_OCL
{
public:
static const int PATCH_SIZE = 48;
static const int KERNEL_SIZE = 9;
explicit BRIEF_OCL(int _bytes = 32);
//!computes the brief descriptor for a set of given keypoints
//! supports only CV_8UC1 images
void compute(const oclMat& image, const oclMat& keypoints, oclMat& mask, oclMat& descriptors) const;
static int getBorderSize();
protected:
...
};
ocl::BRIEF_OCL::BRIEF_OCL
--------------------------
Constructor.
.. ocv:function:: ocl::BRIEF_OCL::BRIEF_OCL(int bytes = 32)
:param bytes: The length of the descriptor in bytes. Supported values are 16, 32 or 64 bytes.
ocl::BRIEF_OCL::compute
------------------------
Computes BRIEF descriptors.
.. ocv:function:: void ocl::BRIEF_OCL::compute(const oclMat& image, const oclMat& keypoints, oclMat& mask, oclMat& descriptors) const
:param image: Image The input 8-bit grayscale image.
:param keypoints: The keypoints.
:param mask: In and output mask. If mask has same cols as keypoints, descriptors are computed for keypoints with non-zero mask element.
On return it indicates for what keypoints a descriptor was computed or not(if a keypoint is near the image border).
:param descriptors: The computed descriptors. It has size keypoints.cols x bytes.
ocl::BRIEF_OCL::getBorderSize
-----------------------------
Returns the size of the image border where descriptors cannot be computed
.. ocv:function:: static int ocl::BRIEF_OCL::getBorderSize() const
ocl::HOGDescriptor ocl::HOGDescriptor
---------------------- ----------------------

14
modules/ocl/include/opencv2/ocl.hpp
View File

@ -1546,22 +1546,20 @@ namespace cv
int calcKeypointsOCL(const oclMat& img, const oclMat& mask, int maxKeypoints); int calcKeypointsOCL(const oclMat& img, const oclMat& mask, int maxKeypoints);
int nonmaxSupressionOCL(oclMat& keypoints); int nonmaxSupressionOCL(oclMat& keypoints);
}; };
////////////////////////////////// BRIEF Feature Descriptor ////////////////////////////////// ////////////////////////////////// BRIEF Feature Descriptor //////////////////////////////////
class CV_EXPORTS BRIEF_OCL class CV_EXPORTS BRIEF_OCL
{ {
public: public:
static const int PATCH_SIZE = 48; static const int PATCH_SIZE = 48;
static const int KERNEL_SIZE = 9; static const int KERNEL_SIZE = 9;
explicit BRIEF_OCL( int _bytes = 32 ); explicit BRIEF_OCL(int _bytes = 32);
/* //!computes the brief descriptor for a set of given keypoints
* Compute the descriptors for a set of keypoints in an image. //! supports only CV_8UC1 images
* image The image. void compute(const oclMat& image, const oclMat& keypoints, oclMat& mask, oclMat& descriptors) const;
* keypoints The input keypoints.
* descriptors Copmputed descriptors. Row i is the descriptor for keypoint i.
*/
void compute( const oclMat& image, const oclMat& keypoints, oclMat& mask, oclMat& descriptors ) const;
static int getBorderSize(); static int getBorderSize();
protected: protected: