ContentsXRange Class Reference

#include <QTest.h>

Inheritance diagram for ContentsXRange:

Public Member Functions
	ContentsXRange (const std::string &name)
float	runTest (const MonitorElement *me) override
virtual void	setAllowedXRange (double xmin, double xmax)
	set allowed range in X-axis (default values: histogram's X-range) More...
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
bool	rangeInitialized_
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

Definition at line 149 of file QTest.h.

Constructor & Destructor Documentation

ContentsXRange()

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

inline

Definition at line 151 of file QTest.h.

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

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

Member Function Documentation

getAlgoName()

static std::string ContentsXRange::getAlgoName ( )

inlinestatic

Definition at line 155 of file QTest.h.

{ return "ContentsXRange"; }

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

runTest()

float ContentsXRange::runTest ( const MonitorElement *  me )

overridevirtual

Reimplemented from QCriterion.

Definition at line 32 of file QTest.cc.

                                                      {
  badChannels_.clear();
 
  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";
  // -- TH1F
  if (me->kind() == MonitorElement::Kind::TH1F) {
    h = me->getTH1F();
  }
  // -- TH1S
  else if (me->kind() == MonitorElement::Kind::TH1S) {
    h = me->getTH1S();
  }
  // -- TH1D
  else if (me->kind() == MonitorElement::Kind::TH1D) {
    h = me->getTH1D();
  } else {
    if (verbose_ > 0)
      std::cout << "QTest:ContentsXRange"
                << " ME " << me->getFullname() << " does not contain TH1F/TH1S/TH1D, exiting\n";
    return -1;
  }
 
  if (!rangeInitialized_) {
    if (h->GetXaxis())
      setAllowedXRange(h->GetXaxis()->GetXmin(), h->GetXaxis()->GetXmax());
    else
      return -1;
  }
  int ncx = h->GetXaxis()->GetNbins();
  // use underflow bin
  int first = 0;  // 1
  // use overflow bin
  int last = ncx + 1;  // ncx
  // all entries
  double sum = 0;
  // entries outside X-range
  double fail = 0;
  int bin;
  for (bin = first; bin <= last; ++bin) {
    double contents = h->GetBinContent(bin);
    double x = h->GetBinCenter(bin);
    sum += contents;
    if (x < xmin_ || x > xmax_)
      fail += contents;
  }
 
  if (sum == 0)
    return 1;
  // return fraction of entries within allowed X-range
  return (sum - fail) / sum;
}

References newFWLiteAna::bin, relmon_rootfiles_spy::contents, gather_cfg::cout, first, dqmdumpme::last, hlt_dqm_clientPB-live_cfg::me, MonitorElementData::TH1D, MonitorElementData::TH1F, and MonitorElementData::TH1S.

setAllowedXRange()

virtual void ContentsXRange::setAllowedXRange ( double  xmin, double  xmax  )

inlinevirtual

set allowed range in X-axis (default values: histogram's X-range)

Definition at line 159 of file QTest.h.

                                                          {
    xmin_ = xmin;
    xmax_ = xmax;
    rangeInitialized_ = true;
  }

References rangeInitialized_, TrackerOfflineValidation_Dqm_cff::xmax, xmax_, TrackerOfflineValidation_Dqm_cff::xmin, and xmin_.

Member Data Documentation

rangeInitialized_

bool ContentsXRange::rangeInitialized_

protected

Definition at line 168 of file QTest.h.

Referenced by ContentsXRange(), and setAllowedXRange().

xmax_

double ContentsXRange::xmax_

protected

Definition at line 167 of file QTest.h.

Referenced by setAllowedXRange().

xmin_

double ContentsXRange::xmin_

protected

Definition at line 166 of file QTest.h.

Referenced by setAllowedXRange().