SKLimits.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2008 - 2023 by Andrew Jameson and Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
#ifndef __dsp_Signal_Statistics_SKLimits_h
#define __dsp_Signal_Statistics_SKLimits_h
 
#include "dsp/PearsonIV.h"
#include "dsp/PearsonVI.h"
#include "ReferenceTo.h"
 
namespace dsp {
 
 
  class SKLimits {
 
  public:
 
    SKLimits (unsigned M, float std_devs);
 
    ~SKLimits ();
 
    void calc_limits ();
 
    double get_lower_threshold() const { return lower_threshold; }
 
    double get_upper_threshold() const { return upper_threshold; }
 
    double get_symmetric_threshold() const { return symmetric_threshold; }
 
    void set_M (unsigned M);
 
 
    void set_Nd (unsigned Nd);
 
    void set_std_devs (float std_devs);
 
 
    void set_fwer (float fwer);
 
 
    void set_ntest (unsigned ntest);
 
    dsp::ProbabilityDensity* get_pdf () { return pdf; }
 
    static PearsonIV::Parameters parametersIV (double M);
 
    static PearsonIV::Parameters parametersIV (double M, double Nd);
 
    static PearsonVI::Parameters parametersVI (double M, double Nd);
 
  private:
 
    void prepare();
 
    double lower_threshold = 0.0;
 
    double upper_threshold = 0.0;
 
    double symmetric_threshold = 0.0;
 
    unsigned M = 0;
 
    unsigned Nd = 1;
 
    double family_wise_error_rate = 0;
 
    double per_comparison_error_rate = 0;
 
    double per_comparison_std_devs = 0;
 
    unsigned ntest = 1;
 
    Reference::To<dsp::ProbabilityDensity> pdf;
  };
}
 
#endif