#include <QTest.h>

Inheritance diagram for QCriterion:

Public Member Functions
std::string	algoName () const
	get algorithm name More...

virtual std::vector< DQMChannel >	getBadChannels () const

std::string	getMessage () const
	get message attached to test More...

std::string	getName () const
	get name of quality test More...

int	getStatus () const
	(class should be created by DQMStore class) More...

void	setErrorProb (float prob)

void	setWarningProb (float prob)
	set probability limit for warning and error (default: 90% and 50%) More...

Protected Member Functions
void	init ()
	initialize values More...

	QCriterion (std::string qtname)

virtual float	runTest (const MonitorElement *me)

float	runTest (const MonitorElement *me, QReport &qr, DQMNet::QValue &qv)

void	setAlgoName (std::string name)
	set algorithm name More...

virtual void	setMessage ()=0
	set message after test has run More...

void	setVerbose (int verbose)
	probability limits for warnings, errors More...

virtual	~QCriterion ()=default

Protected Attributes
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...

Static Private Attributes
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...

Friends
class	DQMStore
	for creating and deleting class instances More...

class	MonitorElement
	for running the test More...

Detailed Description

Base class for quality tests run on Monitoring Elements;

Currently supporting the following tests:

Comparison to reference (Chi2, Kolmogorov)
Contents within [Xmin, Xmax]
Contents within [Ymin, Ymax]
Identical contents
Mean value within expected value
Check for dead or noisy channels
Check that mean, RMS of bins are within allowed range (support for 2D histograms, 1D, 2D profiles)

Definition at line 49 of file QTest.h.

Constructor & Destructor Documentation

QCriterion::QCriterion ( std::string qtname )

inlineprotected

Definition at line 72 of file QTest.h.

References init(), eostools::move(), qtname_, runTest(), and ~QCriterion().

72 { qtname_ = std::move(qtname); init(); }

QCriterion::qtname_

std::string qtname_

Definition: QTest.h:113

QCriterion::init

void init()

initialize values

Definition: QTest.cc:18

eostools.move

def move(src, dest)

Definition: eostools.py:511

virtual QCriterion::~QCriterion ( )

protectedvirtualdefault

Referenced by QCriterion().

Member Function Documentation

std::string QCriterion::algoName ( ) const

inline

get algorithm name

Definition at line 62 of file QTest.h.

References algoName_.

62 { return algoName_; }

QCriterion::algoName_

std::string algoName_

name of quality test

Definition: QTest.h:114

virtual std::vector<DQMChannel> QCriterion::getBadChannels ( ) const

inlinevirtual

get vector of channels that failed test (not relevant for all quality tests!)

Reimplemented in SimpleTest.

Definition at line 68 of file QTest.h.

Referenced by SimpleTest::getBadChannels(), and runTest().

69 { return std::vector<DQMChannel>(); }

std::string QCriterion::getMessage ( ) const

inline

get message attached to test

Definition at line 58 of file QTest.h.

References message_.

58 { return message_; }

QCriterion::message_

std::string message_

quality test status

Definition: QTest.h:117

std::string QCriterion::getName ( void ) const

inline

get name of quality test

Definition at line 60 of file QTest.h.

References qtname_.

Referenced by MonitorElement::addQReport(), plotting.Plot::draw(), and MonitorElement::runQTests().

60 { return qtname_; }

QCriterion::qtname_

std::string qtname_

Definition: QTest.h:113

int QCriterion::getStatus ( ) const

inline

(class should be created by DQMStore class)

get test status (see Core/interface/DQMDefinitions.h)

Definition at line 56 of file QTest.h.

References status_.

56 { return status_; }

QCriterion::status_

int status_

Definition: QTest.h:116

void QCriterion::init ( void )

protected

initialize values

Definition at line 18 of file QTest.cc.

References dqm::qstatus::DID_NOT_RUN.

Referenced by QCriterion().

 {
   errorProb_ = ERROR_PROB_THRESHOLD;
   warningProb_ = WARNING_PROB_THRESHOLD;
   setAlgoName("NO_ALGORITHM");
   status_ = dqm::qstatus::DID_NOT_RUN;
   message_ = "NO_MESSAGE";
   verbose_ = 0; // 0 = silent, 1 = algorithmic failures, 2 = info
 }

float QCriterion::runTest ( const MonitorElement * me )

protectedvirtual

Reimplemented in CheckVariance, CompareLastFilledBin, CompareToMedian, CSC01, FixedFlatOccupancy1d, MeanWithinExpected, ContentsWithinExpected, ContentSigma, NoisyChannel, DeadChannel, ContentsYRange, ContentsXRange, Comp2RefKolmogorov, Comp2Ref2DChi2, Comp2RefChi2, and Comp2RefEqualH.

Definition at line 28 of file QTest.cc.

References raiseDQMError().

Referenced by FixedFlatOccupancy1d::get_result(), CSC01::get_result(), Comp2RefEqualH::getAlgoName(), Comp2RefChi2::getAlgoName(), Comp2Ref2DChi2::getAlgoName(), Comp2RefKolmogorov::getAlgoName(), ContentsXRange::getAlgoName(), ContentsYRange::getAlgoName(), DeadChannel::getAlgoName(), NoisyChannel::getAlgoName(), ContentSigma::getAlgoName(), ContentsWithinExpected::getAlgoName(), MeanWithinExpected::getAlgoName(), CompareToMedian::getAlgoName(), CompareLastFilledBin::getAlgoName(), CheckVariance::getAlgoName(), QCriterion(), MonitorElement::runQTests(), and runTest().

 {
   raiseDQMError("QCriterion", "virtual runTest method called" );
   return 0.;
 }

float QCriterion::runTest	(	const MonitorElement *	me,
		QReport &	qr,
		DQMNet::QValue &	qv
	)

inlineprotected

Definition at line 82 of file QTest.h.

References algoName_, DQMNet::QValue::algorithm, QReport::badChannels_, DQMNet::QValue::code, gather_cfg::cout, dqm::qstatus::ERROR, errorProb_, getBadChannels(), DQMNet::QValue::message, message_, prob_, QReport::qcriterion_, DQMNet::QValue::qtname, qtname_, DQMNet::QValue::qtresult, runTest(), setMessage(), status_, dqm::qstatus::STATUS_OK, verbose_, dqm::qstatus::WARNING, and warningProb_.

                                                                            {
       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_;
     }