Visual Servoing Platform  version 3.6.1 under development (2024-05-08)
vpStatisticalTestHinkley.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 _vpStatisticalTestHinkley_h_
38 #define _vpStatisticalTestHinkley_h_
39 
40 #include <visp3/core/vpConfig.h>
41 
42 #include <visp3/core/vpStatisticalTestAbstract.h>
43 
88 {
89 protected:
90  float m_dmin2;
91  float m_alpha;
92  float m_Sk;
93  float m_Mk;
94  float m_Tk;
95  float m_Nk;
98  float m_h;
99  float m_k;
104  virtual void computeAlphaDelta();
105 
112  void computeMean(double signal);
113 
119  void computeSk(double signal);
120 
124  void computeMk();
125 
131  void computeTk(double signal);
132 
136  void computeNk();
137 
143 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
144  virtual vpMeanDriftType detectDownwardMeanDrift() override;
145 #else
147 #endif
148 
156 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
157  virtual vpMeanDriftType detectUpwardMeanDrift() override;
158 #else
160 #endif
161 
168 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
169  virtual bool updateStatistics(const float &signal) override;
170 #else
171  virtual bool updateStatistics(const float &signal);
172 #endif
173 
179 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
180  virtual void updateTestSignals(const float &signal) override;
181 #else
182  virtual void updateTestSignals(const float &signal);
183 #endif
184 public:
194 
205  vpStatisticalTestHinkley(const float &alpha, const float &delta, const unsigned int &nbSamplesForInit = 30);
206 
216  vpStatisticalTestHinkley(const float &h, const float &k, const bool &computeAlphaDeltaFromStdev, const unsigned int &nbSamplesForInit = 30);
217 
227  vpStatisticalTestHinkley(const float &h, const float &k, const float &mean, const float &stdev);
228 
232  virtual ~vpStatisticalTestHinkley();
233 
239  inline float getAlpha() const { return m_alpha; }
240 
246  inline float getSk() const { return m_Sk; }
247 
253  inline float getMk() const { return m_Mk; }
254 
261  inline float getTk() const { return m_Tk; }
262 
268  inline float getNk() const { return m_Nk; }
269 
274  void init();
275 
284  void init(const float &alpha, const float &delta, const unsigned int &nbSamplesForInit);
285 
295  void init(const float &h, const float &k, const bool &computeAlphaDeltaFromStdev, const unsigned int &nbSamplesForInit);
296 
305  void init(const float &alpha, const float &delta, const float &mean);
306 
316  void init(const float &h, const float &k, const float &mean, const float &stdev);
317 
323  void setDelta(const float &delta);
324 
330  void setAlpha(const float &alpha);
331 };
332 
333 #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.
This class implements the Hinkley's cumulative sum test.
float getAlpha() const
Get the threshold indicating that a mean drift occurs.
float getNk() const
Get the minimum of the test signal for upward mean drift .
float getTk() const
Get the test signal for upward mean drift..
float getSk() const
Get the test signal for downward mean drift.
float getMk() const
Get the maximum of the test signal for downward mean drift .