Updated FMM run() signature
[profile/ivi/opencv.git] / modules / videostab / include / opencv2 / videostab / fast_marching.hpp
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-2011, 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_VIDEOSTAB_FAST_MARCHING_HPP__
44 #define __OPENCV_VIDEOSTAB_FAST_MARCHING_HPP__
45
46 #include <cmath>
47 #include <queue>
48 #include <algorithm>
49 #include "opencv2/core/core.hpp"
50
51 namespace cv
52 {
53 namespace videostab
54 {
55
56 // See http://iwi.eldoc.ub.rug.nl/FILES/root/2004/JGraphToolsTelea/2004JGraphToolsTelea.pdf
57 class CV_EXPORTS FastMarchingMethod
58 {
59 public:
60     FastMarchingMethod() : inf_(1e6f) {}
61
62     template <typename Inpaint>
63     Inpaint run(const Mat &mask, Inpaint inpaint);
64
65     Mat distanceMap() const { return dist_; }
66
67 private:
68     enum { INSIDE = 0, BAND = 1, KNOWN = 255 };
69
70     struct DXY
71     {
72         float dist;
73         int x, y;
74
75         DXY() : dist(0), x(0), y(0) {}
76         DXY(float dist, int x, int y) : dist(dist), x(x), y(y) {}
77         bool operator <(const DXY &dxy) const { return dist < dxy.dist; }
78     };
79
80     float solve(int x1, int y1, int x2, int y2) const;
81     int& indexOf(const DXY &dxy) { return index_(dxy.y, dxy.x); }
82
83     void heapUp(int idx);
84     void heapDown(int idx);
85     void heapAdd(const DXY &dxy);
86     void heapRemoveMin();
87
88     float inf_;
89
90     cv::Mat_<uchar> flag_; // flag map
91     cv::Mat_<float> dist_; // distance map
92
93     cv::Mat_<int> index_; // index of point in the narrow band
94     std::vector<DXY> narrowBand_; // narrow band heap
95     int size_; // narrow band size
96 };
97
98 } // namespace videostab
99 } // namespace cv
100
101 #include "fast_marching_inl.hpp"
102
103 #endif