$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
core/pixel.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_CORE_PIXEL_HH
28 # define MLN_CORE_PIXEL_HH
29 
37 
38 # include <mln/core/concept/generalized_pixel.hh>
39 # include <mln/core/internal/pixel_impl.hh>
40 
41 
42 namespace mln
43 {
44 
45 
50  template <typename I>
51  struct pixel : public Object< pixel<I> >,
52  public Generalized_Pixel< pixel<I> >,
53  internal::pixel_impl_< I, pixel<I> >
54  {
56  pixel(I& image);
57 
59  pixel(I& image, const mln_psite(I)& p);
60 
62  void change_to(const mln_psite(I)& p);
63 
65  bool is_valid() const;
66 
67  private:
69  };
70 
71 
72 # ifndef MLN_INCLUDE_ONLY
73 
74  template <typename I>
75  inline
76  pixel<I>::pixel(I& image)
77  : super(image)
78  {
79  }
80 
81  template <typename I>
82  inline
83  pixel<I>::pixel(I& image, const mln_psite(I)& p)
84  : super(image)
85  {
86  mln_precondition(this->image_.has(p));
87  change_to(p);
88  }
89 
90  template <typename I>
91  inline
92  void
93  pixel<I>::change_to(const mln_psite(I)& p)
94  {
95  mln_precondition(this->image_.has(p));
96  this->value_ptr_ = & this->image_(p);
97  }
98 
99  template <typename I>
100  inline
101  bool
102  pixel<I>::is_valid() const
103  {
104  if (this->value_ptr_ == 0 || ! this->image_.is_valid())
105  return false;
106  int o = this->value_ptr_ - this->image_.buffer();
107  mln_psite(I) p = this->image_.point_at_offset(o);
108  return this->image_.has(p);
109  }
110 
111 # endif // ! MLN_INCLUDE_ONLY
112 
113 } // end of namespace mln
114 
115 
116 # include <mln/make/pixel.hh>
117 
118 
119 #endif // ! MLN_CORE_PIXEL_HH