ContentsWithinExpected Class Reference

#include <QTest.h>

Inheritance diagram for ContentsWithinExpected:

Public Member Functions
	ContentsWithinExpected (const std::string &name)
float	runTest (const MonitorElement *me) override
void	setMeanRange (double xmin, double xmax)
	set expected value for mean More...
void	setMeanTolerance (float fracTolerance)
	set (fractional) tolerance for mean More...
void	setRMSRange (double xmin, double xmax)
	set expected value for mean More...
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
	(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...

Static Public Member Functions
static std::string	getAlgoName ()

Protected Attributes
bool	checkMean_
bool	checkMeanTolerance_
bool	checkRMS_
float	maxMean_
float	maxRMS_
float	minMean_
float	minRMS_
float	toleranceMean_
unsigned int	useEmptyBins_
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
Protected Member Functions inherited from SimpleTest
void	setMessage () override
	set status & message after test has run More...
Protected Member Functions inherited from QCriterion
void	init ()
	initialize values More...
	QCriterion (std::string qtname)
float	runTest (const MonitorElement *me, QReport &qr, DQMNet::QValue &qv)
void	setAlgoName (std::string name)
	set algorithm name More...
void	setVerbose (int verbose)
	probability limits for warnings, errors More...
virtual	~QCriterion ()=default

Detailed Description

Definition at line 473 of file QTest.h.

Constructor & Destructor Documentation

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

inline

Definition at line 476 of file QTest.h.

References QCriterion::setAlgoName().

                                                : SimpleTest(name,true)
  {
    checkMean_ = checkRMS_ = false;
    minMean_ = maxMean_ = minRMS_ = maxRMS_ = 0.0;
    checkMeanTolerance_ = false;
    toleranceMean_ = -1.0;
    setAlgoName(getAlgoName());
  }

Member Function Documentation

static std::string ContentsWithinExpected::getAlgoName ( )

inlinestatic

Definition at line 484 of file QTest.h.

References QCriterion::runTest().

Referenced by QTestConfigure::EnableContentsWithinExpectedTest(), QTestConfigure::enableTests(), and QTestParameterNames::QTestParameterNames().

{ return "ContentsWithinExpected"; }

float ContentsWithinExpected::runTest ( const MonitorElement *  me )

overridevirtual

end of normal Test

AS quality test !!!

end of AS quality test

Reimplemented from QCriterion.

Definition at line 1460 of file QTest.cc.

References funct::abs(), officialStyle::chan, gather_cfg::cout, MonitorElement::DQM_KIND_TH2D, MonitorElement::DQM_KIND_TH2F, MonitorElement::DQM_KIND_TH2S, MonitorElement::DQM_KIND_TPROFILE, MonitorElement::DQM_KIND_TPROFILE2D, cmsPerfPublish::fail(), MonitorElement::getRootObject(), MonitorElement::getTH2D(), MonitorElement::getTH2F(), MonitorElement::getTH2S(), MonitorElement::getTProfile(), MonitorElement::getTProfile2D(), h, MonitorElement::kind(), SiStripPI::mean, and SiStripPI::rms.

{
  badChannels_.clear();
  if (!me) 
    return -1;
  if (!me->getRootObject()) 
    return -1;
  TH1* h=nullptr; //initialize histogram pointer

  if (verbose_>1) 
    std::cout << "QTest:" << getAlgoName() << "::runTest called on " 
              << me-> getFullname() << "\n";

  int ncx;
  int ncy;

  if (useEmptyBins_)
  {
    //-- TH2
    if (me->kind()==MonitorElement::DQM_KIND_TH2F)
    {
      ncx = me->getTH2F()->GetXaxis()->GetNbins();
      ncy = me->getTH2F()->GetYaxis()->GetNbins(); 
      h  = me->getTH2F(); // access Test histo
    }
    //-- TH2S
    else if (me->kind()==MonitorElement::DQM_KIND_TH2S)
    {
      ncx = me->getTH2S()->GetXaxis()->GetNbins();
      ncy = me->getTH2S()->GetYaxis()->GetNbins(); 
      h  = me->getTH2S(); // access Test histo
    }
    //-- TH2D
    else if (me->kind()==MonitorElement::DQM_KIND_TH2D)
    {
      ncx = me->getTH2D()->GetXaxis()->GetNbins();
      ncy = me->getTH2D()->GetYaxis()->GetNbins(); 
      h  = me->getTH2D(); // access Test histo
    }
    //-- TProfile
    else if (me->kind()==MonitorElement::DQM_KIND_TPROFILE)
    {
      ncx = me->getTProfile()->GetXaxis()->GetNbins();
      ncy = 1;
      h  = me->getTProfile(); // access Test histo
    }
    //-- TProfile2D
    else if (me->kind()==MonitorElement::DQM_KIND_TPROFILE2D)
    {
      ncx = me->getTProfile2D()->GetXaxis()->GetNbins();
      ncy = me->getTProfile2D()->GetYaxis()->GetNbins();
      h  = me->getTProfile2D(); // access Test histo
    }
    else
    {
      if (verbose_>0) 
        std::cout << "QTest:ContentsWithinExpected" 
     << " ME does not contain TH2F/TH2S/TH2D/TPROFILE/TPROFILE2D, exiting\n"; 
      return -1;
    } 

    int nsum = 0;
    double sum = 0.0;
    double average = 0.0;

    if (checkMeanTolerance_)
    { // calculate average value of all bin contents

      for (int cx = 1; cx <= ncx; ++cx)
      {
    for (int cy = 1; cy <= ncy; ++cy)
    {
      if (me->kind() == MonitorElement::DQM_KIND_TH2F)
      {
        sum += h->GetBinContent(h->GetBin(cx, cy));
        ++nsum;
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TH2S)
      {
        sum += h->GetBinContent(h->GetBin(cx, cy));
        ++nsum;
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TH2D)
      {
        sum += h->GetBinContent(h->GetBin(cx, cy));
        ++nsum;
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TPROFILE)
      {
        if (me->getTProfile()->GetBinEntries(h->GetBin(cx)) >= minEntries_/(ncx))
        {
          sum += h->GetBinContent(h->GetBin(cx));
          ++nsum;
        }
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TPROFILE2D)
      {
        if (me->getTProfile2D()->GetBinEntries(h->GetBin(cx, cy)) >= minEntries_/(ncx*ncy))
        {
          sum += h->GetBinContent(h->GetBin(cx, cy));
          ++nsum;
        }
      }
    }
      }

      if (nsum > 0) 
    average = sum/nsum;

    } // calculate average value of all bin contents

    int fail = 0;

    for (int cx = 1; cx <= ncx; ++cx)
    {
      for (int cy = 1; cy <= ncy; ++cy)
      {
    bool failMean = false;
    bool failRMS = false;
    bool failMeanTolerance = false;

    if (me->kind() == MonitorElement::DQM_KIND_TPROFILE && 
            me->getTProfile()->GetBinEntries(h->GetBin(cx)) < minEntries_/(ncx))
          continue;

    if (me->kind() == MonitorElement::DQM_KIND_TPROFILE2D && 
            me->getTProfile2D()->GetBinEntries(h->GetBin(cx, cy)) < minEntries_/(ncx*ncy)) 
      continue;

    if (checkMean_)
    {
      double mean = h->GetBinContent(h->GetBin(cx, cy));
          failMean = (mean < minMean_ || mean > maxMean_);
    }

    if (checkRMS_)
    {
      double rms = h->GetBinError(h->GetBin(cx, cy));
          failRMS = (rms < minRMS_ || rms > maxRMS_);
    }

    if (checkMeanTolerance_)
    {
      double mean = h->GetBinContent(h->GetBin(cx, cy));
          failMeanTolerance = (std::abs(mean - average) > toleranceMean_*std::abs(average));
    }

    if (failMean || failRMS || failMeanTolerance)
    {

      if (me->kind() == MonitorElement::DQM_KIND_TH2F) 
      {
            DQMChannel chan(cx, cy, 0,
                h->GetBinContent(h->GetBin(cx, cy)),
                h->GetBinError(h->GetBin(cx, cy)));
            badChannels_.push_back(chan);
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TH2S) 
      {
            DQMChannel chan(cx, cy, 0,
                h->GetBinContent(h->GetBin(cx, cy)),
                h->GetBinError(h->GetBin(cx, cy)));
            badChannels_.push_back(chan);
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TH2D) 
      {
            DQMChannel chan(cx, cy, 0,
                h->GetBinContent(h->GetBin(cx, cy)),
                h->GetBinError(h->GetBin(cx, cy)));
            badChannels_.push_back(chan);
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TPROFILE) 
      {
        DQMChannel chan(cx, cy, int(me->getTProfile()->GetBinEntries(h->GetBin(cx))),
                0,
                h->GetBinError(h->GetBin(cx)));
            badChannels_.push_back(chan);
      }
      else if (me->kind() == MonitorElement::DQM_KIND_TPROFILE2D) 
      {
        DQMChannel chan(cx, cy, int(me->getTProfile2D()->GetBinEntries(h->GetBin(cx, cy))),
                h->GetBinContent(h->GetBin(cx, cy)),
                h->GetBinError(h->GetBin(cx, cy)));
            badChannels_.push_back(chan);
      }
          ++fail;
    }
      }
    }
    return 1.*(ncx*ncy - fail)/(ncx*ncy);
  } 

  else     
  {
    if (me->kind()==MonitorElement::DQM_KIND_TH2F)
    {
      ncx = me->getTH2F()->GetXaxis()->GetNbins();
      ncy = me->getTH2F()->GetYaxis()->GetNbins();
      h  = me->getTH2F(); // access Test histo
    }
    else if (me->kind()==MonitorElement::DQM_KIND_TH2S)
    {
      ncx = me->getTH2S()->GetXaxis()->GetNbins();
      ncy = me->getTH2S()->GetYaxis()->GetNbins();
      h  = me->getTH2S(); // access Test histo
    }
    else if (me->kind()==MonitorElement::DQM_KIND_TH2D)
    {
      ncx = me->getTH2D()->GetXaxis()->GetNbins();
      ncy = me->getTH2D()->GetYaxis()->GetNbins();
      h  = me->getTH2D(); // access Test histo
    }
    else 
    {
      if (verbose_>0) 
        std::cout << "QTest:ContentsWithinExpected AS" 
                  << " ME does not contain TH2F/TH2S/TH2D, exiting\n"; 
      return -1;
    } 

    // if (!rangeInitialized_) return 0; // all accepted if no initialization
    int fail = 0;
    for (int cx = 1; cx <= ncx; ++cx)
    {
      for (int cy = 1; cy <= ncy; ++cy)
      {
    bool failure = false;
    double Content = h->GetBinContent(h->GetBin(cx, cy));
    if (Content) 
      failure = (Content <  minMean_ || Content >  maxMean_);
    if (failure) 
      ++fail;
      }
    }
    return 1.*(ncx*ncy-fail)/(ncx*ncy);
  } 

}

void ContentsWithinExpected::setMeanRange	(	double	xmin,
		double	xmax
	)

set expected value for mean

Definition at line 1699 of file QTest.cc.

References gather_cfg::cout, TrackerOfflineValidation_Dqm_cff::xmax, and TrackerOfflineValidation_Dqm_cff::xmin.

Referenced by QTestConfigure::EnableContentsWithinExpectedTest().

{
  if (xmax < xmin)
    if (verbose_>0) 
      std::cout << "QTest:ContentsWitinExpected" 
                << " Illogical range: (" << xmin << ", " << xmax << "\n";
  minMean_ = xmin;
  maxMean_ = xmax;
  checkMean_ = true;
}

void ContentsWithinExpected::setMeanTolerance ( float  fracTolerance )

inline

set (fractional) tolerance for mean

Definition at line 494 of file QTest.h.

Referenced by QTestConfigure::EnableContentsWithinExpectedTest().

  {
    if (fracTolerance >= 0.0)
    {
      toleranceMean_ = fracTolerance;
      checkMeanTolerance_ = true;
    }
  }

void ContentsWithinExpected::setRMSRange	(	double	xmin,
		double	xmax
	)

set expected value for mean

Definition at line 1711 of file QTest.cc.

References gather_cfg::cout, TrackerOfflineValidation_Dqm_cff::xmax, and TrackerOfflineValidation_Dqm_cff::xmin.

Referenced by QTestConfigure::EnableContentsWithinExpectedTest().

{
  if (xmax < xmin)
    if (verbose_>0) 
      std::cout << "QTest:ContentsWitinExpected" 
                << " Illogical range: (" << xmin << ", " << xmax << "\n";
  minRMS_ = xmin;
  maxRMS_ = xmax;
  checkRMS_ = true;
}

void ContentsWithinExpected::setUseEmptyBins ( unsigned int  useEmptyBins )

inline

Definition at line 487 of file QTest.h.

References TrackerOfflineValidation_Dqm_cff::xmax, and TrackerOfflineValidation_Dqm_cff::xmin.

Referenced by QTestConfigure::EnableContentsWithinExpectedTest().

                                                  { 
    useEmptyBins_ = useEmptyBins; 
  }

Member Data Documentation

bool ContentsWithinExpected::checkMean_

protected

Definition at line 504 of file QTest.h.

bool ContentsWithinExpected::checkMeanTolerance_

protected

Definition at line 506 of file QTest.h.

bool ContentsWithinExpected::checkRMS_

protected

Definition at line 505 of file QTest.h.

float ContentsWithinExpected::maxMean_

protected

Definition at line 508 of file QTest.h.

float ContentsWithinExpected::maxRMS_

protected

Definition at line 509 of file QTest.h.

float ContentsWithinExpected::minMean_

protected

Definition at line 508 of file QTest.h.

float ContentsWithinExpected::minRMS_

protected

Definition at line 509 of file QTest.h.

float ContentsWithinExpected::toleranceMean_

protected

Definition at line 507 of file QTest.h.

unsigned int ContentsWithinExpected::useEmptyBins_

protected

Definition at line 510 of file QTest.h.