update gpu docs (SURF and BruteForceMatcher)
authorVladislav Vinogradov <no@email>
Mon, 16 May 2011 08:54:06 +0000 (08:54 +0000)
committerVladislav Vinogradov <no@email>
Mon, 16 May 2011 08:54:06 +0000 (08:54 +0000)
modules/gpu/doc/feature_detection_and_description.rst

index fee5d25..c043987 100644 (file)
@@ -60,6 +60,8 @@ This class is used for extracting Speeded Up Robust Features (SURF) from an imag
         //! max keypoints = keypointsRatio * img.size().area()
         float keypointsRatio;
 
+        bool upright;
+
         GpuMat sum, mask1, maskSum, intBuffer;
 
         GpuMat det, trace;
@@ -77,6 +79,10 @@ The class ``SURF_GPU`` can store results in the GPU and CPU memory. It provides
 
 The class ``SURF_GPU`` uses some buffers and provides access to it. All buffers can be safely released between function calls.
 
+**Note:**
+
+By default for user provided keypoints the class ``SURF_GPU`` recalculates keypoint's orientation and returns reodered/filtered keypoints array and coresponding decriptors array.
+
 See Also: :c:type:`SURF`
 
 .. index:: gpu::BruteForceMatcher_GPU
@@ -170,7 +176,7 @@ This is a brute-force descriptor matcher. For each descriptor in the first set,
     };
 
 
-The class ``BruteForceMatcher_GPU`` has an interface similar to the class :c:type:`DescriptorMatcher`. It has two groups of ``match`` methods: for matching descriptors of one image with another image or with an image set. Also, all functions have an alternative: save results to the GPU memory or to the CPU memory. ``Distance`` template parameter is kept for CPU/GPU interfaces similarity. ``BruteForceMatcher_GPU`` supports only the ``L1<float>`` and ``L2<float>`` distance types.
+The class ``BruteForceMatcher_GPU`` has an interface similar to the class :c:type:`DescriptorMatcher`. It has two groups of ``match`` methods: for matching descriptors of one image with another image or with an image set. Also, all functions have an alternative: save results to the GPU memory or to the CPU memory. ``Distance`` template parameter is kept for CPU/GPU interfaces similarity. ``BruteForceMatcher_GPU`` supports only the ``L1<float>``, ``L2<float>`` and ``Hamming`` distance types.
 
 See Also: :c:type:`DescriptorMatcher`, :c:type:`BruteForceMatcher`