$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
data/saturate.hh
1 // Copyright (C) 2007, 2008, 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_DATA_SATURATE_HH
28 # define MLN_DATA_SATURATE_HH
29 
33 
34 # include <mln/fun/v2v/saturate.hh>
35 # include <mln/data/apply.hh>
36 # include <mln/data/transform.hh>
37 
38 
39 namespace mln
40 {
41 
42  namespace data
43  {
44 
45 
57  template <typename V, typename I>
58  mln_ch_value(I, V)
59  saturate(V v, const Image<I>& input);
60 
61 
70  template <typename I, typename V>
71  mln_ch_value(I, V)
72  saturate(const Image<I>& input,
73  const V& min, const V& max);
74 
75 
84  template <typename I>
85  void saturate_inplace(Image<I>& input,
86  const mln_value(I)& min, const mln_value(I)& max);
87 
88 
89 # ifndef MLN_INCLUDE_ONLY
90 
91  template <typename V, typename I>
92  inline
93  mln_ch_value(I, V)
94  saturate(V, const Image<I>& input)
95  {
96  mln_trace("data::saturate");
97 
98  mln_precondition(exact(input).is_valid());
99 
100  fun::v2v::saturate<V> f;
101  mln_ch_value(I, V) output = data::transform(input, f);
102 
103  return output;
104  }
105 
106  template <typename I, typename V>
107  inline
108  mln_ch_value(I, V)
109  saturate(const Image<I>& input,
110  const V& min, const V& max)
111  {
112  mln_trace("data::saturate");
113 
114  mln_precondition(exact(input).is_valid());
115 
116  fun::v2v::saturate<V> f(min, max);
117  mln_ch_value(I, V) output = data::transform(input, f);
118 
119  return output;
120  }
121 
122  template <typename I>
123  inline
124  void saturate_inplace(Image<I>& input,
125  const mln_value(I)& min, const mln_value(I)& max)
126  {
127  mln_trace("data::saturate_inplace");
128 
129  mln_precondition(exact(input).is_valid());
130 
131  fun::v2v::saturate<mln_value(I)> f(min, max);
132  data::apply(input, f);
133 
134  }
135 
136 # endif // ! MLN_INCLUDE_ONLY
137 
138  } // end of namespace mln::data
139 
140 } // end of namespace mln
141 
142 
143 #endif // ! MLN_DATA_SATURATE_HH