#include <HcalDeadCellClient.h>

Inheritance diagram for HcalDeadCellClient:

Public Member Functions
void	analyze (DQMStore::IBooker &, DQMStore::IGetter &)

void	beginRun (void)

void	calculateProblems (DQMStore::IBooker &, DQMStore::IGetter &)

void	cleanup (void)

void	endJob (void)

bool	hasErrors_Temp (void)

bool	hasOther_Temp (void)

bool	hasWarnings_Temp (void)

	HcalDeadCellClient ()
	Constructors. More...

	HcalDeadCellClient (std::string myname)

	HcalDeadCellClient (std::string myname, const edm::ParameterSet &ps)

void	setup (void)

bool	test_enabled (void)

void	updateChannelStatus (std::map< HcalDetId, unsigned int > &myqual)

	~HcalDeadCellClient ()
	Destructor. More...

Public Member Functions inherited from HcalBaseDQClient
virtual void	calculateProblems (void)

void	getLogicalMap (const edm::EventSetup &es)

	HcalBaseDQClient ()

	HcalBaseDQClient (std::string s, const edm::ParameterSet &ps)

virtual void	htmlOutput (DQMStore::IBooker &, DQMStore::IGetter &, std::string htmlDir)

std::string	name ()

void	setEventSetup (const edm::EventSetup &es)

virtual void	setStatusMap (std::map< HcalDetId, unsigned int > &map)

virtual bool	validHtmlOutput (DQMStore::IBooker &, DQMStore::IGetter &)

virtual	~HcalBaseDQClient (void)

Private Member Functions
void	setupProblemCells (DQMStore::IBooker &, DQMStore::IGetter &)

Private Attributes
bool	doProblemCellSetup_

bool	excludeHOring2_backup_

int	HBpresent_

int	HEpresent_

int	HFpresent_

int	HOpresent_

int	nevts_

Additional Inherited Members
Public Attributes inherited from HcalBaseDQClient
int	badChannelStatusMask_

std::map< HcalDetId, unsigned int >	badstatusmap

const edm::EventSetup *	c

bool	cloneME_

int	debug_

bool	enableCleanup_

bool	enoughevents_

HcalLogicalMap *	logicalMap_

double	minerrorrate_

int	minevents_

std::string	name_

bool	needLogicalMap_

bool	Online_

std::string	prefixME_

MonitorElement *	ProblemCells

EtaPhiHists *	ProblemCellsByDepth

std::vector< std::string >	problemnames_

std::string	subdir_

bool	testenabled_

bool	validHtmlOutput_

Detailed Description

Definition at line 8 of file HcalDeadCellClient.h.

Constructor & Destructor Documentation

HcalDeadCellClient::HcalDeadCellClient ( )

inline

Constructors.

Definition at line 13 of file HcalDeadCellClient.h.

References HcalBaseDQClient::name_.

13 {name_="";};

HcalBaseDQClient::name_

std::string name_

Definition: HcalBaseDQClient.h:57

HcalDeadCellClient::HcalDeadCellClient ( std::string myname )

Definition at line 18 of file HcalDeadCellClient.cc.

References gather_cfg::cout, and HcalBaseDQClient::name_.

 {
   name_=myname;
   std::cout <<"MY NAME = "<<name_.c_str()<<std::endl;
 }

HcalDeadCellClient::HcalDeadCellClient	(	std::string	myname,
		const edm::ParameterSet &	ps
	)

Definition at line 24 of file HcalDeadCellClient.cc.

 {
   name_=myname;
   enableCleanup_         = ps.getUntrackedParameter<bool>("enableCleanup",false);
   debug_                 = ps.getUntrackedParameter<int>("debug",0);
   prefixME_              = ps.getUntrackedParameter<std::string>("subSystemFolder","Hcal/");
   if (prefixME_.substr(prefixME_.size()-1,prefixME_.size())!="/")
     prefixME_.append("/");
   subdir_                = ps.getUntrackedParameter<std::string>("DeadCellFolder","DeadCellMonitor_Hcal/"); // DeadCellMonitor_Hcal  
   if (subdir_.size()>0 && subdir_.substr(subdir_.size()-1,subdir_.size())!="/")
     subdir_.append("/");
   subdir_=prefixME_+subdir_;
 
   validHtmlOutput_       = ps.getUntrackedParameter<bool>("DeadCell_validHtmlOutput",true);
   cloneME_ = ps.getUntrackedParameter<bool>("cloneME", true);
   badChannelStatusMask_   = ps.getUntrackedParameter<int>("DeadCell_BadChannelStatusMask",
                               ps.getUntrackedParameter<int>("BadChannelStatusMask",
                                             (1<<HcalChannelStatus::HcalCellDead)));  // identify channel status values to mask
   
   minerrorrate_ = ps.getUntrackedParameter<double>("DeadCell_minerrorrate",
                            ps.getUntrackedParameter<double>("minerrorrate",0.25));
   minevents_    = ps.getUntrackedParameter<int>("DeadCell_minevents",
                         ps.getUntrackedParameter<int>("minevents",1000));
 
   excludeHOring2_backup_=ps.getUntrackedParameter<bool>("excludeHOring2_backup",false);  // this is used only if excludeHOring2 value from Dead Cell task can't be read
   Online_                = ps.getUntrackedParameter<bool>("online",false);
 
   ProblemCellsByDepth=0;
   ProblemCells=0;
 
   doProblemCellSetup_ = true;
 
 }

HcalDeadCellClient::~HcalDeadCellClient ( )

Destructor.

Definition at line 436 of file HcalDeadCellClient.cc.

References HcalBaseDQClient::ProblemCellsByDepth.

 {
   if ( ProblemCellsByDepth ) delete ProblemCellsByDepth;
 }

Member Function Documentation

void HcalDeadCellClient::analyze	(	DQMStore::IBooker &	ib,
		DQMStore::IGetter &	ig
	)

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 58 of file HcalDeadCellClient.cc.

References HcalBaseDQClient::calculateProblems(), gather_cfg::cout, HcalBaseDQClient::debug_, doProblemCellSetup_, and setupProblemCells().

 {
   if (debug_>2) std::cout <<"\tHcalDeadCellClient::analyze()"<<std::endl;
   if ( doProblemCellSetup_ ) setupProblemCells(ib,ig);
   calculateProblems(ib,ig);
 }

void HcalDeadCellClient::beginRun ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 300 of file HcalDeadCellClient.cc.

References HcalBaseDQClient::enoughevents_, HBpresent_, HEpresent_, HFpresent_, HOpresent_, and nevts_.

 {
   enoughevents_=false;
   HBpresent_=-1;
   HEpresent_=-1;
   HOpresent_=-1;
   HFpresent_=-1;
 
   nevts_=0;
 }

void HcalDeadCellClient::calculateProblems	(	DQMStore::IBooker &	ib,
		DQMStore::IGetter &	ig
	)

Definition at line 65 of file HcalDeadCellClient.cc.

 {
 
 
   if (debug_>2) std::cout <<"\t\tHcalDeadCellClient::calculateProblems()"<<std::endl;
 
   MonitorElement* temp_present;
 
   temp_present=ig.get(subdir_+"ExcludeHOring2");
   int excludeFromHOring2 = 0;
   if (temp_present)
     {
       excludeFromHOring2 = temp_present->getIntValue();
       if (debug_>2) 
     std::cout <<"Read 'excludeFromHOring2' from HcalMonitorTask output; value = "<<excludeFromHOring2<<std::endl;
     }
   else
     {
       excludeHOring2_backup_==true ?  excludeFromHOring2=1 : excludeFromHOring2=0;
       if (debug_>2) 
     std::cout <<"Could not read excludeFromHOring2 from HcalMonitorTasks; using value from cfg file:  "<<excludeFromHOring2<<std::endl;
     }
   
   // Don't fill histograms if nothing from Hcal is present
   if (HBpresent_!=1)
     {
       temp_present=ig.get(prefixME_+"HcalInfo/HBpresent");
       if (temp_present!=0)
         HBpresent_=temp_present->getIntValue();
     }
   if (HEpresent_!=1)
     {
       temp_present=ig.get(prefixME_+"HcalInfo/HEpresent");
       if (temp_present!=0)
         HEpresent_=temp_present->getIntValue();
     }
   if (HOpresent_!=1)
     {
       temp_present=ig.get(prefixME_+"HcalInfo/HOpresent");
       if (temp_present!=0)
         HOpresent_=temp_present->getIntValue();
     }
   if (HFpresent_!=1)
     {
       temp_present=ig.get(prefixME_+"HcalInfo/HFpresent");
       if (temp_present!=0)
         HFpresent_=temp_present->getIntValue();
     }
   // Never saw any data from any Hcal FED; don't count as dead.
   if (HBpresent_==-1 && HEpresent_==-1 && HOpresent_==-1 && HFpresent_==-1)
     return;
   double totalevents=0;
   int etabins=0, phibins=0, zside=0;
   double problemvalue=0;
 
   // Clear away old problems
   if (ProblemCells!=0)
     {
       ProblemCells->Reset();
       (ProblemCells->getTH2F())->SetMaximum(1.05);
       (ProblemCells->getTH2F())->SetMinimum(0.);
     }
   for  (unsigned int d=0;ProblemCellsByDepth!=0 && d<ProblemCellsByDepth->depth.size();++d)
     {
       if (ProblemCellsByDepth->depth[d]!=0) 
     {
       ProblemCellsByDepth->depth[d]->Reset();
       (ProblemCellsByDepth->depth[d]->getTH2F())->SetMaximum(1.05);
       (ProblemCellsByDepth->depth[d]->getTH2F())->SetMinimum(0.);
     }
     }
   
   // Get histograms that are used in testing
   TH2F* DigiPresentByDepth[4];
   TH2F* RecentMissingDigisByDepth[4];
   TH2F* RecHitsPresentByDepth[4];
   TH2F* RecentMissingRecHitsByDepth[4];
 
   std::vector<std::string> name = HcalEtaPhiHistNames();
 
   MonitorElement* me;
   for (int i=0;i<4;++i)
     {
       // Assume that histograms can't be found
       DigiPresentByDepth[i]=0;
       RecentMissingDigisByDepth[i]=0;
       RecHitsPresentByDepth[i]=0;
       RecentMissingRecHitsByDepth[i]=0;
       
       std::string s=subdir_+"dead_digi_never_present/"+name[i]+"Digi Present At Least Once";
       me=ig.get(s.c_str());
       if (me!=0) DigiPresentByDepth[i]=HcalUtilsClient::getHisto<TH2F*>(me, cloneME_, DigiPresentByDepth[i], debug_);
       
       s=subdir_+"dead_digi_often_missing/"+name[i]+"Dead Cells with No Digis";
       me=ig.get(s.c_str());
       if (me!=0) RecentMissingDigisByDepth[i]=HcalUtilsClient::getHisto<TH2F*>(me, cloneME_, RecentMissingDigisByDepth[i], debug_);
      
       s=subdir_+"dead_rechit_never_present/"+name[i]+"RecHit Above Threshold At Least Once";
       me=ig.get(s.c_str());
       if (me!=0) RecHitsPresentByDepth[i]=HcalUtilsClient::getHisto<TH2F*>(me, cloneME_, RecHitsPresentByDepth[i], debug_);
 
        s=subdir_+"dead_rechit_often_missing/"+name[i]+"RecHits Failing Energy Threshold Test";
       me=ig.get(s.c_str());
       if (me!=0)RecentMissingRecHitsByDepth[i]=HcalUtilsClient::getHisto<TH2F*>(me, cloneME_, RecentMissingRecHitsByDepth[i], debug_);
 
     }
 
   // Because we're clearing and re-forming the problem cell histogram here, we don't need to do any cute
   // setting of the underflow bin to 0, and we can plot results as a raw rate between 0-1.
   
   for (unsigned int d=0;ProblemCellsByDepth!=0 && d<ProblemCellsByDepth->depth.size();++d)
     {
       if (ProblemCellsByDepth->depth[d]==0) continue;
 
       if (DigiPresentByDepth[d]==0) continue;
       // Get number of entries from DigiPresent histogram 
       // (need to do this for offline DQM combinations of output)
       totalevents=DigiPresentByDepth[d]->GetBinContent(0);
       if (totalevents==0 || totalevents<minevents_) continue;
       enoughevents_=true; // kind of a hack here
       etabins=(ProblemCellsByDepth->depth[d]->getTH2F())->GetNbinsX();
       phibins=(ProblemCellsByDepth->depth[d]->getTH2F())->GetNbinsY();
       problemvalue=0;
       for (int eta=0;eta<etabins;++eta)
     {
       int ieta=CalcIeta(eta,d+1);
       if (ieta==-9999) continue;
 
       for (int phi=0;phi<phibins;++phi)
         {
           problemvalue=0;
           // Don't count problems in HO ring 2 if the "excludeFromHOring2" bit is in use
           if (isHO(eta,d+1) && excludeFromHOring2>0 && isSiPM(ieta,phi+1,d+1)==false && abs(ieta)>10)
         continue;
 
           // Never-present histogram is a boolean, with underflow bin = 1 (for each instance)
           // Offline DQM adds up never-present histograms from multiple outputs
           // For now, we want offline DQM to show LS-based 'occupancies', rather than simple boolean on/off
           // May change in the future?
           
           // If cell is never-present in all runs, then problemvalue = event
           if (DigiPresentByDepth[d]!=0 && DigiPresentByDepth[d]->GetBinContent(eta+1,phi+1)==0) 
         problemvalue=totalevents;
 
           // Rec Hit presence test
           else if (RecHitsPresentByDepth[d]!=0)
         {
           if (RecHitsPresentByDepth[d]->GetBinContent(eta+1,phi+1)==0)
             problemvalue=totalevents;
           else if (RecHitsPresentByDepth[d]->GetBinContent(eta+1,phi+1)>1)
             RecHitsPresentByDepth[d]->SetBinContent(eta+1,phi+1,1);
         }
           else
         {
           if (RecentMissingDigisByDepth[d]!=0)
             problemvalue+=RecentMissingDigisByDepth[d]->GetBinContent(eta+1,phi+1);
           if (RecentMissingRecHitsByDepth[d]!=0)
             problemvalue+=RecentMissingRecHitsByDepth[d]->GetBinContent(eta+1,phi+1);
         }
           
           if (problemvalue==0) continue;
                           
           problemvalue/=totalevents; // problem value is a rate; should be between 0 and 1
           problemvalue = std::min(1.,problemvalue);
           
           zside=0;
           if (isHF(eta,d+1)) // shift ieta by 1 for HF
         ieta<0 ? zside = -1 : zside = 1;
           
           // For problem cells that exceed our allowed rate,
           // set the values to -1 if the cells are already marked in the status database
           if (problemvalue>minerrorrate_)
         {
           HcalSubdetector subdet=HcalEmpty;
           if (isHB(eta,d+1))subdet=HcalBarrel;
           else if (isHE(eta,d+1)) subdet=HcalEndcap;
           else if (isHF(eta,d+1)) subdet=HcalForward;
           else if (isHO(eta,d+1)) subdet=HcalOuter;
           HcalDetId hcalid(subdet, ieta, phi+1, (int)(d+1));
           if (badstatusmap.find(hcalid)!=badstatusmap.end())
             problemvalue=999;
         }
           ProblemCellsByDepth->depth[d]->setBinContent(eta+1,phi+1,problemvalue);
           if (ProblemCells!=0) ProblemCells->Fill(ieta+zside,phi+1,problemvalue);
         } // loop on phi
     } // loop on eta
     } // loop on depth
 
   if (ProblemCells==0)
     {
       if (debug_>0) std::cout <<"<HcalDeadCellClient::analyze> ProblemCells histogram does not exist!"<<std::endl;
       return;
     }
 
   // Normalization of ProblemCell plot, in the case where there are errors in multiple depths
   etabins=(ProblemCells->getTH2F())->GetNbinsX();
   phibins=(ProblemCells->getTH2F())->GetNbinsY();
   for (int eta=0;eta<etabins;++eta)
     {
       for (int phi=0;phi<phibins;++phi)
     {
       if (ProblemCells->getBinContent(eta+1,phi+1)>1. && ProblemCells->getBinContent(eta+1,phi+1)<999)
         ProblemCells->setBinContent(eta+1,phi+1,1.);
     }
     }
 
   FillUnphysicalHEHFBins(*ProblemCellsByDepth);
   FillUnphysicalHEHFBins(ProblemCells);
   return;
 }

void HcalDeadCellClient::cleanup ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 314 of file HcalDeadCellClient.cc.

Referenced by esMonitoring.FDJsonServer::handle_close().

314 {}

void HcalDeadCellClient::endJob ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 276 of file HcalDeadCellClient.cc.

276 {}

bool HcalDeadCellClient::hasErrors_Temp ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 316 of file HcalDeadCellClient.cc.

References HcalObjRepresent::CalcIeta(), gather_cfg::cout, HcalBaseDQClient::debug_, EtaPhiHists::depth, HLT_25ns14e33_v1_cff::depth, MonitorElement::getTH2F(), HcalBaseDQClient::minerrorrate_, HcalBaseDQClient::ProblemCells, and HcalBaseDQClient::ProblemCellsByDepth.

 {
   if (!ProblemCells)
     {
       if (debug_>1) std::cout <<"<HcalDeadCellClient::hasErrors_Temp>  ProblemCells histogram does not exist!"<<std::endl;
       return false;
     }
   int problemcount=0;
   int ieta=-9999;
 
   for (int depth=0;depth<4; ++depth)
     {
       int etabins  = (ProblemCells->getTH2F())->GetNbinsX();
       int phibins  = (ProblemCells->getTH2F())->GetNbinsY();
       for (int hist_eta=0;hist_eta<etabins;++hist_eta)
         {
           for (int hist_phi=0; hist_phi<phibins;++hist_phi)
             {
               ieta=CalcIeta(hist_eta,depth+1);
           if (ieta==-9999) continue;
           if (ProblemCellsByDepth->depth[depth]==0)
         continue;
           if (ProblemCellsByDepth->depth[depth]->getBinContent(hist_eta,hist_phi)>minerrorrate_)
         ++problemcount;
         } // for (int hist_phi=1;...)
     } // for (int hist_eta=1;...)
     } // for (int depth=0;...)
   
   if (problemcount>0) return true;
   return false;
 }

bool HcalDeadCellClient::hasOther_Temp ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 349 of file HcalDeadCellClient.cc.

349 {return false;}

bool HcalDeadCellClient::hasWarnings_Temp ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 348 of file HcalDeadCellClient.cc.

348 {return false;}

void HcalDeadCellClient::setup ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 313 of file HcalDeadCellClient.cc.

313 {}

void HcalDeadCellClient::setupProblemCells	(	DQMStore::IBooker &	ib,
		DQMStore::IGetter &	ig
	)

private

Definition at line 278 of file HcalDeadCellClient.cc.

References DQMStore::IBooker::book2D(), gather_cfg::cout, HcalBaseDQClient::debug_, EtaPhiHists::depth, doProblemCellSetup_, MonitorElement::getName(), i, HcalBaseDQClient::ProblemCells, HcalBaseDQClient::ProblemCellsByDepth, HcalBaseDQClient::problemnames_, DQMStore::IBooker::setCurrentFolder(), EtaPhiHists::setup(), and HcalBaseDQClient::subdir_.

Referenced by analyze().

 {
 
   ib.setCurrentFolder(subdir_);
   problemnames_.clear();
   ProblemCells=ib.book2D(" ProblemDeadCells",
                  " Problem Dead Cell Rate for all HCAL;ieta;iphi",
                  85,-42.5,42.5,
                  72,0.5,72.5);
   problemnames_.push_back(ProblemCells->getName());
   if (debug_>1)
     std::cout << "Tried to create ProblemCells Monitor Element in directory "<<subdir_<<"  \t  Failed?  "<<(ProblemCells==0)<<std::endl;
   ib.setCurrentFolder(subdir_+"problem_deadcells");
   ProblemCellsByDepth = new EtaPhiHists();
   ProblemCellsByDepth->setup(ib," Problem Dead Cell Rate");
   for (unsigned int i=0; i<ProblemCellsByDepth->depth.size();++i)
     problemnames_.push_back(ProblemCellsByDepth->depth[i]->getName());
 
   doProblemCellSetup_ = false;
 
 }

bool HcalDeadCellClient::test_enabled ( void )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 350 of file HcalDeadCellClient.cc.

350 {return true;}

void HcalDeadCellClient::updateChannelStatus ( std::map< HcalDetId, unsigned int > & myqual )

virtual

Reimplemented from HcalBaseDQClient.

Definition at line 354 of file HcalDeadCellClient.cc.

References HcalObjRepresent::CalcIeta(), gather_cfg::cout, ztail::d, HcalBaseDQClient::debug_, EtaPhiHists::depth, HcalBaseDQClient::enoughevents_, HcalBarrel, HcalChannelStatus::HcalCellDead, HcalEndcap, HcalForward, HcalOuter, isHB(), isHE(), isHF(), HcalBaseDQClient::minerrorrate_, HcalBaseDQClient::ProblemCellsByDepth, and validDetId().

 {
   // This gets called by HcalMonitorClient
 
   if (enoughevents_==false) return; // not enough events to make judgment; don't create new status file
 
   float binval;
   int ieta=0;
   int iphi=0;
   int etabins=0;
   int phibins=0;
   
   int subdet=0;
   if (debug_>1)
     {
       std::cout <<"<HcalDeadCellClient>  Summary of Dead Cells in Run: "<<std::endl;
       std::cout <<"(Error rate must be >= "<<minerrorrate_*100.<<"% )"<<std::endl;  
     }
   for (int d=0;d<4;++d)
     {
       etabins=(ProblemCellsByDepth->depth[d]->getTH2F())->GetNbinsX();
       phibins=(ProblemCellsByDepth->depth[d]->getTH2F())->GetNbinsY();
       for (int hist_eta=0;hist_eta<etabins;++hist_eta)
     {
       ieta=CalcIeta(hist_eta,d+1);
       if (ieta==-9999) continue;
       for (int hist_phi=0;hist_phi<phibins;++hist_phi)
         {
           iphi=hist_phi+1;
           
           // ProblemCells have already been normalized
           binval=ProblemCellsByDepth->depth[d]->getBinContent(hist_eta+1,hist_phi+1);
           
           // Set subdetector labels for output
           if (d<2)
         {
           if (isHB(hist_eta,d+1)) 
             subdet=HcalBarrel;
           else if (isHE(hist_eta,d+1)) 
             subdet=HcalEndcap;
           else if (isHF(hist_eta,d+1)) 
             subdet=HcalForward;
         }
           else if (d==2) 
         subdet=HcalEndcap;
           else if (d==3) 
         subdet=HcalOuter;
           // Set correct depth label
           
           HcalDetId myid((HcalSubdetector)(subdet), ieta, iphi, d+1);
           // Need this to keep from flagging non-existent HE/HF cells
           if (!validDetId((HcalSubdetector)(subdet), ieta, iphi, d+1))
         continue;
           
           int deadcell=0;
           if (binval>minerrorrate_)
         deadcell=1;
           if (deadcell==1 && debug_>0)
         std::cout <<"Dead Cell :  subdetector = "<<subdet<<" (eta,phi,depth) = ("<<ieta<<", "<<iphi<<", "<<d+1<<"):  "<<binval*100.<<"%"<<std::endl;
           
           // DetID not found in quality list; add it.  
           if (myqual.find(myid)==myqual.end())
         myqual[myid]=(deadcell<<HcalChannelStatus::HcalCellDead);  // deadcell shifted to bit 6
           else
         {
           int mask=(1<<HcalChannelStatus::HcalCellDead);
           // dead cell found; 'or' the dead cell mask with existing ID
           if (deadcell==1)
             myqual[myid] |=mask;
           // cell is not found, 'and' the inverse of the mask with the existing ID.
           // Does this work correctly?  I think so, but need to verify.
           // Also, do we want to allow the client to turn off dead cell masks, or only add them?
           else
             myqual[myid] &=~mask;
         }
         } // for (int hist_phi=1;hist_phi<=phibins;++hist_phi)
     } // for (int hist_eta=1;hist_eta<=etabins;++hist_eta)
     } // for (int d=0;d<4;++d)
   
   
 } //void HcalDeadCellClient::updateChannelStatus