#include <QTest.h>

Inheritance diagram for QCriterion:

Public Types
typedef dqm::legacy::MonitorElement	MonitorElement
	(class should be created by DQMStore class) More...

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

Protected Member Functions
virtual float	runTest (const MonitorElement *me)

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

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

Friends
class	dqm::impl::MonitorElement

class	dqm::legacy::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 31 of file QTest.h.

Member Typedef Documentation

◆ MonitorElement

typedef dqm::legacy::MonitorElement QCriterion::MonitorElement

(class should be created by DQMStore class)

Definition at line 35 of file QTest.h.

Constructor & Destructor Documentation

◆ QCriterion()

QCriterion::QCriterion ( std::string qtname )

inline

Definition at line 51 of file QTest.h.

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

References init(), eostools::move(), and qtname_.

◆ ~QCriterion()

virtual QCriterion::~QCriterion ( )

virtualdefault

Member Function Documentation

◆ algoName()

std::string QCriterion::algoName ( ) const

inline

get algorithm name

Definition at line 43 of file QTest.h.

43 { return algoName_; }

References algoName_.

◆ getBadChannels()

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 49 of file QTest.h.

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

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

◆ getMessage()

std::string QCriterion::getMessage ( ) const

inline

get message attached to test

Definition at line 39 of file QTest.h.

39 { return message_; }

References message_.

◆ getName()

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

inline

get name of quality test

Definition at line 41 of file QTest.h.

41 { return qtname_; }

References qtname_.

Referenced by plotting.Plot::draw(), and QualityTester::performTests().

◆ getStatus()

int QCriterion::getStatus ( ) const

inline

get test status

Definition at line 37 of file QTest.h.

37 { return status_; }

References status_.

◆ init()

void QCriterion::init ( void )

initialize values

Definition at line 15 of file QTest.cc.

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

References dqm::qstatus::DID_NOT_RUN.

Referenced by QCriterion().

◆ runTest() [1/2]

float QCriterion::runTest ( const MonitorElement * me )

protectedvirtual

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

Definition at line 24 of file QTest.cc.

24 { return 0.; }

◆ runTest() [2/2]

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

inline

Definition at line 64 of file QTest.h.

                                                                          {
     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.setBadChannels(getBadChannels());
  
     return prob_;
   }