---

NoisyChannel Class Reference

Check if any channels are noisy compared to neighboring ones. More...

#include <DQMServices/Core/interface/QTest.h>

Inheritance diagram for NoisyChannel:

List of all members.

Public Member Functions
	NoisyChannel (const std::string &name)
float	runTest (const MonitorElement *me)
	run the test (result: fraction of channels not appearing noisy or "hot")
void	setNumNeighbors (unsigned n)
	set # of neighboring channels for calculating average to be used for comparison with channel under consideration; use 1 for considering bin+1 and bin-1 (default), use 2 for considering bin+1,bin-1, bin+2,bin-2, etc; Will use rollover when bin+i or bin-i is beyond histogram limits (e.g.
void	setTolerance (float percentage)
	set (percentage) tolerance for considering a channel noisy; eg.
Static Public Member Functions
static std::string	getAlgoName (void)
Protected Member Functions
Double_t	getAverage (int bin, const TH1 *h) const
	get average for bin under consideration (see description of method setNumNeighbors)
void	setMessage (void)
	set status & message after test has run
Protected Attributes
TH1 *	h
unsigned	numNeighbors_
bool	rangeInitialized_
float	tolerance_

---

Detailed Description

Check if any channels are noisy compared to neighboring ones.

Definition at line 398 of file QTest.h.

---

Constructor & Destructor Documentation

NoisyChannel::NoisyChannel

(

const std::string &

name

)

[inline]

Definition at line 401 of file QTest.h.

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

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

---

Member Function Documentation

static std::string NoisyChannel::getAlgoName

(

void

)

[inline, static]

Definition at line 411 of file QTest.h.

Referenced by QTestConfigure::EnableNoisyChannelTest(), QTestConfigure::enableTests(), NoisyChannel(), and QTestParameterNames::QTestParameterNames().

  { return "NoisyChannel"; }

Double_t NoisyChannel::getAverage	(	int	bin,
		const TH1 *	h
	)			const [protected]

get average for bin under consideration (see description of method setNumNeighbors)

do NOT use underflow bin

do NOT use overflow bin

use symmetric-to-bin bins to calculate average

check if need to consider bins on other side of spectrum (ie. if bins below 1 or above ncx)

average is sum over the # of bins used

Definition at line 673 of file QTest.cc.

References first, i, numNeighbors_, and sum().

Referenced by runTest().

{
  Int_t first = 1;
  Int_t ncx  = h->GetXaxis()->GetNbins();

  Double_t sum = 0; int bin_low, bin_hi;
  for (unsigned i = 1; i <= numNeighbors_; ++i)
  {
    bin_low = bin-i;  bin_hi = bin+i;

    while (bin_low < first) // shift bin by +ncx
      bin_low = ncx + bin_low;
    while (bin_hi > ncx) // shift bin by -ncx
      bin_hi = bin_hi - ncx;
  
      sum += h->GetBinContent(bin_low) + h->GetBinContent(bin_hi);
  }

  return sum/(numNeighbors_ * 2);
}

float NoisyChannel::runTest

(

const MonitorElement *

me

)

[virtual]

run the test (result: fraction of channels not appearing noisy or "hot")

Reimplemented from QCriterion.

Definition at line 603 of file QTest.cc.

References average(), SimpleTest::badChannels_, GenMuonPlsPt100GeV_cfg::cout, MonitorElement::DQM_KIND_TH1F, MonitorElement::DQM_KIND_TH1S, MonitorElement::DQM_KIND_TH2F, MonitorElement::DQM_KIND_TH2S, lat::endl(), cmsPerfPublish::fail(), first, getAverage(), MonitorElement::getFullname(), MonitorElement::getRootObject(), MonitorElement::getTH1F(), MonitorElement::getTH1S(), MonitorElement::getTH2F(), MonitorElement::getTH2S(), h, MonitorElement::kind(), prof2calltree::last, rangeInitialized_, and tolerance_.

 {

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

 int nbins=0;
 //-- TH1F
 if (me->kind()==MonitorElement::DQM_KIND_TH1F){ 
   nbins = me->getTH1F()->GetXaxis()->GetNbins(); 
   h  = me->getTH1F(); // access Test histo
 } 
 //-- TH1S
 else if (me->kind()==MonitorElement::DQM_KIND_TH1S){ 
   nbins = me->getTH1S()->GetXaxis()->GetNbins(); 
   h  = me->getTH1S(); // access Test histo
 } 
 //-- TH2
 else if (me->kind()==MonitorElement::DQM_KIND_TH2F){ 
   nbins = me->getTH2F()->GetXaxis()->GetNbins() *
           me->getTH2F()->GetYaxis()->GetNbins();
   h  = me->getTH2F(); // access Test histo
 } 
 //-- TH2
 else if (me->kind()==MonitorElement::DQM_KIND_TH2S){ 
   nbins = me->getTH2S()->GetXaxis()->GetNbins() *
           me->getTH2S()->GetYaxis()->GetNbins();
   h  = me->getTH2S(); // access Test histo
 } 
 else {  
   std::cout<< "NoisyChannel ERROR: ME " << me->getFullname() << 
   " does not contain TH1F/TH1S or TH2F/TH2S" << std::endl; 
   return -1;
 }

 //--  QUALITY TEST itself 

 if ( !rangeInitialized_ || !h->GetXaxis() ) return 1; // all channels are accepted if tolerance has not been set

  // do NOT use underflow bin
  Int_t first = 1;
  // do NOT use overflow bin
  Int_t last  = nbins;
  // bins outside Y-range
  Int_t fail = 0;
  Int_t bin;
  for (bin = first; bin <= last; ++bin)
  {
    Double_t contents = h->GetBinContent(bin);
    Double_t average = getAverage(bin, h);
    bool failure = false;
    if (average != 0)
      failure = (((contents-average)/TMath::Abs(average)) > tolerance_);

    if (failure)
    {
      ++fail;
      DQMChannel chan(bin, 0, 0, contents, h->GetBinError(bin));
      badChannels_.push_back(chan);
    }
  }

  // return fraction of bins that passed test
  return 1.*(nbins - fail)/nbins;
 }

void NoisyChannel::setMessage

(

void

)

[inline, protected, virtual]

set status & message after test has run

Reimplemented from SimpleTest.

Definition at line 439 of file QTest.h.

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

                         {
      std::ostringstream message;
      message << " Test " << qtname_ << " (" << algoName_
              << "): Fraction of non-noisy channels = " << prob_;
      message_ = message.str();
    }

void NoisyChannel::setNumNeighbors

(

unsigned

n

)

[inline]

set # of neighboring channels for calculating average to be used for comparison with channel under consideration; use 1 for considering bin+1 and bin-1 (default), use 2 for considering bin+1,bin-1, bin+2,bin-2, etc; Will use rollover when bin+i or bin-i is beyond histogram limits (e.g.

for histogram with N bins, bin N+1 corresponds to bin 1, and bin -1 corresponds to bin N)

Definition at line 421 of file QTest.h.

References numNeighbors_.

Referenced by QTestConfigure::EnableNoisyChannelTest().

{ if (n > 0) numNeighbors_ = n; }

void NoisyChannel::setTolerance

(

float

percentage

)

[inline]

set (percentage) tolerance for considering a channel noisy; eg.

if tolerance = 20%, a channel will be noisy if (contents-average)/|average| > 20%; average is calculated from neighboring channels (also see method setNumNeighbors)

Definition at line 427 of file QTest.h.

References rangeInitialized_, and tolerance_.

Referenced by QTestConfigure::EnableNoisyChannelTest().

    {
      if (percentage >=0)
      {
        tolerance_ = percentage;
        rangeInitialized_ = true;
      }
    }

---

Member Data Documentation

TH1* NoisyChannel::h [protected]

Definition at line 446 of file QTest.h.

Referenced by runTest().

unsigned NoisyChannel::numNeighbors_ [protected]

Definition at line 453 of file QTest.h.

Referenced by getAverage(), NoisyChannel(), and setNumNeighbors().

bool NoisyChannel::rangeInitialized_ [protected]

Definition at line 455 of file QTest.h.

Referenced by NoisyChannel(), runTest(), and setTolerance().

float NoisyChannel::tolerance_ [protected]

Definition at line 452 of file QTest.h.

Referenced by runTest(), and setTolerance().

---

The documentation for this class was generated from the following files:

• DQMServices/Core/interface/QTest.h
• DQMServices/Core/src/QTest.cc

---