Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
background.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_LABELING_BACKGROUND_HH
27 # define MLN_LABELING_BACKGROUND_HH
28 
33 
34 # include <mln/labeling/value.hh>
35 
36 
37 namespace mln
38 {
39 
40  namespace labeling
41  {
42 
58  template <typename I, typename N, typename L>
59  mln_ch_value(I, L)
60  background(const Image<I>& input, const Neighborhood<N>& nbh,
61  L& nlabels);
62 
63 
64 # ifndef MLN_INCLUDE_ONLY
65 
66  template <typename I, typename N, typename L>
67  inline
68  mln_ch_value(I, L)
69  background(const Image<I>& input, const Neighborhood<N>& nbh,
70  L& nlabels)
71  {
72  trace::entering("labeling::background");
73 
74  mlc_equal(mln_trait_image_kind(I),
75  mln::trait::image::kind::binary)::check();
76  mln_precondition(exact(input).is_valid());
77  mln_precondition(exact(nbh).is_valid());
78 
79  mln_ch_value(I, L) output = labeling::value(input, false, nbh, nlabels);
80 
81  trace::exiting("labeling::background");
82  return output;
83  }
84 
85 # endif // ! MLN_INCLUDE_ONLY
86 
87  } // end of namespace mln::labeling
88 
89 } // end of namespace mln
90 
91 
92 #endif // ! MLN_LABELING_BACKGROUND_HH