vpStatisticalTestMeanAdjustedCUSUM.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 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 VP_STATISTICAL_TEST_MEAN_ADJUSTED_CUSUM_H
#define VP_STATISTICAL_TEST_MEAN_ADJUSTED_CUSUM_H
 
#include <visp3/core/vpConfig.h>
 
#include <visp3/core/vpStatisticalTestAbstract.h>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpStatisticalTestMeanAdjustedCUSUM : public vpStatisticalTestAbstract
{
protected:
  float m_delta; 
  float m_h; 
  float m_half_delta; 
  float m_k; 
  float m_sminus; 
  float m_splus; 

  virtual void computeDeltaAndLimits();

  virtual vpMeanDriftType detectDownwardMeanDrift() VP_OVERRIDE;

  virtual vpMeanDriftType detectUpwardMeanDrift() VP_OVERRIDE;

  virtual bool updateStatistics(const float &signal) VP_OVERRIDE;

  virtual void updateTestSignals(const float &signal) VP_OVERRIDE;
 
public:
  vpStatisticalTestMeanAdjustedCUSUM(const float &h = 4.f, const float &k = 1.f, const unsigned int &nbPtsForStats = 30);

  inline float getDelta() const
  {
    return m_delta;
  }

  inline float getH() const
  {
    return m_h;
  }

  inline float getK() const
  {
    return m_k;
  }

  inline float getTestSignalMinus() const
  {
    return m_sminus;
  }

  inline float getTestSignalPlus() const
  {
    return m_splus;
  }

  void init(const float &h, const float &k, const unsigned int &nbPtsForStats);

  void init(const float &delta, const float &limitDown, const float &limitUp, const unsigned int &nbPtsForStats);

  void init(const float &h, const float &k, const float &mean, const float &stdev);

  void init(const float &delta, const float &limitDown, const float &limitUp, const float &mean, const float &stdev);

  inline void setDelta(const float &delta)
  {
    m_delta = delta;
    m_half_delta = 0.5f * delta;
  }

  inline void setLimits(const float &limitDown, const float &limitUp)
  {
    m_limitDown = limitDown;
    m_limitUp = limitUp;
  }
};
END_VISP_NAMESPACE
#endif