$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rectangularity.hh
1 // Copyright (C) 2009, 2013 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_ACCU_SITE_SET_RECTANGULARITY_HH
27 # define MLN_ACCU_SITE_SET_RECTANGULARITY_HH
28 
32 
33 # include <mln/accu/internal/couple.hh>
34 # include <mln/accu/shape/bbox.hh>
35 # include <mln/accu/math/count.hh>
36 
37 namespace mln
38 {
39 
40  namespace accu
41  {
42 
43  namespace site_set
44  {
45 
49  //
50  template <typename P>
52  : public accu::internal::couple<accu::shape::bbox<P>,
53  accu::math::count<P>,
54  float,
55  rectangularity<P> >
56  {
57 
58  public:
59 
62  float,
64 
67 
68  typedef float result;
69 
72 
74  mln_result(A1) bbox() const;
76  mln_result(A2) area() const;
77 
79  result to_result() const;
80  };
81 
82 
83 # ifndef MLN_INCLUDE_ONLY
84 
85  template <typename P>
86  inline
88  {
89  }
90 
91  template <typename P>
92  inline
93  mln_result(rectangularity<P>::A1)
94  rectangularity<P>::bbox() const
95  {
96  mln_precondition(this->a1_.is_valid());
97  return this->a1_.to_result();
98  }
99 
100  template <typename P>
101  inline
102  mln_result(rectangularity<P>::A2)
103  rectangularity<P>::area() const
104  {
105  mln_precondition(this->a2_.is_valid());
106  return this->a2_.to_result();
107  }
108 
109  template <typename P>
110  inline
111  mln_result(rectangularity<P>)
112  rectangularity<P>::to_result() const
113  {
114  mln_precondition(this->is_valid());
115  // Force division return type.
116  return static_cast<result>
117  (this->a2_.to_result()) / this->a1_.to_result().nsites();
118  }
119 
120 # endif // ! MLN_INCLUDE_ONLY
121 
122  } // end of namespace mln::accu::site_set
123 
124  } // end of namespace mln::accu
125 
126 } // end of namespace mln
127 
128 #endif // ! MLN_ACCU_SITE_SET_RECTANGULARITY_HH