QTest.h

Go to the documentation of this file.

#ifndef DQMSERVICES_CORE_Q_CRITERION_H
# define DQMSERVICES_CORE_Q_CRITERION_H

# include "DQMServices/Core/interface/MonitorElement.h"
# include "TProfile2D.h"
# include "TProfile.h"
# include "TH2F.h"
# include "TH1F.h"
# include <sstream>
# include <string>
# include <map>

//#include "DQMServices/Core/interface/DQMStore.h"

class Comp2RefChi2;         typedef Comp2RefChi2 Comp2RefChi2ROOT;
class Comp2RefKolmogorov;       typedef Comp2RefKolmogorov Comp2RefKolmogorovROOT;
class Comp2RefEqualH;           typedef Comp2RefEqualH Comp2RefEqualHROOT;
class ContentsXRange;           typedef ContentsXRange ContentsXRangeROOT;
class ContentsYRange;           typedef ContentsYRange ContentsYRangeROOT;
class NoisyChannel;         typedef NoisyChannel NoisyChannelROOT;
class DeadChannel;          typedef DeadChannel DeadChannelROOT;
class ContentsWithinExpected;       typedef ContentsWithinExpected ContentsWithinExpectedROOT;
class MeanWithinExpected;       typedef MeanWithinExpected MeanWithinExpectedROOT;
//class AllContentWithinFixedRange; typedef AllContentWithinFixedRange RuleAllContentWithinFixedRange; typedef AllContentWithinFixedRange AllContentWithinFixedRangeROOT;
//class AllContentWithinFloatingRange;  typedef AllContentWithinFloatingRange RuleAllContentWithinFloatingRange;    typedef AllContentWithinFloatingRange AllContentWithinFloatingRangeROOT;
class FlatOccupancy1d;          typedef FlatOccupancy1d RuleFlatOccupancy1d; typedef FlatOccupancy1d FlatOccupancy1dROOT;
class FixedFlatOccupancy1d;     typedef FixedFlatOccupancy1d RuleFixedFlatOccupancy1d; typedef FixedFlatOccupancy1d FixedFlatOccupancy1dROOT;
class CSC01;                typedef CSC01 RuleCSC01; typedef CSC01 CSC01ROOT;
class AllContentAlongDiagonal;      typedef AllContentAlongDiagonal RuleAllContentAlongDiagonal; typedef AllContentAlongDiagonal AllContentAlongDiagonalROOT;
class CompareToMedian;                  typedef CompareToMedian CompareToMedianROOT;
class CompareLastFilledBin;             typedef CompareLastFilledBin CompareLastFilledBinROOT;

class QCriterion
{

public:

  int getStatus(void) const             { return status_; }
  std::string getMessage(void) const    { return message_; }
  std::string getName(void) const       { return qtname_; }
  std::string algoName(void) const      { return algoName_; }
  void setWarningProb(float prob)       { warningProb_ = prob; }
  void setErrorProb(float prob)         { errorProb_ = prob; }
  virtual std::vector<DQMChannel> getBadChannels(void) const
                                        { return std::vector<DQMChannel>(); }

protected:
  QCriterion(std::string qtname)        { qtname_ = qtname; init(); }
  void init(void);

  virtual ~QCriterion(void)             {}

  virtual float runTest(const MonitorElement *me);
  void setAlgoName(std::string name)    { algoName_ = name; }

  float runTest(const MonitorElement *me, QReport &qr, DQMNet::QValue &qv)   {
      assert(qr.qcriterion_ == this);
      assert(qv.qtname == qtname_);

      prob_ = runTest(me); // this runTest goes to SimpleTest derivates

      if (prob_ < errorProb_) status_ = dqm::qstatus::ERROR;
      else if (prob_ < warningProb_) status_ = dqm::qstatus::WARNING;
      else status_ = dqm::qstatus::STATUS_OK;

      setMessage(); // this goes to SimpleTest derivates
     
      if (verbose_==2) std::cout << " Message = " << message_ << std::endl;
      if (verbose_==2) std::cout << " Name = " << qtname_ << 
              " / Algorithm = " << algoName_ << 
          " / Status = " << status_ << 
              " / Prob = " << prob_ << std::endl;

      qv.code = status_;
      qv.message = message_;
      qv.qtname = qtname_;
      qv.algorithm = algoName_;
      qv.qtresult = prob_;
      qr.badChannels_ = getBadChannels();

      return prob_;
    }

  virtual void setMessage(void) = 0;

  std::string qtname_;  
  std::string algoName_;  
  float prob_;
  int status_;  
  std::string message_;  
  float warningProb_, errorProb_;  
  void setVerbose(int verbose)          { verbose_ = verbose; }
  int verbose_;  

private:
  static const float WARNING_PROB_THRESHOLD;
  static const float ERROR_PROB_THRESHOLD;

  friend class DQMStore;
  friend class MonitorElement;
};


class SimpleTest : public QCriterion
{
public:
  SimpleTest(const std::string &name, bool keepBadChannels = false) : QCriterion(name),
  minEntries_ (0),
  keepBadChannels_ (keepBadChannels) 
  {}

  void setMinimumEntries(unsigned n) { minEntries_ = n; }
  virtual std::vector<DQMChannel> getBadChannels(void) const
  { 
    return keepBadChannels_ ? badChannels_ : QCriterion::getBadChannels(); 
  }

protected:

  virtual void setMessage(void) 
  {
    message_.clear();
  }

  unsigned minEntries_;  //< minimum # of entries needed
  std::vector<DQMChannel> badChannels_;
  bool keepBadChannels_;
 };


//===============================================================//
//========= Classes for particular QUALITY TESTS ================//
//===============================================================//

//===================== Comp2RefEqualH ===================//
//== Algorithm for comparing equality of histograms ==//
class Comp2RefEqualH : public SimpleTest
{
public:
  Comp2RefEqualH(const std::string &name) : SimpleTest(name,true)
  { 
    setAlgoName( getAlgoName() ); 
  }
  static std::string getAlgoName(void) { return "Comp2RefEqualH"; }
  float runTest(const MonitorElement*me);
};

//===================== Comp2RefChi2 ===================//
// comparison to reference using the  chi^2 algorithm
class Comp2RefChi2 : public SimpleTest
{
public:
  Comp2RefChi2(const std::string &name) :SimpleTest(name)
  { 
    setAlgoName(getAlgoName()); 
  }
  static std::string getAlgoName(void) { return "Comp2RefChi2"; }
  float runTest(const MonitorElement*me);
  
protected:

  void setMessage(void) 
  {
    std::ostringstream message;
    message << "chi2/Ndof = " << chi2_ << "/" << Ndof_
        << ", minimum needed statistics = " << minEntries_
        << " warning threshold = " << this->warningProb_
        << " error threshold = " << this->errorProb_;
    message_ = message.str();
  }

  // # of degrees of freedom and chi^2 for test
  int Ndof_; double chi2_;
};

//===================== Comp2RefKolmogorov ===================//
class Comp2RefKolmogorov : public SimpleTest
{
public:
  Comp2RefKolmogorov(const std::string &name) : SimpleTest(name)
  { 
    setAlgoName(getAlgoName()); 
  }
  static std::string getAlgoName(void) { return "Comp2RefKolmogorov"; }

  float runTest(const MonitorElement *me);
};

//==================== ContentsXRange =========================//
//== Check that histogram contents are between [Xmin, Xmax] ==//
class ContentsXRange : public SimpleTest
{
public:
  ContentsXRange(const std::string &name) : SimpleTest(name)
  {
    rangeInitialized_ = false;
    setAlgoName(getAlgoName());
  }
  static std::string getAlgoName(void) { return "ContentsXRange"; }
  float runTest(const MonitorElement *me) ;

  virtual void setAllowedXRange(double xmin, double xmax)
  { 
    xmin_ = xmin; xmax_ = xmax; 
    rangeInitialized_ = true; 
  }

protected: 
  double xmin_;double xmax_;
  bool rangeInitialized_;
};

//==================== ContentsYRange =========================//
//== Check that histogram contents are between [Ymin, Ymax] ==//
class ContentsYRange : public SimpleTest
{
public:
  ContentsYRange(const std::string &name) : SimpleTest(name,true)
  {
   rangeInitialized_ = false;
   setAlgoName(getAlgoName());
  }
  static std::string getAlgoName(void) { return "ContentsYRange"; }
  float runTest(const MonitorElement *me);

  void setUseEmptyBins(unsigned int useEmptyBins) { useEmptyBins_ = useEmptyBins; }
  virtual void setAllowedYRange(double ymin, double ymax)
  { 
    ymin_ = ymin; ymax_ = ymax; 
    rangeInitialized_ = true; 
  }

protected:
  double ymin_; double ymax_;
  bool rangeInitialized_;
  unsigned int useEmptyBins_;

};

//============================== DeadChannel =================================//
class DeadChannel : public SimpleTest
{
public:
  DeadChannel(const std::string &name) : SimpleTest(name,true)
  {
   rangeInitialized_ = false;
   setAlgoName(getAlgoName());
  }
  static std::string getAlgoName(void) { return "DeadChannel"; }
  float runTest(const MonitorElement *me);

  void setThreshold(double ymin)
  { 
    ymin_ = ymin;  
    rangeInitialized_ = true; 
  } 

protected:
  double ymin_;
  bool rangeInitialized_;
};


//==================== NoisyChannel =========================//
class NoisyChannel : public SimpleTest
{
public:
  NoisyChannel(const std::string &name) : SimpleTest(name,true)
  {
    rangeInitialized_ = false;
    numNeighbors_ = 1;
    setAlgoName(getAlgoName());
  }
  static std::string getAlgoName(void) { return "NoisyChannel"; }
  float runTest(const MonitorElement*me);

  void setNumNeighbors(unsigned n) { if (n > 0) numNeighbors_ = n; }

  void setTolerance(float percentage)
  {
    if (percentage >=0)
    {
      tolerance_ = percentage;
      rangeInitialized_ = true;
    }
  }

protected:
  double getAverage(int bin, const TH1 *h) const;

  float tolerance_;        /*< tolerance for considering a channel noisy */
  unsigned numNeighbors_;  /*< # of neighboring channels for calculating average to be used
                 for comparison with channel under consideration */
  bool rangeInitialized_;  /*< init-flag for tolerance */
};

//==================== ContentsWithinExpected  =========================//
// Check that every TH2 channel has mean, RMS within allowed range.
class ContentsWithinExpected : public SimpleTest
{
public:
  ContentsWithinExpected(const std::string &name) : SimpleTest(name,true)
  {
    checkMean_ = checkRMS_ = false;
    minMean_ = maxMean_ = minRMS_ = maxRMS_ = 0.0;
    checkMeanTolerance_ = false;
    toleranceMean_ = -1.0;
    setAlgoName(getAlgoName());
  }
  static std::string getAlgoName(void) { return "ContentsWithinExpected"; }
  float runTest(const MonitorElement *me);

  void setUseEmptyBins(unsigned int useEmptyBins) { 
    useEmptyBins_ = useEmptyBins; 
  }
  void setMeanRange(double xmin, double xmax);
  void setRMSRange(double xmin, double xmax);

  void setMeanTolerance(float fracTolerance)
  {
    if (fracTolerance >= 0.0)
    {
      toleranceMean_ = fracTolerance;
      checkMeanTolerance_ = true;
    }
  }

protected:
  bool checkMean_;      //< if true, check the mean value
  bool checkRMS_;           //< if true, check the RMS value
  bool checkMeanTolerance_; //< if true, check mean tolerance
  float toleranceMean_;     //< fractional tolerance on mean (use only if checkMeanTolerance_ = true)
  float minMean_, maxMean_; //< allowed range for mean (use only if checkMean_ = true)
  float minRMS_, maxRMS_;   //< allowed range for mean (use only if checkRMS_ = true)
  unsigned int useEmptyBins_;

};

//==================== MeanWithinExpected  =========================//
class MeanWithinExpected : public SimpleTest
{
public:
  MeanWithinExpected(const std::string &name) : SimpleTest(name)
  {
    setAlgoName(getAlgoName());
  }
  static std::string getAlgoName(void) { return "MeanWithinExpected"; }
  float runTest(const MonitorElement*me);

  void setExpectedMean(double mean) { expMean_ = mean; }
  void useRange(double xmin, double xmax);
  void useSigma(double expectedSigma);
  void useRMS(void) ;

protected:
  bool useRMS_;       //< if true, will use RMS of distribution
  bool useSigma_;     //< if true, will use expected_sigma
  bool useRange_;     //< if true, will use allowed range
  double sigma_;       //< sigma to be used in probability calculation (use only if useSigma_ = true)
  double expMean_;     //< expected mean value (used only if useSigma_ = true or useRMS_ = true)
  double xmin_, xmax_; //< allowed range for mean (use only if useRange_ = true)

};

//==================== AllContentWithinFixedRange   =========================//
/*class AllContentWithinFixedRange : public SimpleTest
{
public:
  AllContentWithinFixedRange(const std::string &name) : SimpleTest(name)
  { 
    setAlgoName(getAlgoName()); 
  }
  static std::string getAlgoName(void) { return "RuleAllContentWithinFixedRange"; }
  float runTest(const MonitorElement *me);

  void set_x_min(double x)             { x_min  = x; }
  void set_x_max(double x)             { x_max  = x; }
  void set_epsilon_max(double epsilon) { epsilon_max = epsilon; }
  void set_S_fail(double S)        { S_fail = S; }
  void set_S_pass(double S)        { S_pass = S; }
  double get_epsilon_obs(void)         { return epsilon_obs; }
  double get_S_fail_obs(void)          { return S_fail_obs;  }
  double get_S_pass_obs(void)          { return S_pass_obs;  }
  int get_result(void)             { return result; }

protected:
  TH1F *histogram ; //define Test histo
  double x_min, x_max;
  double epsilon_max;
  double S_fail, S_pass;
  double epsilon_obs;
  double S_fail_obs, S_pass_obs;
  int result;
};
*/
//==================== AllContentWithinFloatingRange  =========================//
/*class AllContentWithinFloatingRange : public SimpleTest
{
public:
  AllContentWithinFloatingRange(const std::string &name) : SimpleTest(name)
  { 
    setAlgoName(getAlgoName()); 
  }
  static std::string getAlgoName(void) { return "RuleAllContentWithinFloatingRange"; }

  void set_Nrange(int N)               { Nrange = N; }
  void set_epsilon_max(double epsilon) { epsilon_max = epsilon; }
  void set_S_fail(double S)        { S_fail = S; }
  void set_S_pass(double S)        { S_pass = S; }
  double get_epsilon_obs(void)         { return epsilon_obs; }
  double get_S_fail_obs(void)          { return S_fail_obs;  }
  double get_S_pass_obs(void)          { return S_pass_obs;  }
  int get_result(void)             { return result; }

  float runTest(const MonitorElement *me );

protected:
  TH1F *histogram ; //define Test histo
  int Nrange;
  double epsilon_max;
  double S_fail, S_pass;
  double epsilon_obs;
  double S_fail_obs, S_pass_obs;
  int result;
};*/

//==================== FlatOccupancy1d   =========================//
#if 0 // FIXME: need to know what parameters to set before runTest!
class FlatOccupancy1d : public SimpleTest
{
public:
  FlatOccupancy1d(const std::string &name) : SimpleTest(name)
  {
    Nbins = 0;
    FailedBins[0] = 0;
    FailedBins[1] = 0;
    setAlgoName(getAlgoName());
  }

  ~FlatOccupancy1d(void)
  {
    delete [] FailedBins[0];
    delete [] FailedBins[1];
  }

  static std::string getAlgoName(void) { return "RuleFlatOccupancy1d"; }

  void set_ExclusionMask(double *mask) { ExclusionMask = mask; }
  void set_epsilon_min(double epsilon) { epsilon_min = epsilon; }
  void set_epsilon_max(double epsilon) { epsilon_max = epsilon; }
  void set_S_fail(double S)            { S_fail = S; }
  void set_S_pass(double S)            { S_pass = S; }
  double get_FailedBins(void)          { return *FailedBins[1]; } // FIXME: WRONG! OFF BY ONE!?
  int get_result()                     { return result; }

  float runTest(const MonitorElement*me);

protected:
  double *ExclusionMask;
  double epsilon_min, epsilon_max;
  double S_fail, S_pass;
  double *FailedBins[2];
  int    Nbins;
  int    result;
};
#endif

//==================== FixedFlatOccupancy1d   =========================//
class FixedFlatOccupancy1d : public SimpleTest
{
public:
  FixedFlatOccupancy1d(const std::string &name) : SimpleTest(name)
  {
    Nbins = 0;
    FailedBins[0] = 0;
    FailedBins[1] = 0;
    setAlgoName(getAlgoName());
  }

  ~FixedFlatOccupancy1d(void)
  {
    if( Nbins > 0 )
    {
      delete [] FailedBins[0];
      delete [] FailedBins[1];
    }
  }

  static std::string getAlgoName(void) { return "RuleFixedFlatOccupancy1d"; }

  void set_Occupancy(double level)     { b = level; }
  void set_ExclusionMask(double *mask) { ExclusionMask = mask; }
  void set_epsilon_min(double epsilon) { epsilon_min = epsilon; }
  void set_epsilon_max(double epsilon) { epsilon_max = epsilon; }
  void set_S_fail(double S)            { S_fail = S; }
  void set_S_pass(double S)            { S_pass = S; }
  double get_FailedBins(void)          { return *FailedBins[1]; } // FIXME: WRONG! OFF BY ONE!?
  int get_result()                     { return result; }

  float runTest(const MonitorElement*me);

protected:
  double b;
  double *ExclusionMask;
  double epsilon_min, epsilon_max;
  double S_fail, S_pass;
  double *FailedBins[2];
  int    Nbins;
  int    result;
};

//==================== CSC01   =========================//
class CSC01 : public SimpleTest
{
public:
  CSC01(const std::string &name) : SimpleTest(name)
  { 
    setAlgoName(getAlgoName()); 
  }
  static std::string getAlgoName(void) { return "RuleCSC01"; }

  void set_epsilon_max(double epsilon) { epsilon_max = epsilon; }
  void set_S_fail(double S)        { S_fail = S; }
  void set_S_pass(double S)        { S_pass = S; }
  double get_epsilon_obs()         { return epsilon_obs; }
  double get_S_fail_obs()          { return S_fail_obs;  }
  double get_S_pass_obs()          { return S_pass_obs;  }
  int get_result()             { return result; }

  float runTest(const MonitorElement*me);

protected:
  double epsilon_max;
  double S_fail, S_pass;
  double epsilon_obs;
  double S_fail_obs, S_pass_obs;
  int result;
};

//======================== CompareToMedian ====================//
class CompareToMedian : public SimpleTest
{
public:
  //Initialize for TProfile, colRings
  CompareToMedian(const std::string &name) : SimpleTest(name,true){
    this->_min = 0.2;
    this->_max = 3.0;
    this->_emptyBins = 0;
    this->_maxMed = 10;
    this->_minMed = 0;
    this->nBins = 0;
    this->_statCut = 0;
    reset();
    setAlgoName( getAlgoName() );
  };

  ~CompareToMedian(){};

  static std::string getAlgoName(void) { return "CompareToMedian"; }

  float runTest(const MonitorElement *me);
  void setMin(float min){_min = min;};
  void setMax(float max){_max = max;};
  void setEmptyBins(int eB){eB > 0 ? _emptyBins = 1 : _emptyBins = 0;};
  void setMaxMedian(float max){_maxMed = max;};
  void setMinMedian(float min){_minMed = min;};
  void setStatCut(float cut){_statCut = (cut > 0) ? cut : 0;};

protected :
  void setMessage(void){
    std::ostringstream message;
    message << "Test " << qtname_ << " (" << algoName_
            << "): Entry fraction within range = " << prob_;
    message_ = message.str();
  }

private :
  float _min, _max;      //Test values
  int _emptyBins;        //use empty bins
  float _maxMed,_minMed; //Global max for median&mean
  float _statCut;        //Minimal number of non zero entries needed for the quality test 

  int nBinsX, nBinsY; //Dimensions of hystogram

  int nBins; //Number of (non empty) bins

  //Vector contain bin values
  std::vector<float> binValues;

  void reset(){binValues.clear();};

};
//======================== CompareLastFilledBin ====================//
class CompareLastFilledBin : public SimpleTest
{
public:
  //Initialize for TProfile, colRings
  CompareLastFilledBin(const std::string &name) : SimpleTest(name,true){
    this->_min = 0.0;
    this->_max = 1.0;
    this->_average = 0.0;
    setAlgoName( getAlgoName() );
  };

  ~CompareLastFilledBin(){};

  static std::string getAlgoName(void) { return "CompareLastFilledBin"; }

  float runTest(const MonitorElement *me);
  void setAverage(float average){_average = average;};
  void setMin(float min){_min = min;};
  void setMax(float max){_max = max;};


protected :
  void setMessage(void){
    std::ostringstream message;
    message << "Test " << qtname_ << " (" << algoName_
            << "): Last Bin filled with desired value = " << prob_;
    message_ = message.str();
  }

private :
  float _min, _max;      //Test values
  float _average;
};

//==================== AllContentAlongDiagonal   =========================//
#if 0 // FIXME: need to know what parameters to set before runTest!
class AllContentAlongDiagonal : public SimpleTest

public:
  AllContentAlongDiagonal(const std::string &name) : SimpleTest(name)
  { 
    setAlgoName(getAlgoName()); 
  }
  static std::string getAlgoName(void) { return "RuleAllContentAlongDiagonal"; }

  void set_epsilon_max(double epsilon) { epsilon_max = epsilon; }
  void set_S_fail(double S)        { S_fail = S; }
  void set_S_pass(double S)        { S_pass = S; } 
  double get_epsilon_obs()         { return epsilon_obs; }
  double get_S_fail_obs()          { return S_fail_obs;  }
  double get_S_pass_obs()          { return S_pass_obs;  }
  int get_result()             { return result; }

  //public:
  //using SimpleTest::runTest;
  float runTest(const MonitorElement*me); 

protected:
  double epsilon_max;
  double S_fail, S_pass;
  double epsilon_obs;
  double S_fail_obs, S_pass_obs;
  int result;
};
#endif

#endif // DQMSERVICES_CORE_Q_CRITERION_H