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