---

MeanWithinExpected Class Reference

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

#include <DQMServices/Core/interface/QTest.h>

Inheritance diagram for MeanWithinExpected:

List of all members.

Public Member Functions
	MeanWithinExpected (const std::string &name)
float	runTest (const MonitorElement *me)
	run the test; (a) if useRange is called: 1 if mean within allowed range, 0 otherwise
void	setExpectedMean (float expMean)
	set expected value for mean
void	useRange (float xmin, float xmax)
void	useRMS (void)
void	useSigma (float expectedSigma)
Static Public Member Functions
static std::string	getAlgoName (void)
Protected Member Functions
void	checkRange (void)
	check that allowed range is logical
void	checkSigma (void)
	check that exp_sigma_ is non-zero
float	doGaussTest (const TH1 *h, float sigma)
	test assuming mean value is quantity with gaussian errors
float	doRangeTest (const TH1 *h)
	test for useRange_ = true case
bool	isInvalid (void)
void	setMessage (void)
	set status & message after test has run
Protected Attributes
float	expMean_
TH1F *	h
float	sigma_
bool	useRange_
bool	useRMS_
bool	useSigma_
bool	validExpMean_
bool	validMethod_
float	xmax_
float	xmin_

---

Detailed Description

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

Definition at line 542 of file QTest.h.

---

Constructor & Destructor Documentation

MeanWithinExpected::MeanWithinExpected

(

const std::string &

name

)

[inline]

Definition at line 545 of file QTest.h.

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

                                            : SimpleTest(name)
    {
      validMethod_ = validExpMean_ = false;
      setAlgoName(getAlgoName());
    }

---

Member Function Documentation

void MeanWithinExpected::checkRange

(

void

)

[protected]

check that allowed range is logical

Definition at line 981 of file QTest.cc.

References GenMuonPlsPt100GeV_cfg::cout, lat::endl(), getAlgoName(), validMethod_, xmax_, and xmin_.

Referenced by useRange().

{
  if (xmin_ < xmax_)  validMethod_ = true;
  else
  {
    std::cout << " *** Error! Illogical range: (" << xmin_ << ", " << xmax_
              << ") in algorithm " << getAlgoName() << std::endl;
    validMethod_ = false;
  }
}

void MeanWithinExpected::checkSigma

(

void

)

[protected]

check that exp_sigma_ is non-zero

Definition at line 970 of file QTest.cc.

References GenMuonPlsPt100GeV_cfg::cout, lat::endl(), getAlgoName(), sigma_, and validMethod_.

Referenced by useSigma().

{
  if (sigma_ != 0) validMethod_ = true;
  else
  {
  std::cout << " *** Error! Expected sigma = " << sigma_ << " in algorithm " << getAlgoName() << std::endl;
    validMethod_ = false;
  }
}

float MeanWithinExpected::doGaussTest	(	const TH1 *	h,
		float	sigma
	)			[protected]

test assuming mean value is quantity with gaussian errors

Definition at line 954 of file QTest.cc.

References expMean_.

Referenced by runTest().

{
  float chi = (h->GetMean() - expMean_)/sigma;
  return TMath::Prob(chi*chi, 1);
}

float MeanWithinExpected::doRangeTest

(

const TH1 *

h

)

[protected]

test for useRange_ = true case

Definition at line 961 of file QTest.cc.

References mean(), and xmin_.

Referenced by runTest().

{
  float mean = h->GetMean();
  if (mean <= xmax_ && mean >= xmin_) return 1;
  else  return 0;
}

static std::string MeanWithinExpected::getAlgoName

(

void

)

[inline, static]

Definition at line 551 of file QTest.h.

Referenced by checkRange(), checkSigma(), QTestConfigure::EnableMeanWithinExpectedTest(), QTestConfigure::enableTests(), MeanWithinExpected(), and QTestParameterNames::QTestParameterNames().

  { return "MeanWithinExpected"; }

bool MeanWithinExpected::isInvalid

(

void

)

[protected]

Definition at line 993 of file QTest.cc.

References useRange_, validExpMean_, and validMethod_.

Referenced by runTest().

{
  // if useRange_ = true, test does not need a "expected mean value"
  if (useRange_) return !validMethod_; // set by checkRange()

  // otherwise (useSigma_ or useRMS_ case), we also need to check
  // if "expected mean value" has been set
  return !validMethod_  // set by useRMS() or checkSigma()
    || !validExpMean_; // set by setExpectedMean()

}

float MeanWithinExpected::runTest

(

const MonitorElement *

me

)

[virtual]

run the test; (a) if useRange is called: 1 if mean within allowed range, 0 otherwise

(b) is useRMS or useSigma is called: result is the probability Prob(chi^2, ndof=1) that the mean of histogram will be deviated by more than +/- delta from <expected_mean>, where delta = mean - <expected_mean>, and chi^2 = (delta/sigma)^2. sigma is the RMS of the histogram ("useRMS") or <expected_sigma> ("useSigma") e.g. for delta = 1, Prob = 31.7% for delta = 2, Prob = 4.55%

(returns result in [0, 1] or <0 for failure)

Reimplemented from QCriterion.

Definition at line 924 of file QTest.cc.

References GenMuonPlsPt100GeV_cfg::cout, doGaussTest(), doRangeTest(), MonitorElement::DQM_KIND_TH1F, MonitorElement::DQM_KIND_TH1S, lat::endl(), MonitorElement::getFullname(), MonitorElement::getRootObject(), MonitorElement::getTH1F(), MonitorElement::getTH1S(), h, isInvalid(), MonitorElement::kind(), sigma_, useRange_, useRMS_, and useSigma_.

{
  if (!me) return -1;
  if (!me->getRootObject()) return -1;
  TH1* h=0;
   
  if (me->kind()==MonitorElement::DQM_KIND_TH1F) { 
    h = me->getTH1F(); //access Test histo
  }
  else if (me->kind()==MonitorElement::DQM_KIND_TH1S) { 
    h = me->getTH1S(); //access Test histo
  }
  else {
    std::cout<< " MeanWithinExpected ERROR: ME " << me->getFullname() << " does not contain TH1F/TH1S" << std::endl; 
    return -1;
  } 
   
  if (isInvalid()) return -1;

  if (useRange_) return doRangeTest(h);

  if (useSigma_) return doGaussTest(h, sigma_);

  if (useRMS_) return doGaussTest(h, h->GetRMS());

  // we should never reach this point;
  return -99;
}

void MeanWithinExpected::setExpectedMean

(

float

expMean

)

[inline]

set expected value for mean

Definition at line 555 of file QTest.h.

References expMean_, and validExpMean_.

Referenced by createMeanValueTest(), and QTestConfigure::EnableMeanWithinExpectedTest().

  {
   expMean_ = expMean;
   validExpMean_ = true;
  }

void MeanWithinExpected::setMessage

(

void

)

[inline, protected, virtual]

set status & message after test has run

Reimplemented from SimpleTest.

Definition at line 603 of file QTest.h.

References QCriterion::algoName_, QCriterion::message_, QCriterion::prob_, QCriterion::qtname_, and useRange_.

                        {
      std::ostringstream message;
      message << " Test " << qtname_ << " (" << algoName_ << "): ";
      if(useRange_)
      {
        message << "Mean within allowed range? ";
        if(prob_)
          message << "Yes";
        else
          message << "No";
      }
      else
        message << "prob = " << prob_;

      message_ = message.str();
    }

void MeanWithinExpected::useRange	(	float	xmin,
		float	xmax
	)			[inline]

Definition at line 576 of file QTest.h.

References checkRange(), useRange_, useRMS_, useSigma_, xmax_, and xmin_.

Referenced by QTestConfigure::EnableMeanWithinExpectedTest().

  {
    useRange_ = true;
    useSigma_ = useRMS_ = false;
    xmin_ = xmin; xmax_ = xmax;
    checkRange();
   }

void MeanWithinExpected::useRMS

(

void

)

[inline]

Definition at line 561 of file QTest.h.

References useRange_, useRMS_, useSigma_, and validMethod_.

Referenced by createMeanValueTest(), and QTestConfigure::EnableMeanWithinExpectedTest().

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

void MeanWithinExpected::useSigma

(

float

expectedSigma

)

[inline]

Definition at line 568 of file QTest.h.

References checkSigma(), sigma_, useRange_, useRMS_, and useSigma_.

Referenced by createMeanValueTest(), and QTestConfigure::EnableMeanWithinExpectedTest().

  {
   useSigma_ = true;
   useRMS_ = useRange_ = false;
   sigma_ = expectedSigma;
   checkSigma();
  }

---

Member Data Documentation

float MeanWithinExpected::expMean_ [protected]

Definition at line 638 of file QTest.h.

Referenced by doGaussTest(), and setExpectedMean().

TH1F* MeanWithinExpected::h [protected]

Definition at line 633 of file QTest.h.

Referenced by runTest().

float MeanWithinExpected::sigma_ [protected]

Definition at line 637 of file QTest.h.

Referenced by checkSigma(), runTest(), and useSigma().

bool MeanWithinExpected::useRange_ [protected]

Definition at line 636 of file QTest.h.

Referenced by isInvalid(), runTest(), setMessage(), useRange(), useRMS(), and useSigma().

bool MeanWithinExpected::useRMS_ [protected]

Definition at line 634 of file QTest.h.

Referenced by runTest(), useRange(), useRMS(), and useSigma().

bool MeanWithinExpected::useSigma_ [protected]

Definition at line 635 of file QTest.h.

Referenced by runTest(), useRange(), useRMS(), and useSigma().

bool MeanWithinExpected::validExpMean_ [protected]

Definition at line 641 of file QTest.h.

Referenced by isInvalid(), MeanWithinExpected(), and setExpectedMean().

bool MeanWithinExpected::validMethod_ [protected]

Definition at line 640 of file QTest.h.

Referenced by checkRange(), checkSigma(), isInvalid(), MeanWithinExpected(), and useRMS().

float MeanWithinExpected::xmax_ [protected]

Definition at line 639 of file QTest.h.

Referenced by checkRange(), and useRange().

float MeanWithinExpected::xmin_ [protected]

Definition at line 639 of file QTest.h.

Referenced by checkRange(), doRangeTest(), and useRange().

---

The documentation for this class was generated from the following files:

• DQMServices/Core/interface/QTest.h
• DQMServices/Core/src/QTest.cc

---