$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
core/concept/doc/image.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 namespace mln
27 {
28 
29  namespace doc
30  {
31 
35  template <typename E>
36  struct Image : public Object<E>
37  {
38 
44  typedef void value;
45 
48  typedef void rvalue;
49 
52  typedef void lvalue;
53 
57  typedef void vset;
58 
59 
60 
64  typedef void skeleton;
65 
66 
67 
70  bool is_valid() const;
71 
77  bool has(const psite& p) const;
78 
83  const pset& domain() const;
84 
89  const vset& values() const;
90 
99  rvalue operator()(const psite& p) const;
100 
109  lvalue operator()(const psite& p);
110 
111 
112 
116  typedef void pset;
117 
121  typedef void point;
122 
126  typedef void psite;
127 
128 
131  typedef void coord;
132 
136  typedef void dpoint;
137 
138 
142  typedef void fwd_piter;
143 
147  typedef void bkd_piter;
148 
149 
158  bool has(const psite& p) const;
159 
169  const box<point>& bbox() const;
170 
173  unsigned nsites() const;
174  };
175 
176 
177  } // end of namespace mln::doc
178 
179 } // end of namespace mln