ContentsYRange Class Reference

#include <QTest.h>

Inheritance diagram for ContentsYRange:

Public Member Functions
	ContentsYRange (const std::string &name)
float	runTest (const MonitorElement *me) override
virtual void	setAllowedYRange (double ymin, double ymax)
void	setUseEmptyBins (unsigned int useEmptyBins)
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_
unsigned int	useEmptyBins_
double	ymax_
double	ymin_
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 173 of file QTest.h.

Constructor & Destructor Documentation

ContentsYRange()

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

inline

Definition at line 175 of file QTest.h.

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

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

Member Function Documentation

getAlgoName()

static std::string ContentsYRange::getAlgoName ( )

inlinestatic

Definition at line 179 of file QTest.h.

{ return "ContentsYRange"; }

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

runTest()

float ContentsYRange::runTest ( const MonitorElement *  me )

overridevirtual

Standard test !

AS quality test !!!

end of AS quality tests

Reimplemented from QCriterion.

Definition at line 94 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";
 
  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:ContentsYRange"
                << " ME " << me->getFullname() << " does not contain TH1F/TH1S/TH1D, exiting\n";
    return -1;
  }
 
  if (!rangeInitialized_ || !h->GetXaxis())
    return 1;  // all bins are accepted if no initialization
  int ncx = h->GetXaxis()->GetNbins();
  // do NOT use underflow bin
  int first = 1;
  // do NOT use overflow bin
  int last = ncx;
  // bins outside Y-range
  int fail = 0;
  int bin;
 
  if (useEmptyBins_)  
  {
    for (bin = first; bin <= last; ++bin) {
      double contents = h->GetBinContent(bin);
      bool failure = false;
      failure = (contents < ymin_ || contents > ymax_);  // allowed y-range: [ymin_, ymax_]
      if (failure) {
        DQMChannel chan(bin, 0, 0, contents, h->GetBinError(bin));
        badChannels_.push_back(chan);
        ++fail;
      }
    }
    // return fraction of bins that passed test
    return 1. * (ncx - fail) / ncx;
  } else  
  {
    for (bin = first; bin <= last; ++bin) {
      double contents = h->GetBinContent(bin);
      bool failure = false;
      if (contents)
        failure = (contents < ymin_ || contents > ymax_);  // allowed y-range: [ymin_, ymax_]
      if (failure)
        ++fail;
    }
    // return fraction of bins that passed test
    return 1. * (ncx - fail) / ncx;
  }  
}

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

setAllowedYRange()

virtual void ContentsYRange::setAllowedYRange ( double  ymin, double  ymax  )

inlinevirtual

Definition at line 183 of file QTest.h.

                                                          {
    ymin_ = ymin;
    ymax_ = ymax;
    rangeInitialized_ = true;
  }

References rangeInitialized_, L1TOccupancyClient_cfi::ymax, ymax_, L1TOccupancyClient_cfi::ymin, and ymin_.

setUseEmptyBins()

void ContentsYRange::setUseEmptyBins ( unsigned int  useEmptyBins )

inline

Definition at line 182 of file QTest.h.

{ useEmptyBins_ = useEmptyBins; }

References useEmptyBins_.

Member Data Documentation

rangeInitialized_

bool ContentsYRange::rangeInitialized_

protected

Definition at line 192 of file QTest.h.

Referenced by ContentsYRange(), and setAllowedYRange().

useEmptyBins_

unsigned int ContentsYRange::useEmptyBins_

protected

Definition at line 193 of file QTest.h.

Referenced by setUseEmptyBins().

ymax_

double ContentsYRange::ymax_

protected

Definition at line 191 of file QTest.h.

Referenced by setAllowedYRange().

ymin_

double ContentsYRange::ymin_

protected

Definition at line 190 of file QTest.h.

Referenced by setAllowedYRange().