vpStatisticalTestShewhart.h

/****************************************************************************
 *
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */
 
#ifndef _vpStatisticalTestShewhartTest_h_
#define _vpStatisticalTestShewhartTest_h_
 
#include <vector>
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpStatisticalTestSigma.h>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpStatisticalTestShewhart : public vpStatisticalTestSigma
{
public:
  typedef enum vpWecoRulesAlarm
  {
    THREE_SIGMA_WECO = 0, 
    TWO_SIGMA_WECO = 1, 
    ONE_SIGMA_WECO = 2, 
    SAME_SIDE_WECO = 3, 
    NONE_WECO = 4, 
    COUNT_WECO = 5 
  } vpWecoRulesAlarm;
 
  static std::string vpWecoRulesAlarmToString(const vpWecoRulesAlarm &alarm);
 
  static const bool CONST_ALL_WECO_ACTIVATED[COUNT_WECO - 1];
  static const unsigned int NB_DATA_SIGNAL = 8;
 
protected:
  unsigned int m_nbDataInBuffer; 
  float m_signal[NB_DATA_SIGNAL]; 
  bool m_activateWECOrules; 
  bool m_activatedWECOrules[COUNT_WECO - 1]; 
  unsigned int m_idCurrentData; 
  vpWecoRulesAlarm m_alarm; 
  float m_oneSigmaNegLim; 
  float m_oneSigmaPosLim; 
  float m_twoSigmaNegLim; 
  float m_twoSigmaPosLim; 
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  virtual void computeLimits() override;
#else
  virtual void computeLimits();
#endif
 
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  virtual vpMeanDriftType detectDownwardMeanDrift() override;
#else
  virtual vpMeanDriftType detectDownwardMeanDrift();
#endif
 
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  virtual vpMeanDriftType detectUpwardMeanDrift() override;
#else
  virtual vpMeanDriftType detectUpwardMeanDrift();
#endif
 
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  virtual bool updateStatistics(const float &signal) override;
#else
  virtual bool updateStatistics(const float &signal);
#endif
 
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  virtual void updateTestSignals(const float &signal) override;
#else
  virtual void updateTestSignals(const float &signal);
#endif
public:
  vpStatisticalTestShewhart(const bool &activateWECOrules = true, const bool activatedRules[COUNT_WECO - 1] = CONST_ALL_WECO_ACTIVATED, const unsigned int &nbSamplesForStats = 30);
 
  vpStatisticalTestShewhart(const bool &activateWECOrules, const bool activatedRules[COUNT_WECO - 1], const float &mean, const float &stdev);
 
  vpWecoRulesAlarm getAlarm() const
  {
    return m_alarm;
  }
 
#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  inline virtual float getSignal() const override
#else
  inline virtual float getSignal() const
#endif
  {
    return m_signal[m_idCurrentData];
  }
 
  std::vector<float> getSignals() const;
 
  void init(const bool &activateWECOrules, const bool activatedRules[COUNT_WECO - 1] = CONST_ALL_WECO_ACTIVATED, const unsigned int &nbSamplesForStats = 30);
 
  void init(const bool &activateWECOrules, const bool activatedRules[COUNT_WECO - 1], const float &mean, const float &stdev);
};
END_VISP_NAMESPACE
#endif