$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
sauvola.hh
1 // Copyright (C) 2009, 2010, 2011 EPITA Research and Development
2 // Laboratory (LRDE)
3 //
4 // This file is part of Olena.
5 //
6 // Olena is free software: you can redistribute it and/or modify it under
7 // the terms of the GNU General Public License as published by the Free
8 // Software Foundation, version 2 of the License.
9 //
10 // Olena is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
17 //
18 // As a special exception, you may use this file as part of a free
19 // software project without restriction. Specifically, if other files
20 // instantiate templates or use macros or inline functions from this
21 // file, or you compile this file and link it with other files to produce
22 // an executable, this file does not by itself cause the resulting
23 // executable to be covered by the GNU General Public License. This
24 // exception does not however invalidate any other reasons why the
25 // executable file might be covered by the GNU General Public License.
26 
27 #ifndef SCRIBO_BINARIZATION_SAUVOLA_HH
28 # define SCRIBO_BINARIZATION_SAUVOLA_HH
29 
33 
34 # include <mln/core/concept/image.hh>
35 # include <scribo/binarization/internal/sauvola_functor.hh>
36 # include <scribo/binarization/internal/local_threshold_core.hh>
37 
38 namespace scribo
39 {
40 
41  namespace binarization
42  {
43 
44  using namespace mln;
45 
46 
57  template <typename I>
58  mln_ch_value(I, bool)
59  sauvola(const Image<I>& input, unsigned window_size, double K);
60 
61 
62 
76  template <typename I>
77  mln_ch_value(I, bool)
78  sauvola(const Image<I>& input, unsigned window_size);
79 
80 
86  template <typename I>
87  mln_ch_value(I, bool)
88  sauvola(const Image<I>& input);
89 
90 
91 # ifndef MLN_INCLUDE_ONLY
92 
93  // Facades
94 
95  template <typename I>
96  mln_ch_value(I, bool)
97  sauvola(const Image<I>& input, unsigned window_size, double K)
98  {
99  mln_trace("scribo::binarization::sauvola");
100 
101  mln_precondition(exact(input).is_valid());
102 
103  internal::sauvola_functor<I> f(input, K, SCRIBO_DEFAULT_SAUVOLA_R);
104  internal::local_threshold_core(input, f, window_size);
105 
106  return f.output;
107  }
108 
109 
110  template <typename I>
111  mln_ch_value(I, bool)
112  sauvola(const Image<I>& input, unsigned window_size)
113  {
114  return sauvola(input, window_size, SCRIBO_DEFAULT_SAUVOLA_K);
115  }
116 
117 
118  template <typename I>
119  mln_ch_value(I, bool)
120  sauvola(const Image<I>& input)
121  {
122  return sauvola(input, 11);
123  }
124 
125 
126 # endif // ! MLN_INCLUDE_ONLY
127 
128 
129  } // end of namespace scribo::binarization
130 
131 } // end of namespace scribo
132 
133 
134 #endif // ! SCRIBO_BINARIZATION_SAUVOLA_HH