vpStatisticalTestHinkley.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_HINKLEY_H
#define VP_STATISTICAL_TEST_HINKLEY_H
 
#include <visp3/core/vpConfig.h>
 
#include <visp3/core/vpStatisticalTestAbstract.h>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpStatisticalTestHinkley : public vpStatisticalTestAbstract
{
protected:
  float m_dmin2; 
  float m_alpha; 
  float m_Sk; 
  float m_Mk; 
  float m_Tk; 
  float m_Nk; 
  bool m_computeDeltaAndAlpha; 
  float m_h; 
  float m_k; 

  virtual void computeAlphaDelta();

  void computeMean(double signal);

  void computeSk(double signal);

  void computeMk();

  void computeTk(double signal);

  void computeNk();

  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:
  vpStatisticalTestHinkley();

  vpStatisticalTestHinkley(const float &alpha, const float &delta, const unsigned int &nbSamplesForInit = 30);

  vpStatisticalTestHinkley(const float &h, const float &k, const bool &computeAlphaDeltaFromStdev, const unsigned int &nbSamplesForInit = 30);

  vpStatisticalTestHinkley(const float &h, const float &k, const float &mean, const float &stdev);

  inline float getAlpha() const { return m_alpha; }

  inline float getSk() const { return m_Sk; }

  inline float getMk() const { return m_Mk; }

  inline float getTk() const { return m_Tk; }

  inline float getNk() const { return m_Nk; }

  void init();

  void init(const float &alpha, const float &delta, const unsigned int &nbSamplesForInit);

  void init(const float &h, const float &k, const bool &computeAlphaDeltaFromStdev, const unsigned int &nbSamplesForInit);

  void init(const float &alpha, const float &delta, const float &mean);

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

  void setDelta(const float &delta);

  void setAlpha(const float &alpha);
};
END_VISP_NAMESPACE
#endif