OpenCV 2.4.8 components for OpenCVgrabber.
[mmanager-3rdparty.git] / OpenCV2.4.8 / build / include / opencv2 / nonfree / ocl.hpp
1 /*M///////////////////////////////////////////////////////////////////////////////////////
2 //
3 // IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
4 //
5 // By downloading, copying, installing or using the software you agree to this license.
6 // If you do not agree to this license, do not download, install,
7 // copy or use the software.
8 //
9 //
10 // License Agreement
11 // For Open Source Computer Vision Library
12 //
13 // Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
14 // Copyright (C) 2009, Willow Garage Inc., all rights reserved.
15 // Copyright (C) 2013, OpenCV Foundation, all rights reserved.
16 // Third party copyrights are property of their respective owners.
17 //
18 // Redistribution and use in source and binary forms, with or without modification,
19 // are permitted provided that the following conditions are met:
20 //
21 // * Redistribution's of source code must retain the above copyright notice,
22 // this list of conditions and the following disclaimer.
23 //
24 // * Redistribution's in binary form must reproduce the above copyright notice,
25 // this list of conditions and the following disclaimer in the documentation
26 // and/or other materials provided with the distribution.
27 //
28 // * The name of the copyright holders may not be used to endorse or promote products
29 // derived from this software without specific prior written permission.
30 //
31 // This software is provided by the copyright holders and contributors "as is" and
32 // any express or implied warranties, including, but not limited to, the implied
33 // warranties of merchantability and fitness for a particular purpose are disclaimed.
34 // In no event shall the Intel Corporation or contributors be liable for any direct,
35 // indirect, incidental, special, exemplary, or consequential damages
36 // (including, but not limited to, procurement of substitute goods or services;
37 // loss of use, data, or profits; or business interruption) however caused
38 // and on any theory of liability, whether in contract, strict liability,
39 // or tort (including negligence or otherwise) arising in any way out of
40 // the use of this software, even if advised of the possibility of such damage.
41 //
42 //M*/
43
44 #ifndef __OPENCV_NONFREE_OCL_HPP__
45 #define __OPENCV_NONFREE_OCL_HPP__
46
47 #include "opencv2/ocl/ocl.hpp"
48
49 namespace cv
50 {
51     namespace ocl
52     {
53         //! Speeded up robust features, port from GPU module.
54         ////////////////////////////////// SURF //////////////////////////////////////////
55
56         class CV_EXPORTS SURF_OCL
57         {
58         public:
59             enum KeypointLayout
60             {
61                 X_ROW = 0,
62                 Y_ROW,
63                 LAPLACIAN_ROW,
64                 OCTAVE_ROW,
65                 SIZE_ROW,
66                 ANGLE_ROW,
67                 HESSIAN_ROW,
68                 ROWS_COUNT
69             };
70
71             //! the default constructor
72             SURF_OCL();
73             //! the full constructor taking all the necessary parameters
74             explicit SURF_OCL(double _hessianThreshold, int _nOctaves = 4,
75                               int _nOctaveLayers = 2, bool _extended = false, float _keypointsRatio = 0.01f, bool _upright = false);
76
77             //! returns the descriptor size in float's (64 or 128)
78             int descriptorSize() const;
79             //! upload host keypoints to device memory
80             void uploadKeypoints(const vector<cv::KeyPoint> &keypoints, oclMat &keypointsocl);
81             //! download keypoints from device to host memory
82             void downloadKeypoints(const oclMat &keypointsocl, vector<KeyPoint> &keypoints);
83             //! download descriptors from device to host memory
84             void downloadDescriptors(const oclMat &descriptorsocl, vector<float> &descriptors);
85             //! finds the keypoints using fast hessian detector used in SURF
86             //! supports CV_8UC1 images
87             //! keypoints will have nFeature cols and 6 rows
88             //! keypoints.ptr<float>(X_ROW)[i] will contain x coordinate of i'th feature
89             //! keypoints.ptr<float>(Y_ROW)[i] will contain y coordinate of i'th feature
90             //! keypoints.ptr<float>(LAPLACIAN_ROW)[i] will contain laplacian sign of i'th feature
91             //! keypoints.ptr<float>(OCTAVE_ROW)[i] will contain octave of i'th feature
92             //! keypoints.ptr<float>(SIZE_ROW)[i] will contain size of i'th feature
93             //! keypoints.ptr<float>(ANGLE_ROW)[i] will contain orientation of i'th feature
94             //! keypoints.ptr<float>(HESSIAN_ROW)[i] will contain response of i'th feature
95             void operator()(const oclMat &img, const oclMat &mask, oclMat &keypoints);
96             //! finds the keypoints and computes their descriptors.
97             //! Optionally it can compute descriptors for the user-provided keypoints and recompute keypoints direction
98             void operator()(const oclMat &img, const oclMat &mask, oclMat &keypoints, oclMat &descriptors,
99                             bool useProvidedKeypoints = false);
100             void operator()(const oclMat &img, const oclMat &mask, std::vector<KeyPoint> &keypoints);
101             void operator()(const oclMat &img, const oclMat &mask, std::vector<KeyPoint> &keypoints, oclMat &descriptors,
102                             bool useProvidedKeypoints = false);
103             void operator()(const oclMat &img, const oclMat &mask, std::vector<KeyPoint> &keypoints, std::vector<float> &descriptors,
104                             bool useProvidedKeypoints = false);
105
106             void releaseMemory();
107
108             // SURF parameters
109             float hessianThreshold;
110             int nOctaves;
111             int nOctaveLayers;
112             bool extended;
113             bool upright;
114             //! max keypoints = min(keypointsRatio * img.size().area(), 65535)
115             float keypointsRatio;
116             oclMat sum, mask1, maskSum, intBuffer;
117             oclMat det, trace;
118             oclMat maxPosBuffer;
119
120         };
121     }
122 }
123
124 #endif //__OPENCV_NONFREE_OCL_HPP__