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 
43 #ifndef OPENCV_MINIFLANN_HPP
44 #define OPENCV_MINIFLANN_HPP
45 
46 #include "opencv2/core.hpp"
47 #include "opencv2/flann/defines.h"
48 
49 namespace cv
50 {
51 
52 namespace flann
53 {
54 
55 struct CV_EXPORTS IndexParams
56 {
57     IndexParams();
58     ~IndexParams();
59 
60     String getString(const String& key, const String& defaultVal=String()) const;
61     int getInt(const String& key, int defaultVal=-1) const;
62     double getDouble(const String& key, double defaultVal=-1) const;
63 
64     void setString(const String& key, const String& value);
65     void setInt(const String& key, int value);
66     void setDouble(const String& key, double value);
67     void setFloat(const String& key, float value);
68     void setBool(const String& key, bool value);
69     void setAlgorithm(int value);
70 
71     void getAll(std::vector<String>& names,
72                 std::vector<int>& types,
73                 std::vector<String>& strValues,
74                 std::vector<double>& numValues) const;
75 
76     void* params;
77 
78 private:
79     IndexParams(const IndexParams &); // copy disabled
80     IndexParams& operator=(const IndexParams &); // assign disabled
81 };
82 
83 struct CV_EXPORTS KDTreeIndexParams : public IndexParams
84 {
85     KDTreeIndexParams(int trees=4);
86 };
87 
88 struct CV_EXPORTS LinearIndexParams : public IndexParams
89 {
90     LinearIndexParams();
91 };
92 
93 struct CV_EXPORTS CompositeIndexParams : public IndexParams
94 {
95     CompositeIndexParams(int trees = 4, int branching = 32, int iterations = 11,
96                          cvflann::flann_centers_init_t centers_init = cvflann::FLANN_CENTERS_RANDOM, float cb_index = 0.2f );
97 };
98 
99 struct CV_EXPORTS AutotunedIndexParams : public IndexParams
100 {
101     AutotunedIndexParams(float target_precision = 0.8f, float build_weight = 0.01f,
102                          float memory_weight = 0, float sample_fraction = 0.1f);
103 };
104 
105 struct CV_EXPORTS HierarchicalClusteringIndexParams : public IndexParams
106 {
107     HierarchicalClusteringIndexParams(int branching = 32,
108                       cvflann::flann_centers_init_t centers_init = cvflann::FLANN_CENTERS_RANDOM, int trees = 4, int leaf_size = 100 );
109 };
110 
111 struct CV_EXPORTS KMeansIndexParams : public IndexParams
112 {
113     KMeansIndexParams(int branching = 32, int iterations = 11,
114                       cvflann::flann_centers_init_t centers_init = cvflann::FLANN_CENTERS_RANDOM, float cb_index = 0.2f );
115 };
116 
117 struct CV_EXPORTS LshIndexParams : public IndexParams
118 {
119     LshIndexParams(int table_number, int key_size, int multi_probe_level);
120 };
121 
122 struct CV_EXPORTS SavedIndexParams : public IndexParams
123 {
124     SavedIndexParams(const String& filename);
125 };
126 
127 struct CV_EXPORTS SearchParams : public IndexParams
128 {
129     SearchParams( int checks = 32, float eps = 0, bool sorted = true );
130 };
131 
132 class CV_EXPORTS_W Index
133 {
134 public:
135     CV_WRAP Index();
136     CV_WRAP Index(InputArray features, const IndexParams& params, cvflann::flann_distance_t distType=cvflann::FLANN_DIST_L2);
137     virtual ~Index();
138 
139     CV_WRAP virtual void build(InputArray features, const IndexParams& params, cvflann::flann_distance_t distType=cvflann::FLANN_DIST_L2);
140     CV_WRAP virtual void knnSearch(InputArray query, OutputArray indices,
141                    OutputArray dists, int knn, const SearchParams& params=SearchParams());
142 
143     CV_WRAP virtual int radiusSearch(InputArray query, OutputArray indices,
144                              OutputArray dists, double radius, int maxResults,
145                              const SearchParams& params=SearchParams());
146 
147     CV_WRAP virtual void save(const String& filename) const;
148     CV_WRAP virtual bool load(InputArray features, const String& filename);
149     CV_WRAP virtual void release();
150     CV_WRAP cvflann::flann_distance_t getDistance() const;
151     CV_WRAP cvflann::flann_algorithm_t getAlgorithm() const;
152 
153 protected:
154     cvflann::flann_distance_t distType;
155     cvflann::flann_algorithm_t algo;
156     int featureType;
157     void* index;
158 };
159 
160 } } // namespace cv::flann
161 
162 #endif
163