$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
morpho/min.hh
1 // Copyright (C) 2007, 2009, 2012 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 MLN_MORPHO_MIN_HH
28 # define MLN_MORPHO_MIN_HH
29 
37 # include <mln/data/compare.hh>
38 # include <mln/logical/and.hh>
39 # include <mln/arith/min.hh>
40 
41 
42 namespace mln
43 {
44 
45  namespace morpho
46  {
47 
53  template <typename I, typename J>
54  mln_concrete(I)
55  min(const Image<I>& lhs, const Image<J>& rhs);
56 
57 
64  template <typename I, typename J>
65  void min_inplace(Image<I>& lhs, const Image<J>& rhs);
66 
67 
68 # ifndef MLN_INCLUDE_ONLY
69 
70  namespace impl
71  {
72 
73  // Binary => morphology on sets.
74 
75  template <typename I, typename J, typename O>
76  inline
77  mln_concrete(I) min_(trait::image::kind::logic,
78  const I& lhs, const J& rhs)
79  {
80  return logical::and_(lhs, rhs);
81  }
82 
83  template <typename I, typename J>
84  inline
85  void min_inplace_(trait::image::kind::logic,
86  I& lhs, const J& rhs)
87  {
88  logical::and_inplace(lhs, rhs);
89  }
90 
91  // Otherwise => morphology on functions.
92 
93  template <typename I, typename J>
94  inline
95  mln_concrete(I) min_(trait::image::kind::any,
96  const I& lhs, const J& rhs)
97  {
98  return arith::min(lhs, rhs);
99  }
100 
101  template <typename I, typename J>
102  inline
103  void min_inplace_(trait::image::kind::any,
104  I& lhs, const J& rhs)
105  {
106  arith::min_inplace(lhs, rhs);
107  }
108 
109  } // end of namespace mln::morpho::impl
110 
111 
112  // Facades.
113 
114  template <typename I, typename J>
115  inline
116  mln_concrete(I)
117  min(const Image<I>& lhs, const Image<J>& rhs)
118  {
119  mln_trace("morpho::min");
120  mln_precondition(exact(rhs).domain() == exact(lhs).domain());
121 
122  mln_concrete(I) output = impl::min_(mln_trait_image_kind(I)(), exact(lhs), exact(rhs));
123 
124  return output;
125  }
126 
127  template <typename I, typename J>
128  inline
129  void min_inplace(Image<I>& lhs, const Image<J>& rhs)
130  {
131  mln_trace("morpho::min_inplace");
132  mln_precondition(exact(rhs).domain() == exact(lhs).domain());
133 
134  impl::min_inplace_(mln_trait_image_kind(I)(), exact(lhs), exact(rhs));
135 
136  }
137 
138 # endif // ! MLN_INCLUDE_ONLY
139 
140  } // end of namespace mln::morpho
141 
142 } // end of namespace mln
143 
144 
145 #endif // ! MLN_MORPHO_MIN_HH