Visual Servoing Platform  version 3.6.1 under development (2024-05-08)
vpStatisticalTestSigma.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 _vpStatisticalTestSigma_h_
38 #define _vpStatisticalTestSigma_h_
39 
40 #include <visp3/core/vpConfig.h>
41 
42 #include <visp3/core/vpStatisticalTestAbstract.h>
43 
69 {
70 protected:
71  float m_h;
72  float m_s;
77  virtual void computeLimits();
78 
86 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
87  virtual vpMeanDriftType detectDownwardMeanDrift() override;
88 #else
90 #endif
91 
99 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
100  virtual vpMeanDriftType detectUpwardMeanDrift() override;
101 #else
103 #endif
104 
111 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
112  virtual bool updateStatistics(const float &signal) override;
113 #else
114  virtual bool updateStatistics(const float &signal);
115 #endif
116 
122 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
123  virtual void updateTestSignals(const float &signal) override;
124 #else
125  virtual void updateTestSignals(const float &signal);
126 #endif
127 public:
134  vpStatisticalTestSigma(const float &h = 3.f, const unsigned int &nbSamplesForStats = 30);
135 
143  vpStatisticalTestSigma(const float &h, const float &mean, const float &stdev);
144 
150  inline virtual float getSignal() const
151  {
152  return m_s;
153  }
154 
161  void init(const float &h = 3.f, const unsigned int &nbSamplesForStats = 30);
162 
170  void init(const float &h, const float &mean, const float &stdev);
171 };
172 
173 #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 a simple test comparing the current value to the standard deviation of the signal.
virtual float getSignal() const
Get the last value of the signal.