Merging remained part of hybrid tracker which adds correlation threshold
[blender.git] / extern / libmv / libmv / tracking / esm_region_tracker.h
1 // Copyright (c) 2007, 2008, 2009, 2011 libmv authors.
2 //
3 // Permission is hereby granted, free of charge, to any person obtaining a copy
4 // of this software and associated documentation files (the "Software"), to
5 // deal in the Software without restriction, including without limitation the
6 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 // sell copies of the Software, and to permit persons to whom the Software is
8 // furnished to do so, subject to the following conditions:
9 //
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
12 //
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19 // IN THE SOFTWARE.
20
21 #ifndef LIBMV_REGION_TRACKING_LMICKLT_REGION_TRACKER_H_
22 #define LIBMV_REGION_TRACKING_LMICKLT_REGION_TRACKER_H_
23
24 #include "libmv/image/image.h"
25 #include "libmv/tracking/region_tracker.h"
26
27 namespace libmv {
28
29 /*!
30     A translation-only Efficient Second-order Minimization ("ESM") tracker
31
32     Based on the paper "Real-time image-based trackiing of planes using
33     Efficient Second-order Minimization"
34 */
35 struct EsmRegionTracker : public RegionTracker {
36   EsmRegionTracker()
37       : half_window_size(4),
38         max_iterations(16),
39         min_determinant(1e-6),
40         min_update_squared_distance(1e-4),
41         sigma(0.9),
42         minimum_correlation(0.78) {}
43   
44   virtual ~EsmRegionTracker() {}
45
46   // Tracker interface.
47   virtual bool Track(const FloatImage &image1,
48                      const FloatImage &image2,
49                      double  x1, double  y1,
50                      double *x2, double *y2) const;
51
52   // No point in creating getters or setters.
53   int half_window_size;
54   int max_iterations;
55   double min_determinant;
56   double min_update_squared_distance;
57   double sigma;
58   double minimum_correlation;
59 };
60
61 }  // namespace libmv
62
63 #endif  // LIBMV_REGION_TRACKING_LMICKLT_REGION_TRACKER_H_