Visual Servoing Platform  version 3.6.1 under development (2024-05-08)
vpStatisticalTestEWMA.h
1 /****************************************************************************
2  *
3  * ViSP, open source Visual Servoing Platform software.
4  * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * See the file LICENSE.txt at the root directory of this source
11  * distribution for additional information about the GNU GPL.
12  *
13  * For using ViSP with software that can not be combined with the GNU
14  * GPL, please contact Inria about acquiring a ViSP Professional
15  * Edition License.
16  *
17  * See https://visp.inria.fr for more information.
18  *
19  * This software was developed at:
20  * Inria Rennes - Bretagne Atlantique
21  * Campus Universitaire de Beaulieu
22  * 35042 Rennes Cedex
23  * France
24  *
25  * If you have questions regarding the use of this file, please contact
26  * Inria at visp@inria.fr
27  *
28  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30  */
31 
37 #ifndef _vpStatisticalTestEWMA_h_
38 #define _vpStatisticalTestEWMA_h_
39 
40 #include <visp3/core/vpConfig.h>
41 
42 #include <visp3/core/vpStatisticalTestAbstract.h>
43 
71 {
72 protected:
73  float m_alpha;
74  float m_wt;
75  float m_wtprev;
80  virtual void computeDeltaAndLimits();
81 
89 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
90  virtual vpMeanDriftType detectDownwardMeanDrift() override;
91 #else
93 #endif
94 
102 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
103  virtual vpMeanDriftType detectUpwardMeanDrift() override;
104 #else
106 #endif
107 
114 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
115  virtual bool updateStatistics(const float &signal) override;
116 #else
117  virtual bool updateStatistics(const float &signal);
118 #endif
119 
125 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
126  virtual void updateTestSignals(const float &signal) override;
127 #else
128  virtual void updateTestSignals(const float &signal);
129 #endif
130 
131 public:
137  vpStatisticalTestEWMA(const float &alpha = 0.1f);
138 
144  inline float getAlpha() const
145  {
146  return m_alpha;
147  }
148 
154  inline float getWt() const
155  {
156  return m_wt;
157  }
158 
164  void init(const float &alpha);
165 
173  void init(const float &alpha, const float &mean, const float &stdev);
174 
180  void setAlpha(const float &alpha);
181 };
182 #endif
Base class for methods detecting the drift of the mean of a process.
vpMeanDriftType
Enum that indicates if a drift of the mean occurred.
virtual vpMeanDriftType detectUpwardMeanDrift()=0
Detects if a upward mean drift occurred.
void init()
(Re)Initialize the algorithm.
virtual bool updateStatistics(const float &signal)
Update m_s and if enough values are available, compute the mean, the standard deviation and the limit...
virtual void updateTestSignals(const float &signal)=0
Update the test signals.
virtual vpMeanDriftType detectDownwardMeanDrift()=0
Detects if a downward mean drift occurred.
Class that permits to perform Exponentially Weighted Moving Average mean drft tests.
float getWt() const
Get the current value of the test signal.
float getAlpha() const
Get the forgetting factor of the algorithm.