Visual Servoing Platform  version 3.6.1 under development (2025-02-01)
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 
44 BEGIN_VISP_NAMESPACE
70 {
71 protected:
72  float m_h;
73  float m_s;
78  virtual void computeLimits();
79 
87 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
88  virtual vpMeanDriftType detectDownwardMeanDrift() override;
89 #else
91 #endif
92 
100 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
101  virtual vpMeanDriftType detectUpwardMeanDrift() override;
102 #else
104 #endif
105 
112 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
113  virtual bool updateStatistics(const float &signal) override;
114 #else
115  virtual bool updateStatistics(const float &signal);
116 #endif
117 
123 #if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
124  virtual void updateTestSignals(const float &signal) override;
125 #else
126  virtual void updateTestSignals(const float &signal);
127 #endif
128 public:
135  vpStatisticalTestSigma(const float &h = 3.f, const unsigned int &nbSamplesForStats = 30);
136 
144  vpStatisticalTestSigma(const float &h, const float &mean, const float &stdev);
145 
151  inline virtual float getSignal() const
152  {
153  return m_s;
154  }
155 
162  void init(const float &h = 3.f, const unsigned int &nbSamplesForStats = 30);
163 
171  void init(const float &h, const float &mean, const float &stdev);
172 };
173 END_VISP_NAMESPACE
174 #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.