CompareToMedian Class Reference

#include <QTest.h>

Inheritance diagram for CompareToMedian:

Public Member Functions
	CompareToMedian (const std::string &name)
float	runTest (const MonitorElement *me) override
void	setEmptyBins (int eB)
void	setMax (float max)
void	setMaxMedian (float max)
void	setMin (float min)
void	setMinMedian (float min)
void	setStatCut (float cut)
	~CompareToMedian () override=default
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 Member Functions
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...

Private Member Functions
void	reset ()

Private Attributes
int	_emptyBins
float	_max
float	_maxMed
float	_min
float	_minMed
float	_statCut
std::vector< float >	binValues
int	nBins
int	nBinsX
int	nBinsY

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

Detailed Description

Definition at line 589 of file QTest.h.

Constructor & Destructor Documentation

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

inline

Definition at line 592 of file QTest.h.

References _emptyBins, _max, _maxMed, _min, _minMed, _statCut, getAlgoName(), nBins, reset(), and QCriterion::setAlgoName().

                                         : SimpleTest(name, true) {
    this->_min = 0.2;
    this->_max = 3.0;
    this->_emptyBins = 0;
    this->_maxMed = 10;
    this->_minMed = 0;
    this->nBins = 0;
    this->_statCut = 0;
    reset();
    setAlgoName(getAlgoName());
  };

CompareToMedian::~CompareToMedian ( )

overridedefault

Member Function Documentation

static std::string CompareToMedian::getAlgoName ( )

inlinestatic

Definition at line 607 of file QTest.h.

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

{ return "CompareToMedian"; }

void CompareToMedian::reset ( void  )

inlineprivate

Definition at line 637 of file QTest.h.

References binValues.

Referenced by CompareToMedian().

{ binValues.clear(); };

float CompareToMedian::runTest ( const MonitorElement *  me )

overridevirtual

Reimplemented from QCriterion.

Definition at line 1177 of file QTest.cc.

References newFWLiteAna::bin, officialStyle::chan, ws_sso_content_reader::content, gather_cfg::cout, dqm::impl::MonitorElement::getFullname(), dqm::legacy::MonitorElement::getRootObject(), dqm::legacy::MonitorElement::getTProfile2D(), h, dqm::impl::MonitorElement::kind(), median(), hlt_dqm_clientPB-live_cfg::nbins, reset(), and MonitorElementData::TPROFILE2D.

                                                       {
  int32_t nbins = 0, failed = 0;
  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";
    std::cout << "\tMin = " << _min << "; Max = " << _max << "\n";
    std::cout << "\tMinMedian = " << _minMed << "; MaxMedian = " << _maxMed << "\n";
    std::cout << "\tUseEmptyBins = " << (_emptyBins ? "Yes" : "No") << "\n";
  }

  if (me->kind() == MonitorElement::Kind::TPROFILE2D) {
    h = me->getTProfile2D();  // access Test histo
  } else {
    if (verbose_ > 0)
      std::cout << "QTest:ContentsWithinExpected"
                << " ME does not contain TPROFILE2D, exiting\n";
    return -1;
  }

  nBinsX = h->GetNbinsX();
  nBinsY = h->GetNbinsY();
  int entries = 0;
  float median = 0.0;

  //Median calculated with partially sorted vector
  for (int binX = 1; binX <= nBinsX; binX++) {
    reset();
    // Fill vector
    for (int binY = 1; binY <= nBinsY; binY++) {
      int bin = h->GetBin(binX, binY);
      auto content = (double)h->GetBinContent(bin);
      if (content == 0 && !_emptyBins)
        continue;
      binValues.push_back(content);
      entries = me->getTProfile2D()->GetBinEntries(bin);
    }
    if (binValues.empty())
      continue;
    nbins += binValues.size();

    //calculate median
    if (!binValues.empty()) {
      int medPos = (int)binValues.size() / 2;
      nth_element(binValues.begin(), binValues.begin() + medPos, binValues.end());
      median = *(binValues.begin() + medPos);
    }

    // if median == 0, use the absolute cut
    if (median == 0) {
      if (verbose_ > 0) {
        std::cout << "QTest: Median is 0; the fixed cuts: [" << _minMed << "; " << _maxMed << "]  are used\n";
      }
      for (int binY = 1; binY <= nBinsY; binY++) {
        int bin = h->GetBin(binX, binY);
        auto content = (double)h->GetBinContent(bin);
        entries = me->getTProfile2D()->GetBinEntries(bin);
        if (entries == 0)
          continue;
        if (content > _maxMed || content < _minMed) {
          DQMChannel chan(binX, binY, 0, content, h->GetBinError(bin));
          badChannels_.push_back(chan);
          failed++;
        }
      }
      continue;
    }

    //Cut on stat: will mask rings with no enought of statistics
    if (median * entries < _statCut)
      continue;

    // If median is off the absolute cuts, declare everything bad (if bin has non zero entries)
    if (median > _maxMed || median < _minMed) {
      for (int binY = 1; binY <= nBinsY; binY++) {
        int bin = h->GetBin(binX, binY);
        auto content = (double)h->GetBinContent(bin);
        entries = me->getTProfile2D()->GetBinEntries(bin);
        if (entries == 0)
          continue;
        DQMChannel chan(binX, binY, 0, content / median, h->GetBinError(bin));
        badChannels_.push_back(chan);
        failed++;
      }
      continue;
    }

    // Test itself
    float minCut = median * _min;
    float maxCut = median * _max;
    for (int binY = 1; binY <= nBinsY; binY++) {
      int bin = h->GetBin(binX, binY);
      auto content = (double)h->GetBinContent(bin);
      entries = me->getTProfile2D()->GetBinEntries(bin);
      if (entries == 0)
        continue;
      if (content > maxCut || content < minCut) {
        DQMChannel chan(binX, binY, 0, content / median, h->GetBinError(bin));
        badChannels_.push_back(chan);
        failed++;
      }
    }
  }

  if (nbins == 0) {
    if (verbose_ > 0)
      std::cout << "QTest:CompareToMedian: Histogram is empty" << std::endl;
    return 1.;
  }
  return 1 - (float)failed / nbins;
}

void CompareToMedian::setEmptyBins ( int  eB )

inline

Definition at line 612 of file QTest.h.

References _emptyBins.

{ eB > 0 ? _emptyBins = 1 : _emptyBins = 0; };

void CompareToMedian::setMax ( float  max )

inline

Definition at line 611 of file QTest.h.

References _max, and SiStripPI::max.

{ _max = max; };

void CompareToMedian::setMaxMedian ( float  max )

inline

Definition at line 613 of file QTest.h.

References _maxMed, and SiStripPI::max.

{ _maxMed = max; };

void CompareToMedian::setMessage ( )

inlineoverrideprotectedvirtual

set status & message after test has run

Reimplemented from SimpleTest.

Definition at line 618 of file QTest.h.

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

                             {
    std::ostringstream message;
    message << "Test " << qtname_ << " (" << algoName_ << "): Entry fraction within range = " << prob_;
    message_ = message.str();
  }

void CompareToMedian::setMin ( float  min )

inline

Definition at line 610 of file QTest.h.

References _min, and min().

{ _min = min; };

void CompareToMedian::setMinMedian ( float  min )

inline

Definition at line 614 of file QTest.h.

References _minMed, and min().

{ _minMed = min; };

void CompareToMedian::setStatCut ( float  cut )

inline

Definition at line 615 of file QTest.h.

References _statCut.

{ _statCut = (cut > 0) ? cut : 0; };

Member Data Documentation

int CompareToMedian::_emptyBins

private

Definition at line 626 of file QTest.h.

Referenced by CompareToMedian(), and setEmptyBins().

float CompareToMedian::_max

private

Definition at line 625 of file QTest.h.

Referenced by CompareToMedian(), generateEDF.LumiInfoCont::max(), and setMax().

float CompareToMedian::_maxMed

private

Definition at line 627 of file QTest.h.

Referenced by CompareToMedian(), and setMaxMedian().

float CompareToMedian::_min

private

Definition at line 625 of file QTest.h.

Referenced by CompareToMedian(), generateEDF.LumiInfoCont::min(), and setMin().

float CompareToMedian::_minMed

private

Definition at line 627 of file QTest.h.

Referenced by CompareToMedian(), and setMinMedian().

float CompareToMedian::_statCut

private

Definition at line 628 of file QTest.h.

Referenced by CompareToMedian(), and setStatCut().

std::vector<float> CompareToMedian::binValues

private

Definition at line 635 of file QTest.h.

Referenced by reset().

int CompareToMedian::nBins

private

Definition at line 632 of file QTest.h.

Referenced by CompareToMedian().

int CompareToMedian::nBinsX

private

Definition at line 630 of file QTest.h.

int CompareToMedian::nBinsY

private

Definition at line 630 of file QTest.h.