$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
estim/mean.hh
1 // Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
2 //
3 // This file is part of Olena.
4 //
5 // Olena is free software: you can redistribute it and/or modify it under
6 // the terms of the GNU General Public License as published by the Free
7 // Software Foundation, version 2 of the License.
8 //
9 // Olena is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
16 //
17 // As a special exception, you may use this file as part of a free
18 // software project without restriction. Specifically, if other files
19 // instantiate templates or use macros or inline functions from this
20 // file, or you compile this file and link it with other files to produce
21 // an executable, this file does not by itself cause the resulting
22 // executable to be covered by the GNU General Public License. This
23 // exception does not however invalidate any other reasons why the
24 // executable file might be covered by the GNU General Public License.
25 
26 #ifndef MLN_ESTIM_MEAN_HH
27 # define MLN_ESTIM_MEAN_HH
28 
32 
33 # include <mln/accu/stat/mean.hh>
34 # include <mln/data/compute.hh>
35 
36 
37 namespace mln
38 {
39 
40  namespace estim
41  {
42 
44 
48  template <typename I>
49  mln_sum(mln_value(I)) mean(const Image<I>& input);
50 
51 
53 
60  template <typename S, typename I, typename M>
61  void mean(const Image<I>& input, M& result);
62 
63 
64 # ifndef MLN_INCLUDE_ONLY
65 
66  template <typename I>
67  inline
68  mln_sum(mln_value(I)) mean(const Image<I>& input)
69  {
70  mln_precondition(exact(input).is_valid());
71  return data::compute(accu::meta::stat::mean(), input);
72  }
73 
74  template <typename S, typename I, typename M>
75  inline
76  void mean(const Image<I>& input, M& result)
77  {
78  mln_precondition(exact(input).is_valid());
79  accu::stat::mean<mln_value(I), S, M> a;
80  result = data::compute(a, input);
81  }
82 
83 # endif // ! MLN_INCLUDE_ONLY
84 
85  } // end of namespace mln::estim
86 
87 } // end of namespace mln
88 
89 
90 #endif // ! MLN_ESTIM_MEAN_HH