[arrayfire] 13/79: Added missing Hamming matcher documentation

[Ghislain Vaillant]

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch master
in repository arrayfire.

commit ab3e32d401ee6899c0daf9d52134c7d9c4feeb83
Author: Peter Andreas Entschev <peter at arrayfire.com>
Date:   Thu Jun 4 15:42:54 2015 -0400

    Added missing Hamming matcher documentation
---
 docs/details/vision.dox | 17 +++++++++++++++++
 include/arrayfire.h     |  3 +++
 2 files changed, 20 insertions(+)

diff --git a/docs/details/vision.dox b/docs/details/vision.dox
index 99ee1ab..9d96cac 100644
--- a/docs/details/vision.dox
+++ b/docs/details/vision.dox
@@ -31,6 +31,23 @@ times followed by FAST feature detection on each scale.
 
 =======================================================================
 
+\defgroup cv_func_hamming_matcher hammingMatcher
+\ingroup featmatcher_mat
+
+\brief Hamming Matcher
+
+Calculates Hamming distances between two 2-dimensional arrays containing
+features, one of the arrays containing the training data and the other the
+query data. One of the dimensions of the both arrays must be equal among them,
+identifying the length of each feature. The other dimension indicates the
+total number of features in each of the training and query arrays. Two
+1-dimensional arrays are created as results, one containg the smallest N
+distances of the query array and another containing the indices of these
+distances in the training array. The resulting 1-dimensional arrays have length
+equal to the number of features contained in the query array.
+
+=======================================================================
+
 \defgroup cv_func_match_template matchTemplate
 \ingroup match_mat
 
diff --git a/include/arrayfire.h b/include/arrayfire.h
index 136fae0..92c5cb1 100644
--- a/include/arrayfire.h
+++ b/include/arrayfire.h
@@ -153,6 +153,9 @@
      @defgroup featdescriptor_mat Feature descriptors
      ORB feature descriptor
 
+     @defgroup featmatcher_mat Feature matchers
+     Feature matchers
+
      @defgroup match_mat Template matching
    @}
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/arrayfire.git