add extra to FeatureDetector docs
authorStevenPuttemans <steven.puttemans@kuleuven.be>
Mon, 15 Dec 2014 10:31:18 +0000 (11:31 +0100)
committerStevenPuttemans <steven.puttemans@kuleuven.be>
Mon, 15 Dec 2014 10:31:18 +0000 (11:31 +0100)
modules/features2d/doc/common_interfaces_of_feature_detectors.rst

index 51efca5..9f7b630 100644 (file)
@@ -144,6 +144,11 @@ Also a combined format is supported: feature detector adapter name ( ``"Grid"``
 :ocv:class:`PyramidAdaptedFeatureDetector` ) + feature detector name (see above),
 for example: ``"GridFAST"``, ``"PyramidSTAR"`` .
 
+.. note:: When using the SIFT and SURF detector types be sure to add the following lines to your code
+
+     * Add an extra include: `#include <opencv2/nonfree/nonfree.hpp>`
+     * Add an initialisation function at the start of your code: `initModules_nonfree();`
+
 FastFeatureDetector
 -------------------
 .. ocv:class:: FastFeatureDetector : public FeatureDetector