introduced new RST/Sphinx domain ocv.
This commit is contained in:
Vadim Pisarevsky
@@ -7,7 +7,7 @@ Feature Detection and Description
|
||||
|
||||
gpu::SURF_GPU
|
||||
-------------
|
||||
.. cpp:class:: gpu::SURF_GPU
|
||||
.. ocv:class:: gpu::SURF_GPU
|
||||
|
||||
This class is used for extracting Speeded Up Robust Features (SURF) from an image.
|
||||
::
|
||||
@@ -93,7 +93,7 @@ See Also: :c:type:`SURF`
|
||||
|
||||
gpu::BruteForceMatcher_GPU
|
||||
--------------------------
|
||||
.. cpp:class:: gpu::BruteForceMatcher_GPU
|
||||
.. ocv:class:: gpu::BruteForceMatcher_GPU
|
||||
|
||||
This is a brute-force descriptor matcher. For each descriptor in the first set, this matcher finds the closest descriptor in the second set by trying each one. This descriptor matcher supports masking permissible matches between descriptor sets. ::
|
||||
|
||||
@@ -188,20 +188,20 @@ See Also: :c:type:`DescriptorMatcher`, :c:type:`BruteForceMatcher`
|
||||
|
||||
gpu::BruteForceMatcher_GPU::match
|
||||
-------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::match(const GpuMat& queryDescs, const GpuMat& trainDescs, std::vector<DMatch>& matches, const GpuMat& mask = GpuMat())
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::match(const GpuMat& queryDescs, const GpuMat& trainDescs, std::vector<DMatch>& matches, const GpuMat& mask = GpuMat())
|
||||
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::match(const GpuMat& queryDescs, std::vector<DMatch>& matches, const std::vector<GpuMat>& masks = std::vector<GpuMat>())
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::match(const GpuMat& queryDescs, std::vector<DMatch>& matches, const std::vector<GpuMat>& masks = std::vector<GpuMat>())
|
||||
|
||||
Finds the best match for each descriptor from a query set with train descriptors.
|
||||
|
||||
See Also:
|
||||
:cpp:func:`DescriptorMatcher::match`
|
||||
:ocv:func:`DescriptorMatcher::match`
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::matchSingle
|
||||
|
||||
gpu::BruteForceMatcher_GPU::matchSingle
|
||||
-------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::matchSingle(const GpuMat& queryDescs, const GpuMat& trainDescs, GpuMat& trainIdx, GpuMat& distance, const GpuMat& mask = GpuMat())
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::matchSingle(const GpuMat& queryDescs, const GpuMat& trainDescs, GpuMat& trainIdx, GpuMat& distance, const GpuMat& mask = GpuMat())
|
||||
|
||||
Finds the best match for each query descriptor. Results are stored in the GPU memory.
|
||||
|
||||
@@ -219,13 +219,13 @@ gpu::BruteForceMatcher_GPU::matchSingle
|
||||
|
||||
gpu::BruteForceMatcher_GPU::matchCollection
|
||||
-----------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::matchCollection(const GpuMat& queryDescs, const GpuMat& trainCollection, GpuMat& trainIdx, GpuMat& imgIdx, GpuMat& distance, const GpuMat& maskCollection)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::matchCollection(const GpuMat& queryDescs, const GpuMat& trainCollection, GpuMat& trainIdx, GpuMat& imgIdx, GpuMat& distance, const GpuMat& maskCollection)
|
||||
|
||||
Finds the best match for each query descriptor from train collection. Results are stored in the GPU memory.
|
||||
|
||||
:param queryDescs: Query set of descriptors.
|
||||
|
||||
:param trainCollection: :cpp:class:`gpu::GpuMat` containing train collection. It can be obtained from the collection of train descriptors that was set using the ``add`` method by :cpp:func:`gpu::BruteForceMatcher_GPU::makeGpuCollection`. Or it may contain a user-defined collection. This is a one-row matrix where each element is ``DevMem2D`` pointing out to a matrix of train descriptors.
|
||||
:param trainCollection: :ocv:class:`gpu::GpuMat` containing train collection. It can be obtained from the collection of train descriptors that was set using the ``add`` method by :ocv:func:`gpu::BruteForceMatcher_GPU::makeGpuCollection`. Or it may contain a user-defined collection. This is a one-row matrix where each element is ``DevMem2D`` pointing out to a matrix of train descriptors.
|
||||
|
||||
:param trainIdx: The output single-row ``CV_32SC1`` matrix that contains the best train index for each query. If some query descriptors are masked out in ``maskCollection`` , it contains -1.
|
||||
|
||||
@@ -233,47 +233,47 @@ gpu::BruteForceMatcher_GPU::matchCollection
|
||||
|
||||
:param distance: The output single-row ``CV_32FC1`` matrix that contains the best distance for each query. If some query descriptors are masked out in ``maskCollection`` , it contains ``FLT_MAX``.
|
||||
|
||||
:param maskCollection: ``GpuMat`` containing a set of masks. It can be obtained from ``std::vector<GpuMat>`` by :cpp:func:`gpu::BruteForceMatcher_GPU::makeGpuCollection` or it may contain a user-defined mask set. This is an empty matrix or one-row matrix where each element is a ``PtrStep`` that points to one mask.
|
||||
:param maskCollection: ``GpuMat`` containing a set of masks. It can be obtained from ``std::vector<GpuMat>`` by :ocv:func:`gpu::BruteForceMatcher_GPU::makeGpuCollection` or it may contain a user-defined mask set. This is an empty matrix or one-row matrix where each element is a ``PtrStep`` that points to one mask.
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::makeGpuCollection
|
||||
|
||||
gpu::BruteForceMatcher_GPU::makeGpuCollection
|
||||
-------------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::makeGpuCollection(GpuMat& trainCollection, GpuMat& maskCollection, const vector<GpuMat>&masks = std::vector<GpuMat>())
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::makeGpuCollection(GpuMat& trainCollection, GpuMat& maskCollection, const vector<GpuMat>&masks = std::vector<GpuMat>())
|
||||
|
||||
Performs a GPU collection of train descriptors and masks in a suitable format for the
|
||||
:cpp:func:`gpu::BruteForceMatcher_GPU::matchCollection` function.
|
||||
:ocv:func:`gpu::BruteForceMatcher_GPU::matchCollection` function.
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::matchDownload
|
||||
|
||||
gpu::BruteForceMatcher_GPU::matchDownload
|
||||
---------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::matchDownload(const GpuMat& trainIdx, const GpuMat& distance, std::vector<DMatch>&matches)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::matchDownload(const GpuMat& trainIdx, const GpuMat& distance, std::vector<DMatch>&matches)
|
||||
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::matchDownload(const GpuMat& trainIdx, GpuMat& imgIdx, const GpuMat& distance, std::vector<DMatch>&matches)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::matchDownload(const GpuMat& trainIdx, GpuMat& imgIdx, const GpuMat& distance, std::vector<DMatch>&matches)
|
||||
|
||||
Downloads ``trainIdx``, ``imgIdx``, and ``distance`` matrices obtained via
|
||||
:cpp:func:`gpu::BruteForceMatcher_GPU::matchSingle` or
|
||||
:cpp:func:`gpu::BruteForceMatcher_GPU::matchCollection` to CPU vector with :c:type:`DMatch`.
|
||||
:ocv:func:`gpu::BruteForceMatcher_GPU::matchSingle` or
|
||||
:ocv:func:`gpu::BruteForceMatcher_GPU::matchCollection` to CPU vector with :c:type:`DMatch`.
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::knnMatch
|
||||
|
||||
gpu::BruteForceMatcher_GPU::knnMatch
|
||||
----------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::knnMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, std::vector< std::vector<DMatch> >&matches, int k, const GpuMat& mask = GpuMat(), bool compactResult = false)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::knnMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, std::vector< std::vector<DMatch> >&matches, int k, const GpuMat& mask = GpuMat(), bool compactResult = false)
|
||||
|
||||
Finds the k best matches for each descriptor from a query set with train descriptors. The function returns detected k (or less if not possible) matches in the increasing order by distance.
|
||||
|
||||
.. cpp:function:: void knnMatch(const GpuMat& queryDescs, std::vector< std::vector<DMatch> >&matches, int k, const std::vector<GpuMat>&masks = std::vector<GpuMat>(), bool compactResult = false )
|
||||
.. ocv:function:: void knnMatch(const GpuMat& queryDescs, std::vector< std::vector<DMatch> >&matches, int k, const std::vector<GpuMat>&masks = std::vector<GpuMat>(), bool compactResult = false )
|
||||
|
||||
See Also:
|
||||
:cpp:func:`DescriptorMatcher::knnMatch`
|
||||
:ocv:func:`DescriptorMatcher::knnMatch`
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::knnMatch
|
||||
|
||||
gpu::BruteForceMatcher_GPU::knnMatch
|
||||
----------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::knnMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, GpuMat& trainIdx, GpuMat& distance, GpuMat& allDist, int k, const GpuMat& mask = GpuMat())
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::knnMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, GpuMat& trainIdx, GpuMat& distance, GpuMat& allDist, int k, const GpuMat& mask = GpuMat())
|
||||
|
||||
Finds the k best matches for each descriptor from a query set with train descriptors. The function returns detected k (or less if not possible) matches in the increasing order by distance. Results will be stored in the GPU memory.
|
||||
|
||||
@@ -291,30 +291,30 @@ gpu::BruteForceMatcher_GPU::knnMatch
|
||||
|
||||
gpu::BruteForceMatcher_GPU::knnMatchDownload
|
||||
------------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::knnMatchDownload(const GpuMat& trainIdx, const GpuMat& distance, std::vector< std::vector<DMatch> >&matches, bool compactResult = false)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::knnMatchDownload(const GpuMat& trainIdx, const GpuMat& distance, std::vector< std::vector<DMatch> >&matches, bool compactResult = false)
|
||||
|
||||
Downloads ``trainIdx`` and ``distance`` matrices obtained via :cpp:func:`gpu::BruteForceMatcher_GPU::knnMatch` to CPU vector with :c:type:`DMatch`. If ``compactResult`` is true, the ``matches`` vector does not contain matches for fully masked-out query descriptors.
|
||||
Downloads ``trainIdx`` and ``distance`` matrices obtained via :ocv:func:`gpu::BruteForceMatcher_GPU::knnMatch` to CPU vector with :c:type:`DMatch`. If ``compactResult`` is true, the ``matches`` vector does not contain matches for fully masked-out query descriptors.
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::radiusMatch
|
||||
|
||||
gpu::BruteForceMatcher_GPU::radiusMatch
|
||||
-------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::radiusMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, std::vector< std::vector<DMatch> >&matches, float maxDistance, const GpuMat& mask = GpuMat(), bool compactResult = false)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::radiusMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, std::vector< std::vector<DMatch> >&matches, float maxDistance, const GpuMat& mask = GpuMat(), bool compactResult = false)
|
||||
|
||||
For each query descriptor, finds the best matches with a distance less than a given threshold. The function returns detected matches in the increasing order by distance.
|
||||
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::radiusMatch(const GpuMat& queryDescs, std::vector< std::vector<DMatch> >&matches, float maxDistance, const std::vector<GpuMat>&masks = std::vector<GpuMat>(), bool compactResult = false)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::radiusMatch(const GpuMat& queryDescs, std::vector< std::vector<DMatch> >&matches, float maxDistance, const std::vector<GpuMat>&masks = std::vector<GpuMat>(), bool compactResult = false)
|
||||
|
||||
This function works only on devices with the compute capability :math:`>=` 1.1.
|
||||
|
||||
See Also:
|
||||
:cpp:func:`DescriptorMatcher::radiusMatch`
|
||||
:ocv:func:`DescriptorMatcher::radiusMatch`
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::radiusMatch
|
||||
|
||||
gpu::BruteForceMatcher_GPU::radiusMatch
|
||||
-------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::radiusMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, GpuMat& trainIdx, GpuMat& nMatches, GpuMat& distance, float maxDistance, const GpuMat& mask = GpuMat())
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::radiusMatch(const GpuMat& queryDescs, const GpuMat& trainDescs, GpuMat& trainIdx, GpuMat& nMatches, GpuMat& distance, float maxDistance, const GpuMat& mask = GpuMat())
|
||||
|
||||
For each query descriptor, finds the best matches with a distance less than a given threshold (``maxDistance``). The results are stored in the GPU memory.
|
||||
|
||||
@@ -332,13 +332,13 @@ gpu::BruteForceMatcher_GPU::radiusMatch
|
||||
|
||||
:param mask: Mask specifying permissible matches between the input query and train matrices of descriptors.
|
||||
|
||||
In contrast to :cpp:func:`gpu::BruteForceMatcher_GPU::knnMatch`, here the results are not sorted by the distance. This function works only on devices with the compute capability >= 1.1.
|
||||
In contrast to :ocv:func:`gpu::BruteForceMatcher_GPU::knnMatch`, here the results are not sorted by the distance. This function works only on devices with the compute capability >= 1.1.
|
||||
|
||||
.. index:: gpu::BruteForceMatcher_GPU::radiusMatchDownload
|
||||
|
||||
gpu::BruteForceMatcher_GPU::radiusMatchDownload
|
||||
---------------------------------------------------
|
||||
.. cpp:function:: void gpu::BruteForceMatcher_GPU::radiusMatchDownload(const GpuMat& trainIdx, const GpuMat& nMatches, const GpuMat& distance, std::vector< std::vector<DMatch> >&matches, bool compactResult = false)
|
||||
.. ocv:function:: void gpu::BruteForceMatcher_GPU::radiusMatchDownload(const GpuMat& trainIdx, const GpuMat& nMatches, const GpuMat& distance, std::vector< std::vector<DMatch> >&matches, bool compactResult = false)
|
||||
|
||||
Downloads ``trainIdx``, ``nMatches`` and ``distance`` matrices obtained via :cpp:func:`gpu::BruteForceMatcher_GPU::radiusMatch` to CPU vector with :c:type:`DMatch`. If ``compactResult`` is true, the ``matches`` vector does not contain matches for fully masked-out query descriptors.
|
||||
Downloads ``trainIdx``, ``nMatches`` and ``distance`` matrices obtained via :ocv:func:`gpu::BruteForceMatcher_GPU::radiusMatch` to CPU vector with :c:type:`DMatch`. If ``compactResult`` is true, the ``matches`` vector does not contain matches for fully masked-out query descriptors.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user