MeanWithinExpected Class Reference

Algorithm for testing if histogram's mean value is near expected value. More...

#include <QTest.h>

Inheritance diagram for MeanWithinExpected:

Public Member Functions
	MeanWithinExpected (const std::string &name)
float	runTest (const MonitorElement *me) override
void	setExpectedMean (double mean)
void	useRange (double xmin, double xmax)
void	useRMS ()
void	useSigma (double expectedSigma)
Public Member Functions inherited from SimpleTest
std::vector< DQMChannel >	getBadChannels () const override
	get vector of channels that failed test (not always relevant!) More...
void	setMinimumEntries (unsigned n)
	set minimum # of entries needed More...
	SimpleTest (const std::string &name, bool keepBadChannels=false)
Public Member Functions inherited from QCriterion
std::string	algoName () const
	get algorithm name More...
std::string	getMessage () const
	get message attached to test More...
std::string	getName () const
	get name of quality test More...
int	getStatus () const
	get test status More...
void	init ()
	initialize values More...
	QCriterion (std::string qtname)
float	runTest (const MonitorElement *me, QReport &qr, DQMNet::QValue &qv)
void	setErrorProb (float prob)
void	setWarningProb (float prob)
	set probability limit for warning and error (default: 90% and 50%) More...
virtual	~QCriterion ()=default

Static Public Member Functions
static std::string	getAlgoName ()

Protected Attributes
double	expMean_
double	sigma_
bool	useRange_
bool	useRMS_
bool	useSigma_
double	xmax_
double	xmin_
Protected Attributes inherited from SimpleTest
std::vector< DQMChannel >	badChannels_
bool	keepBadChannels_
unsigned	minEntries_
Protected Attributes inherited from QCriterion
std::string	algoName_
	name of quality test More...
float	errorProb_
std::string	message_
	quality test status More...
float	prob_
	name of algorithm More...
std::string	qtname_
int	status_
int	verbose_
float	warningProb_
	message attached to test More...

Additional Inherited Members
Public Types inherited from QCriterion
typedef dqm::legacy::MonitorElement	MonitorElement
	(class should be created by DQMStore class) More...
Static Public Attributes inherited from QCriterion
static const float	ERROR_PROB_THRESHOLD = 0.50
static const float	WARNING_PROB_THRESHOLD = 0.90
	default "probability" values for setting warnings & errors when running tests More...
Protected Member Functions inherited from SimpleTest
void	setMessage () override
	set status & message after test has run More...
Protected Member Functions inherited from QCriterion
void	setAlgoName (std::string name)
	set algorithm name More...
void	setVerbose (int verbose)
	probability limits for warnings, errors More...

Detailed Description

Algorithm for testing if histogram's mean value is near expected value.

Definition at line 401 of file QTest.h.

Constructor & Destructor Documentation

MeanWithinExpected::MeanWithinExpected ( const std::string &  name )

inline

Definition at line 403 of file QTest.h.

References getAlgoName(), and QCriterion::setAlgoName().

: SimpleTest(name) { setAlgoName(getAlgoName()); }

Member Function Documentation

static std::string MeanWithinExpected::getAlgoName ( )

inlinestatic

Definition at line 404 of file QTest.h.

Referenced by QualityTester::makeQCriterion(), and MeanWithinExpected().

{ return "MeanWithinExpected"; }

float MeanWithinExpected::runTest ( const MonitorElement *  me )

overridevirtual

Reimplemented from QCriterion.

Definition at line 1081 of file QTest.cc.

References gather_cfg::cout, dqm::impl::MonitorElement::getEntries(), dqm::impl::MonitorElement::getFullname(), dqm::legacy::MonitorElement::getRootObject(), dqm::legacy::MonitorElement::getTH1D(), dqm::legacy::MonitorElement::getTH1F(), dqm::legacy::MonitorElement::getTH1S(), h, dqm::impl::MonitorElement::kind(), SiStripPI::mean, MonitorElementData::TH1D, MonitorElementData::TH1F, and MonitorElementData::TH1S.

                                                          {
  if (!me)
    return -1;
  if (!me->getRootObject())
    return -1;
  TH1* h = nullptr;

  if (verbose_ > 1)
    std::cout << "QTest:" << getAlgoName() << "::runTest called on " << me->getFullname() << "\n";

  if (minEntries_ != 0 && me->getEntries() < minEntries_)
    return -1;

  if (me->kind() == MonitorElement::Kind::TH1F) {
    h = me->getTH1F();  //access Test histo
  } else if (me->kind() == MonitorElement::Kind::TH1S) {
    h = me->getTH1S();  //access Test histo
  } else if (me->kind() == MonitorElement::Kind::TH1D) {
    h = me->getTH1D();  //access Test histo
  } else {
    if (verbose_ > 0)
      std::cout << "QTest:MeanWithinExpected"
                << " ME " << me->getFullname() << " does not contain TH1F/TH1S/TH1D, exiting\n";
    return -1;
  }

  if (useRange_) {
    double mean = h->GetMean();
    if (mean <= xmax_ && mean >= xmin_)
      return 1;
    else
      return 0;
  } else if (useSigma_) {
    if (sigma_ != 0.) {
      double chi = (h->GetMean() - expMean_) / sigma_;
      return TMath::Prob(chi * chi, 1);
    } else {
      if (verbose_ > 0)
        std::cout << "QTest:MeanWithinExpected"
                  << " Error, sigma_ is zero, exiting\n";
      return 0;
    }
  } else if (useRMS_) {
    if (h->GetRMS() != 0.) {
      double chi = (h->GetMean() - expMean_) / h->GetRMS();
      return TMath::Prob(chi * chi, 1);
    } else {
      if (verbose_ > 0)
        std::cout << "QTest:MeanWithinExpected"
                  << " Error, RMS is zero, exiting\n";
      return 0;
    }
  } else {
    if (verbose_ > 0)
      std::cout << "QTest:MeanWithinExpected"
                << " Error, neither Range, nor Sigma, nor RMS, exiting\n";
    return -1;
  }
}

void MeanWithinExpected::setExpectedMean ( double  mean )

inline

Definition at line 407 of file QTest.h.

References expMean_, and SiStripPI::mean.

{ expMean_ = mean; }

void MeanWithinExpected::useRange	(	double	xmin,
		double	xmax
	)

Definition at line 1141 of file QTest.cc.

References gather_cfg::cout, hlt_dqm_clientPB-live_cfg::xmax, and hlt_dqm_clientPB-live_cfg::xmin.

                                                          {
  useRange_ = true;
  useSigma_ = useRMS_ = false;
  xmin_ = xmin;
  xmax_ = xmax;
  if (xmin_ > xmax_)
    if (verbose_ > 0)
      std::cout << "QTest:MeanWithinExpected"
                << " Illogical range: (" << xmin_ << ", " << xmax_ << "\n";
}

void MeanWithinExpected::useRMS

(

)

Definition at line 1161 of file QTest.cc.

                                {
  useRMS_ = true;
  useSigma_ = useRange_ = false;
}

void MeanWithinExpected::useSigma

(

double

expectedSigma

)

Definition at line 1151 of file QTest.cc.

References gather_cfg::cout.

                                                      {
  useSigma_ = true;
  useRMS_ = useRange_ = false;
  sigma_ = expectedSigma;
  if (sigma_ == 0)
    if (verbose_ > 0)
      std::cout << "QTest:MeanWithinExpected"
                << " Expected sigma = " << sigma_ << "\n";
}

Member Data Documentation

double MeanWithinExpected::expMean_

protected

Definition at line 417 of file QTest.h.

Referenced by setExpectedMean().

double MeanWithinExpected::sigma_

protected

Definition at line 416 of file QTest.h.

bool MeanWithinExpected::useRange_

protected

Definition at line 415 of file QTest.h.

bool MeanWithinExpected::useRMS_

protected

Definition at line 413 of file QTest.h.

bool MeanWithinExpected::useSigma_

protected

Definition at line 414 of file QTest.h.

double MeanWithinExpected::xmax_

protected

Definition at line 418 of file QTest.h.

double MeanWithinExpected::xmin_

protected

Definition at line 418 of file QTest.h.