flann.hpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597
  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. #ifndef OPENCV_FLANN_HPP
  43. #define OPENCV_FLANN_HPP
  44. #include "opencv2/core.hpp"
  45. #include "opencv2/flann/miniflann.hpp"
  46. #include "opencv2/flann/flann_base.hpp"
  47. /**
  48. @defgroup flann Clustering and Search in Multi-Dimensional Spaces
  49. This section documents OpenCV's interface to the FLANN library. FLANN (Fast Library for Approximate
  50. Nearest Neighbors) is a library that contains a collection of algorithms optimized for fast nearest
  51. neighbor search in large datasets and for high dimensional features. More information about FLANN
  52. can be found in @cite Muja2009 .
  53. */
  54. namespace cvflann
  55. {
  56. CV_EXPORTS flann_distance_t flann_distance_type();
  57. CV_DEPRECATED CV_EXPORTS void set_distance_type(flann_distance_t distance_type, int order);
  58. }
  59. namespace cv
  60. {
  61. namespace flann
  62. {
  63. //! @addtogroup flann
  64. //! @{
  65. template <typename T> struct CvType {};
  66. template <> struct CvType<unsigned char> { static int type() { return CV_8U; } };
  67. template <> struct CvType<char> { static int type() { return CV_8S; } };
  68. template <> struct CvType<unsigned short> { static int type() { return CV_16U; } };
  69. template <> struct CvType<short> { static int type() { return CV_16S; } };
  70. template <> struct CvType<int> { static int type() { return CV_32S; } };
  71. template <> struct CvType<float> { static int type() { return CV_32F; } };
  72. template <> struct CvType<double> { static int type() { return CV_64F; } };
  73. // bring the flann parameters into this namespace
  74. using ::cvflann::get_param;
  75. using ::cvflann::print_params;
  76. // bring the flann distances into this namespace
  77. using ::cvflann::L2_Simple;
  78. using ::cvflann::L2;
  79. using ::cvflann::L1;
  80. using ::cvflann::MinkowskiDistance;
  81. using ::cvflann::MaxDistance;
  82. using ::cvflann::HammingLUT;
  83. using ::cvflann::Hamming;
  84. using ::cvflann::Hamming2;
  85. using ::cvflann::HistIntersectionDistance;
  86. using ::cvflann::HellingerDistance;
  87. using ::cvflann::ChiSquareDistance;
  88. using ::cvflann::KL_Divergence;
  89. /** @brief The FLANN nearest neighbor index class. This class is templated with the type of elements for which
  90. the index is built.
  91. `Distance` functor specifies the metric to be used to calculate the distance between two points.
  92. There are several `Distance` functors that are readily available:
  93. cv::cvflann::L2_Simple - Squared Euclidean distance functor.
  94. This is the simpler, unrolled version. This is preferable for very low dimensionality data (eg 3D points)
  95. cv::flann::L2 - Squared Euclidean distance functor, optimized version.
  96. cv::flann::L1 - Manhattan distance functor, optimized version.
  97. cv::flann::MinkowskiDistance - The Minkowsky distance functor.
  98. This is highly optimised with loop unrolling.
  99. The computation of squared root at the end is omitted for efficiency.
  100. cv::flann::MaxDistance - The max distance functor. It computes the
  101. maximum distance between two vectors. This distance is not a valid kdtree distance, it's not
  102. dimensionwise additive.
  103. cv::flann::HammingLUT - %Hamming distance functor. It counts the bit
  104. differences between two strings using a lookup table implementation.
  105. cv::flann::Hamming - %Hamming distance functor. Population count is
  106. performed using library calls, if available. Lookup table implementation is used as a fallback.
  107. cv::flann::Hamming2 - %Hamming distance functor. Population count is
  108. implemented in 12 arithmetic operations (one of which is multiplication).
  109. cv::flann::HistIntersectionDistance - The histogram
  110. intersection distance functor.
  111. cv::flann::HellingerDistance - The Hellinger distance functor.
  112. cv::flann::ChiSquareDistance - The chi-square distance functor.
  113. cv::flann::KL_Divergence - The Kullback-Leibler divergence functor.
  114. Although the provided implementations cover a vast range of cases, it is also possible to use
  115. a custom implementation. The distance functor is a class whose `operator()` computes the distance
  116. between two features. If the distance is also a kd-tree compatible distance, it should also provide an
  117. `accum_dist()` method that computes the distance between individual feature dimensions.
  118. In addition to `operator()` and `accum_dist()`, a distance functor should also define the
  119. `ElementType` and the `ResultType` as the types of the elements it operates on and the type of the
  120. result it computes. If a distance functor can be used as a kd-tree distance (meaning that the full
  121. distance between a pair of features can be accumulated from the partial distances between the
  122. individual dimensions) a typedef `is_kdtree_distance` should be present inside the distance functor.
  123. If the distance is not a kd-tree distance, but it's a distance in a vector space (the individual
  124. dimensions of the elements it operates on can be accessed independently) a typedef
  125. `is_vector_space_distance` should be defined inside the functor. If neither typedef is defined, the
  126. distance is assumed to be a metric distance and will only be used with indexes operating on
  127. generic metric distances.
  128. */
  129. template <typename Distance>
  130. class GenericIndex
  131. {
  132. public:
  133. typedef typename Distance::ElementType ElementType;
  134. typedef typename Distance::ResultType DistanceType;
  135. /** @brief Constructs a nearest neighbor search index for a given dataset.
  136. @param features Matrix of containing the features(points) to index. The size of the matrix is
  137. num_features x feature_dimensionality and the data type of the elements in the matrix must
  138. coincide with the type of the index.
  139. @param params Structure containing the index parameters. The type of index that will be
  140. constructed depends on the type of this parameter. See the description.
  141. @param distance
  142. The method constructs a fast search structure from a set of features using the specified algorithm
  143. with specified parameters, as defined by params. params is a reference to one of the following class
  144. IndexParams descendants:
  145. - **LinearIndexParams** When passing an object of this type, the index will perform a linear,
  146. brute-force search. :
  147. @code
  148. struct LinearIndexParams : public IndexParams
  149. {
  150. };
  151. @endcode
  152. - **KDTreeIndexParams** When passing an object of this type the index constructed will consist of
  153. a set of randomized kd-trees which will be searched in parallel. :
  154. @code
  155. struct KDTreeIndexParams : public IndexParams
  156. {
  157. KDTreeIndexParams( int trees = 4 );
  158. };
  159. @endcode
  160. - **KMeansIndexParams** When passing an object of this type the index constructed will be a
  161. hierarchical k-means tree. :
  162. @code
  163. struct KMeansIndexParams : public IndexParams
  164. {
  165. KMeansIndexParams(
  166. int branching = 32,
  167. int iterations = 11,
  168. flann_centers_init_t centers_init = CENTERS_RANDOM,
  169. float cb_index = 0.2 );
  170. };
  171. @endcode
  172. - **CompositeIndexParams** When using a parameters object of this type the index created
  173. combines the randomized kd-trees and the hierarchical k-means tree. :
  174. @code
  175. struct CompositeIndexParams : public IndexParams
  176. {
  177. CompositeIndexParams(
  178. int trees = 4,
  179. int branching = 32,
  180. int iterations = 11,
  181. flann_centers_init_t centers_init = CENTERS_RANDOM,
  182. float cb_index = 0.2 );
  183. };
  184. @endcode
  185. - **LshIndexParams** When using a parameters object of this type the index created uses
  186. multi-probe LSH (by Multi-Probe LSH: Efficient Indexing for High-Dimensional Similarity Search
  187. by Qin Lv, William Josephson, Zhe Wang, Moses Charikar, Kai Li., Proceedings of the 33rd
  188. International Conference on Very Large Data Bases (VLDB). Vienna, Austria. September 2007) :
  189. @code
  190. struct LshIndexParams : public IndexParams
  191. {
  192. LshIndexParams(
  193. unsigned int table_number,
  194. unsigned int key_size,
  195. unsigned int multi_probe_level );
  196. };
  197. @endcode
  198. - **AutotunedIndexParams** When passing an object of this type the index created is
  199. automatically tuned to offer the best performance, by choosing the optimal index type
  200. (randomized kd-trees, hierarchical kmeans, linear) and parameters for the dataset provided. :
  201. @code
  202. struct AutotunedIndexParams : public IndexParams
  203. {
  204. AutotunedIndexParams(
  205. float target_precision = 0.9,
  206. float build_weight = 0.01,
  207. float memory_weight = 0,
  208. float sample_fraction = 0.1 );
  209. };
  210. @endcode
  211. - **SavedIndexParams** This object type is used for loading a previously saved index from the
  212. disk. :
  213. @code
  214. struct SavedIndexParams : public IndexParams
  215. {
  216. SavedIndexParams( String filename );
  217. };
  218. @endcode
  219. */
  220. GenericIndex(const Mat& features, const ::cvflann::IndexParams& params, Distance distance = Distance());
  221. ~GenericIndex();
  222. /** @brief Performs a K-nearest neighbor search for a given query point using the index.
  223. @param query The query point
  224. @param indices Vector that will contain the indices of the K-nearest neighbors found. It must have
  225. at least knn size.
  226. @param dists Vector that will contain the distances to the K-nearest neighbors found. It must have
  227. at least knn size.
  228. @param knn Number of nearest neighbors to search for.
  229. @param params SearchParams
  230. */
  231. void knnSearch(const std::vector<ElementType>& query, std::vector<int>& indices,
  232. std::vector<DistanceType>& dists, int knn, const ::cvflann::SearchParams& params);
  233. void knnSearch(const Mat& queries, Mat& indices, Mat& dists, int knn, const ::cvflann::SearchParams& params);
  234. /** @brief Performs a radius nearest neighbor search for a given query point using the index.
  235. @param query The query point.
  236. @param indices Vector that will contain the indices of the nearest neighbors found.
  237. @param dists Vector that will contain the distances to the nearest neighbors found. It has the same
  238. number of elements as indices.
  239. @param radius The search radius.
  240. @param params SearchParams
  241. This function returns the number of nearest neighbors found.
  242. */
  243. int radiusSearch(const std::vector<ElementType>& query, std::vector<int>& indices,
  244. std::vector<DistanceType>& dists, DistanceType radius, const ::cvflann::SearchParams& params);
  245. int radiusSearch(const Mat& query, Mat& indices, Mat& dists,
  246. DistanceType radius, const ::cvflann::SearchParams& params);
  247. void save(String filename) { nnIndex->save(filename); }
  248. int veclen() const { return nnIndex->veclen(); }
  249. int size() const { return (int)nnIndex->size(); }
  250. ::cvflann::IndexParams getParameters() { return nnIndex->getParameters(); }
  251. CV_DEPRECATED const ::cvflann::IndexParams* getIndexParameters() { return nnIndex->getIndexParameters(); }
  252. private:
  253. ::cvflann::Index<Distance>* nnIndex;
  254. Mat _dataset;
  255. };
  256. //! @cond IGNORED
  257. #define FLANN_DISTANCE_CHECK \
  258. if ( ::cvflann::flann_distance_type() != cvflann::FLANN_DIST_L2) { \
  259. printf("[WARNING] You are using cv::flann::Index (or cv::flann::GenericIndex) and have also changed "\
  260. "the distance using cvflann::set_distance_type. This is no longer working as expected "\
  261. "(cv::flann::Index always uses L2). You should create the index templated on the distance, "\
  262. "for example for L1 distance use: GenericIndex< L1<float> > \n"); \
  263. }
  264. template <typename Distance>
  265. GenericIndex<Distance>::GenericIndex(const Mat& dataset, const ::cvflann::IndexParams& params, Distance distance)
  266. : _dataset(dataset)
  267. {
  268. CV_Assert(dataset.type() == CvType<ElementType>::type());
  269. CV_Assert(dataset.isContinuous());
  270. ::cvflann::Matrix<ElementType> m_dataset((ElementType*)_dataset.ptr<ElementType>(0), _dataset.rows, _dataset.cols);
  271. nnIndex = new ::cvflann::Index<Distance>(m_dataset, params, distance);
  272. FLANN_DISTANCE_CHECK
  273. nnIndex->buildIndex();
  274. }
  275. template <typename Distance>
  276. GenericIndex<Distance>::~GenericIndex()
  277. {
  278. delete nnIndex;
  279. }
  280. template <typename Distance>
  281. void GenericIndex<Distance>::knnSearch(const std::vector<ElementType>& query, std::vector<int>& indices, std::vector<DistanceType>& dists, int knn, const ::cvflann::SearchParams& searchParams)
  282. {
  283. ::cvflann::Matrix<ElementType> m_query((ElementType*)&query[0], 1, query.size());
  284. ::cvflann::Matrix<int> m_indices(&indices[0], 1, indices.size());
  285. ::cvflann::Matrix<DistanceType> m_dists(&dists[0], 1, dists.size());
  286. FLANN_DISTANCE_CHECK
  287. nnIndex->knnSearch(m_query,m_indices,m_dists,knn,searchParams);
  288. }
  289. template <typename Distance>
  290. void GenericIndex<Distance>::knnSearch(const Mat& queries, Mat& indices, Mat& dists, int knn, const ::cvflann::SearchParams& searchParams)
  291. {
  292. CV_Assert(queries.type() == CvType<ElementType>::type());
  293. CV_Assert(queries.isContinuous());
  294. ::cvflann::Matrix<ElementType> m_queries((ElementType*)queries.ptr<ElementType>(0), queries.rows, queries.cols);
  295. CV_Assert(indices.type() == CV_32S);
  296. CV_Assert(indices.isContinuous());
  297. ::cvflann::Matrix<int> m_indices((int*)indices.ptr<int>(0), indices.rows, indices.cols);
  298. CV_Assert(dists.type() == CvType<DistanceType>::type());
  299. CV_Assert(dists.isContinuous());
  300. ::cvflann::Matrix<DistanceType> m_dists((DistanceType*)dists.ptr<DistanceType>(0), dists.rows, dists.cols);
  301. FLANN_DISTANCE_CHECK
  302. nnIndex->knnSearch(m_queries,m_indices,m_dists,knn, searchParams);
  303. }
  304. template <typename Distance>
  305. int GenericIndex<Distance>::radiusSearch(const std::vector<ElementType>& query, std::vector<int>& indices, std::vector<DistanceType>& dists, DistanceType radius, const ::cvflann::SearchParams& searchParams)
  306. {
  307. ::cvflann::Matrix<ElementType> m_query((ElementType*)&query[0], 1, query.size());
  308. ::cvflann::Matrix<int> m_indices(&indices[0], 1, indices.size());
  309. ::cvflann::Matrix<DistanceType> m_dists(&dists[0], 1, dists.size());
  310. FLANN_DISTANCE_CHECK
  311. return nnIndex->radiusSearch(m_query,m_indices,m_dists,radius,searchParams);
  312. }
  313. template <typename Distance>
  314. int GenericIndex<Distance>::radiusSearch(const Mat& query, Mat& indices, Mat& dists, DistanceType radius, const ::cvflann::SearchParams& searchParams)
  315. {
  316. CV_Assert(query.type() == CvType<ElementType>::type());
  317. CV_Assert(query.isContinuous());
  318. ::cvflann::Matrix<ElementType> m_query((ElementType*)query.ptr<ElementType>(0), query.rows, query.cols);
  319. CV_Assert(indices.type() == CV_32S);
  320. CV_Assert(indices.isContinuous());
  321. ::cvflann::Matrix<int> m_indices((int*)indices.ptr<int>(0), indices.rows, indices.cols);
  322. CV_Assert(dists.type() == CvType<DistanceType>::type());
  323. CV_Assert(dists.isContinuous());
  324. ::cvflann::Matrix<DistanceType> m_dists((DistanceType*)dists.ptr<DistanceType>(0), dists.rows, dists.cols);
  325. FLANN_DISTANCE_CHECK
  326. return nnIndex->radiusSearch(m_query,m_indices,m_dists,radius,searchParams);
  327. }
  328. /**
  329. * @deprecated Use GenericIndex class instead
  330. */
  331. template <typename T>
  332. class Index_
  333. {
  334. public:
  335. typedef typename L2<T>::ElementType ElementType;
  336. typedef typename L2<T>::ResultType DistanceType;
  337. CV_DEPRECATED Index_(const Mat& dataset, const ::cvflann::IndexParams& params)
  338. {
  339. printf("[WARNING] The cv::flann::Index_<T> class is deperecated, use cv::flann::GenericIndex<Distance> instead\n");
  340. CV_Assert(dataset.type() == CvType<ElementType>::type());
  341. CV_Assert(dataset.isContinuous());
  342. ::cvflann::Matrix<ElementType> m_dataset((ElementType*)dataset.ptr<ElementType>(0), dataset.rows, dataset.cols);
  343. if ( ::cvflann::flann_distance_type() == cvflann::FLANN_DIST_L2 ) {
  344. nnIndex_L1 = NULL;
  345. nnIndex_L2 = new ::cvflann::Index< L2<ElementType> >(m_dataset, params);
  346. }
  347. else if ( ::cvflann::flann_distance_type() == cvflann::FLANN_DIST_L1 ) {
  348. nnIndex_L1 = new ::cvflann::Index< L1<ElementType> >(m_dataset, params);
  349. nnIndex_L2 = NULL;
  350. }
  351. else {
  352. printf("[ERROR] cv::flann::Index_<T> only provides backwards compatibility for the L1 and L2 distances. "
  353. "For other distance types you must use cv::flann::GenericIndex<Distance>\n");
  354. CV_Assert(0);
  355. }
  356. if (nnIndex_L1) nnIndex_L1->buildIndex();
  357. if (nnIndex_L2) nnIndex_L2->buildIndex();
  358. }
  359. CV_DEPRECATED ~Index_()
  360. {
  361. if (nnIndex_L1) delete nnIndex_L1;
  362. if (nnIndex_L2) delete nnIndex_L2;
  363. }
  364. CV_DEPRECATED void knnSearch(const std::vector<ElementType>& query, std::vector<int>& indices, std::vector<DistanceType>& dists, int knn, const ::cvflann::SearchParams& searchParams)
  365. {
  366. ::cvflann::Matrix<ElementType> m_query((ElementType*)&query[0], 1, query.size());
  367. ::cvflann::Matrix<int> m_indices(&indices[0], 1, indices.size());
  368. ::cvflann::Matrix<DistanceType> m_dists(&dists[0], 1, dists.size());
  369. if (nnIndex_L1) nnIndex_L1->knnSearch(m_query,m_indices,m_dists,knn,searchParams);
  370. if (nnIndex_L2) nnIndex_L2->knnSearch(m_query,m_indices,m_dists,knn,searchParams);
  371. }
  372. CV_DEPRECATED void knnSearch(const Mat& queries, Mat& indices, Mat& dists, int knn, const ::cvflann::SearchParams& searchParams)
  373. {
  374. CV_Assert(queries.type() == CvType<ElementType>::type());
  375. CV_Assert(queries.isContinuous());
  376. ::cvflann::Matrix<ElementType> m_queries((ElementType*)queries.ptr<ElementType>(0), queries.rows, queries.cols);
  377. CV_Assert(indices.type() == CV_32S);
  378. CV_Assert(indices.isContinuous());
  379. ::cvflann::Matrix<int> m_indices((int*)indices.ptr<int>(0), indices.rows, indices.cols);
  380. CV_Assert(dists.type() == CvType<DistanceType>::type());
  381. CV_Assert(dists.isContinuous());
  382. ::cvflann::Matrix<DistanceType> m_dists((DistanceType*)dists.ptr<DistanceType>(0), dists.rows, dists.cols);
  383. if (nnIndex_L1) nnIndex_L1->knnSearch(m_queries,m_indices,m_dists,knn, searchParams);
  384. if (nnIndex_L2) nnIndex_L2->knnSearch(m_queries,m_indices,m_dists,knn, searchParams);
  385. }
  386. CV_DEPRECATED int radiusSearch(const std::vector<ElementType>& query, std::vector<int>& indices, std::vector<DistanceType>& dists, DistanceType radius, const ::cvflann::SearchParams& searchParams)
  387. {
  388. ::cvflann::Matrix<ElementType> m_query((ElementType*)&query[0], 1, query.size());
  389. ::cvflann::Matrix<int> m_indices(&indices[0], 1, indices.size());
  390. ::cvflann::Matrix<DistanceType> m_dists(&dists[0], 1, dists.size());
  391. if (nnIndex_L1) return nnIndex_L1->radiusSearch(m_query,m_indices,m_dists,radius,searchParams);
  392. if (nnIndex_L2) return nnIndex_L2->radiusSearch(m_query,m_indices,m_dists,radius,searchParams);
  393. }
  394. CV_DEPRECATED int radiusSearch(const Mat& query, Mat& indices, Mat& dists, DistanceType radius, const ::cvflann::SearchParams& searchParams)
  395. {
  396. CV_Assert(query.type() == CvType<ElementType>::type());
  397. CV_Assert(query.isContinuous());
  398. ::cvflann::Matrix<ElementType> m_query((ElementType*)query.ptr<ElementType>(0), query.rows, query.cols);
  399. CV_Assert(indices.type() == CV_32S);
  400. CV_Assert(indices.isContinuous());
  401. ::cvflann::Matrix<int> m_indices((int*)indices.ptr<int>(0), indices.rows, indices.cols);
  402. CV_Assert(dists.type() == CvType<DistanceType>::type());
  403. CV_Assert(dists.isContinuous());
  404. ::cvflann::Matrix<DistanceType> m_dists((DistanceType*)dists.ptr<DistanceType>(0), dists.rows, dists.cols);
  405. if (nnIndex_L1) return nnIndex_L1->radiusSearch(m_query,m_indices,m_dists,radius,searchParams);
  406. if (nnIndex_L2) return nnIndex_L2->radiusSearch(m_query,m_indices,m_dists,radius,searchParams);
  407. }
  408. CV_DEPRECATED void save(String filename)
  409. {
  410. if (nnIndex_L1) nnIndex_L1->save(filename);
  411. if (nnIndex_L2) nnIndex_L2->save(filename);
  412. }
  413. CV_DEPRECATED int veclen() const
  414. {
  415. if (nnIndex_L1) return nnIndex_L1->veclen();
  416. if (nnIndex_L2) return nnIndex_L2->veclen();
  417. }
  418. CV_DEPRECATED int size() const
  419. {
  420. if (nnIndex_L1) return nnIndex_L1->size();
  421. if (nnIndex_L2) return nnIndex_L2->size();
  422. }
  423. CV_DEPRECATED ::cvflann::IndexParams getParameters()
  424. {
  425. if (nnIndex_L1) return nnIndex_L1->getParameters();
  426. if (nnIndex_L2) return nnIndex_L2->getParameters();
  427. }
  428. CV_DEPRECATED const ::cvflann::IndexParams* getIndexParameters()
  429. {
  430. if (nnIndex_L1) return nnIndex_L1->getIndexParameters();
  431. if (nnIndex_L2) return nnIndex_L2->getIndexParameters();
  432. }
  433. private:
  434. // providing backwards compatibility for L2 and L1 distances (most common)
  435. ::cvflann::Index< L2<ElementType> >* nnIndex_L2;
  436. ::cvflann::Index< L1<ElementType> >* nnIndex_L1;
  437. };
  438. //! @endcond
  439. /** @brief Clusters features using hierarchical k-means algorithm.
  440. @param features The points to be clustered. The matrix must have elements of type
  441. Distance::ElementType.
  442. @param centers The centers of the clusters obtained. The matrix must have type
  443. Distance::ResultType. The number of rows in this matrix represents the number of clusters desired,
  444. however, because of the way the cut in the hierarchical tree is chosen, the number of clusters
  445. computed will be the highest number of the form (branching-1)\*k+1 that's lower than the number of
  446. clusters desired, where branching is the tree's branching factor (see description of the
  447. KMeansIndexParams).
  448. @param params Parameters used in the construction of the hierarchical k-means tree.
  449. @param d Distance to be used for clustering.
  450. The method clusters the given feature vectors by constructing a hierarchical k-means tree and
  451. choosing a cut in the tree that minimizes the cluster's variance. It returns the number of clusters
  452. found.
  453. */
  454. template <typename Distance>
  455. int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::KMeansIndexParams& params,
  456. Distance d = Distance())
  457. {
  458. typedef typename Distance::ElementType ElementType;
  459. typedef typename Distance::ResultType DistanceType;
  460. CV_Assert(features.type() == CvType<ElementType>::type());
  461. CV_Assert(features.isContinuous());
  462. ::cvflann::Matrix<ElementType> m_features((ElementType*)features.ptr<ElementType>(0), features.rows, features.cols);
  463. CV_Assert(centers.type() == CvType<DistanceType>::type());
  464. CV_Assert(centers.isContinuous());
  465. ::cvflann::Matrix<DistanceType> m_centers((DistanceType*)centers.ptr<DistanceType>(0), centers.rows, centers.cols);
  466. return ::cvflann::hierarchicalClustering<Distance>(m_features, m_centers, params, d);
  467. }
  468. //! @cond IGNORED
  469. template <typename ELEM_TYPE, typename DIST_TYPE>
  470. CV_DEPRECATED int hierarchicalClustering(const Mat& features, Mat& centers, const ::cvflann::KMeansIndexParams& params)
  471. {
  472. printf("[WARNING] cv::flann::hierarchicalClustering<ELEM_TYPE,DIST_TYPE> is deprecated, use "
  473. "cv::flann::hierarchicalClustering<Distance> instead\n");
  474. if ( ::cvflann::flann_distance_type() == cvflann::FLANN_DIST_L2 ) {
  475. return hierarchicalClustering< L2<ELEM_TYPE> >(features, centers, params);
  476. }
  477. else if ( ::cvflann::flann_distance_type() == cvflann::FLANN_DIST_L1 ) {
  478. return hierarchicalClustering< L1<ELEM_TYPE> >(features, centers, params);
  479. }
  480. else {
  481. printf("[ERROR] cv::flann::hierarchicalClustering<ELEM_TYPE,DIST_TYPE> only provides backwards "
  482. "compatibility for the L1 and L2 distances. "
  483. "For other distance types you must use cv::flann::hierarchicalClustering<Distance>\n");
  484. CV_Assert(0);
  485. }
  486. }
  487. //! @endcond
  488. //! @} flann
  489. } } // namespace cv::flann
  490. #endif