DGtal  0.9.2
TrueGlobalEstimatorOnPoints.ih
1 /**
2  * This program is free software: you can redistribute it and/or modify
3  * it under the terms of the GNU Lesser General Public License as
4  * published by the Free Software Foundation, either version 3 of the
5  * License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program. If not, see <http://www.gnu.org/licenses/>.
14  *
15  **/
16 
17 /**
18  * @file
19  * @author David Coeurjolly (\c david.coeurjolly@liris.cnrs.fr )
20  * Laboratoire d'InfoRmatique en Image et Systèmes d'information - LIRIS (CNRS, UMR 5205), CNRS, France
21  *
22  * @date 2011/06/27
23  *
24  * Implementation of inline methods defined in TrueGlobalEstimatorOnPoints.h.h
25  *
26  * This file is part of the DGtal library.
27  */
28 
29 
30 //////////////////////////////////////////////////////////////////////////////
31 #include <cstdlib>
32 //////////////////////////////////////////////////////////////////////////////
33 
34 ///////////////////////////////////////////////////////////////////////////////
35 // IMPLEMENTATION of inline methods.
36 ///////////////////////////////////////////////////////////////////////////////
37 
38 ///////////////////////////////////////////////////////////////////////////////
39 // ----------------------- Standard services ------------------------------
40 
41 
42 /**
43  * Constructor.
44  */
45 template <typename CIt, typename PShape, typename PShapeFunctor>
46 inline
47 DGtal::TrueGlobalEstimatorOnPoints<CIt,PShape,PShapeFunctor>::TrueGlobalEstimatorOnPoints(const double h,
48  const ConstIteratorOnPoints& itb,
49  const ConstIteratorOnPoints& ite,
50  PShape* aShape,
51  const bool& isClosed)
52 {
53  init(h,itb,ite,aShape,isClosed);
54 }
55 
56 /**
57  * Init.
58  */
59 template <typename CIt, typename PShape, typename PShapeFunctor>
60 inline
61 void
62 DGtal::TrueGlobalEstimatorOnPoints<CIt,PShape,PShapeFunctor>::init(const double h,
63  const ConstIteratorOnPoints& itb,
64  const ConstIteratorOnPoints& ite,
65  PShape* aShape,
66  const bool& isClosed)
67 {
68  myH = h;
69 
70  myBegin = itb;
71  myEnd = ite;
72 
73  myFlagIsClosed = isClosed;
74  myFlagIsInit = true;
75 
76  myFunctor = ParametricShapeFunctor(aShape);
77 
78 }
79 
80 /**
81  * @return the estimated quantity at *it
82  * from itb till ite
83  */
84 template <typename CIt, typename PShape, typename PShapeFunctor>
85 inline
86 typename DGtal::TrueGlobalEstimatorOnPoints<CIt,PShape,PShapeFunctor>::Quantity
87 DGtal::TrueGlobalEstimatorOnPoints<CIt,PShape,PShapeFunctor>::eval()
88 {
89  ASSERT(myH>0);
90  if (myFlagIsClosed) {
91  return myFunctor();
92  } else {
93  //get the first and last points
94  ConstIteratorOnPoints i = myBegin;
95  ConstIteratorOnPoints j(i); ++j;
96  for ( ; j != myEnd ; ++i, ++j) {}
97  //myH is the coordinates unit
98  RealPoint p( *myBegin );
99  p *= myH;
100  RealPoint p2( *i );
101  p2 *= myH;
102  return myFunctor(p,p2);
103  }
104 }
105 
106 
107 /**
108  * @return the estimated quantity at *it
109  */
110 template <typename CIt, typename PShape, typename PShapeFunctor>
111 inline
112 typename DGtal::TrueGlobalEstimatorOnPoints<CIt,PShape,PShapeFunctor>::Quantity
113 DGtal::TrueGlobalEstimatorOnPoints<CIt,PShape,PShapeFunctor>::eval(const ConstIteratorOnPoints& itb,
114  const ConstIteratorOnPoints& ite)
115 {
116  ASSERT(myH>0);
117  if (myFlagIsClosed) {
118  return myFunctor();
119  } else {
120  //get the first and last points
121  ConstIteratorOnPoints i = itb;
122  ConstIteratorOnPoints j(i); ++j;
123  for ( ; j != ite; ++i, ++j) {};
124  //myH is the coordinates unit
125  RealPoint p( *itb );
126  p *= myH;
127  RealPoint p2( *i );
128  p2 *= myH;
129  return myFunctor(p,p2);
130  }
131 }
132 
133 
134 /**
135  * Checks the validity/consistency of the object.
136  * @return 'true' if the object is valid, 'false' otherwise.
137  */
138 template <typename CIt, typename PShape, typename PShapeFunctor>
139 inline
140 bool
141 DGtal::TrueGlobalEstimatorOnPoints<CIt,PShape,PShapeFunctor>::isValid() const
142 {
143  return myFlagIsInit;
144 }
145 
146