Berkeley SfM
feature_matcher_options.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, The Regents of the University of California (Regents).
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following
14  * disclaimer in the documentation and/or other materials provided
15  * with the distribution.
16  *
17  * 3. Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Please contact the author(s) of this library if you have any questions.
34  * Authors: Erik Nelson ( eanelson@eecs.berkeley.edu )
35  * David Fridovich-Keil ( dfk@eecs.berkeley.edu )
36  */
37 
38 ///////////////////////////////////////////////////////////////////////////////
39 //
40 // This struct defines a set of options that are used during feature matching.
41 //
42 ///////////////////////////////////////////////////////////////////////////////
43 
44 #ifndef BSFM_MATCHING_FEATURE_MATCHER_OPTIONS_H
45 #define BSFM_MATCHING_FEATURE_MATCHER_OPTIONS_H
46 
47 namespace bsfm {
48 
50 
51  // Use the lowes ratio test for feature matching. Given n potential matches
52  // between a feature from this image and features in another image, we will
53  // only consider this feature matched if the best 2 matches differ by at most
54  // the lowes ratio.
55  // i.e. store the match if:
56  // distance(best_match) < lowes_ratio^2 * distance(second_best_match)
57  bool use_lowes_ratio = true;
58  double lowes_ratio = 0.75;
59 
60  // The minimum number of feature matches between two images required to
61  // consider the image pair a match.
62  unsigned int min_num_feature_matches = 20;
63 
64  // Only store matches that are the best feature match in both directions.
66 
67  // Only return the best matches.
68  bool only_keep_best_matches = false;
69 
70  // If 'only_keep_best_matches' is true, this is the number of best matches to
71  // keep. Otherwise this option will not do anything.
72  unsigned int num_best_matches = 100;
73 
74  // Decide whether or not to enforce a maximum distance between descriptors.
75  // This is not usually necessary, as the lowes ratio test is generally
76  // sufficient.
78 
79  // The maximum tolerable distance between two descriptors to classify them as
80  // a match. This value will only be used if
81  // 'enforce_maximum_descriptor_distance' is true.
83 
84 }; //\struct FeatureMatcherOptions
85 
86 } //\namespace bsfm
87 
88 #endif
Definition: camera.cpp:50