#include <DQMClientExample.h>

Inheritance diagram for DQMClientExample:

Public Member Functions
	DQMClientExample (const edm::ParameterSet &ps)

	~DQMClientExample () override

Public Member Functions inherited from edm::EDAnalyzer
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzer ()

ModuleDescription const &	moduleDescription () const

std::string	workerType () const

	~EDAnalyzer () override

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

virtual	~EDConsumerBase () noexcept(false)

Protected Member Functions
void	analyze (const edm::Event &e, const edm::EventSetup &c) override

void	beginJob () override

void	beginLuminosityBlock (const edm::LuminosityBlock &lumiSeg, const edm::EventSetup &context) override

void	beginRun (const edm::Run &r, const edm::EventSetup &c) override

void	endJob () override

void	endLuminosityBlock (const edm::LuminosityBlock &lumiSeg, const edm::EventSetup &c) override

void	endRun (const edm::Run &r, const edm::EventSetup &c) override

void	performClient ()

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Private Member Functions
void	initialize ()

Private Attributes
MonitorElement *	clientHisto

bool	clientOnEachEvent

bool	clientOnEndJob

bool	clientOnEndLumi

bool	clientOnEndRun

int	counterClientOperation

int	counterEvt_

int	counterLS_

DQMStore *	dbe_

std::string	monitorName_

edm::ParameterSet	parameters_

int	prescaleEvt_

int	prescaleLS_

std::string	QTestName_

Additional Inherited Members
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Detailed Description

DQM Test Client

Author
M. Zanetti CERN

Definition at line 31 of file DQMClientExample.h.

Constructor & Destructor Documentation

DQMClientExample::DQMClientExample ( const edm::ParameterSet & ps )

Definition at line 37 of file DQMClientExample.cc.

References initialize().

 {
   parameters_=ps;
   initialize();
 }

DQMClientExample::~DQMClientExample ( )

override

Definition at line 43 of file DQMClientExample.cc.

43 {

44 }

Member Function Documentation

void DQMClientExample::analyze	(	const edm::Event &	e,
		const edm::EventSetup &	c
	)

overrideprotected

Definition at line 113 of file DQMClientExample.cc.

                                                                        {
   counterEvt_++;
   if(clientOnEachEvent){
    if (prescaleEvt_>0 && counterEvt_ % prescaleEvt_ == 0) performClient();
   }
 }

void DQMClientExample::beginJob ( void )

overrideprotectedvirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 86 of file DQMClientExample.cc.

References dbe_, and Utilities::operator.

                                {
 
   dbe_ = Service<DQMStore>().operator->();
 
   dbe_->setCurrentFolder(monitorName_+"DQMclient");
   clientHisto = dbe_->book1D("clientHisto", "Guassian fit results.", 2, 0, 1);
 }

void DQMClientExample::beginLuminosityBlock	(	const edm::LuminosityBlock &	lumiSeg,
		const edm::EventSetup &	context
	)

overrideprotected

Definition at line 105 of file DQMClientExample.cc.

                                                                                                      {
    // optionally reset histograms here
    // clientHisto->Reset();
 }

void DQMClientExample::beginRun	(	const edm::Run &	r,
		const edm::EventSetup &	c
	)

overrideprotected

Definition at line 99 of file DQMClientExample.cc.

99 {

100 }

void DQMClientExample::endJob ( void )

overrideprotectedvirtual

Reimplemented from edm::EDAnalyzer.

Definition at line 139 of file DQMClientExample.cc.

References gather_cfg::cout.

                              {
    std::cout << "DQMSourceClient::endJob()" << std::endl;
    if(clientOnEndJob) performClient();
 }

void DQMClientExample::endLuminosityBlock	(	const edm::LuminosityBlock &	lumiSeg,
		const edm::EventSetup &	c
	)

overrideprotected

Definition at line 123 of file DQMClientExample.cc.

                                                                                                    {
  counterLS_ ++;
   if(!clientOnEachEvent && clientOnEndLumi){
   if( prescaleLS_ > 0  && counterLS_ % prescaleLS_ == 0) performClient();
  } 
 }

void DQMClientExample::endRun	(	const edm::Run &	r,
		const edm::EventSetup &	c
	)

overrideprotected

Definition at line 132 of file DQMClientExample.cc.

                                                                     {
   if(clientOnEndRun) performClient();
 }

void DQMClientExample::initialize ( )

private

Definition at line 49 of file DQMClientExample.cc.

References gather_cfg::cout, dbe_, and Utilities::operator.

                                  { 
 
   counterEvt_=0;   counterLS_  = 0; 
   counterClientOperation = 0;
   
   dbe_ = Service<DQMStore>().operator->();
   
   monitorName_ = parameters_.getUntrackedParameter<string>("monitorName","YourSubsystemName");
   cout << "DQMClientExample: Monitor name = " << monitorName_ << endl;
   if (monitorName_ != "" ) monitorName_ = monitorName_+"/" ;
 
   prescaleLS_  = parameters_.getUntrackedParameter<int>("prescaleLS",  -1);
   cout << "DQMClientExample: DQM lumi section prescale = " << prescaleLS_ << " lumi section(s)"<< endl;
   prescaleEvt_ = parameters_.getUntrackedParameter<int>("prescaleEvt", -1);
   cout << "DQMClientExample: DQM event prescale = " << prescaleEvt_ << " events(s)"<< endl;
 
   //-- QTestName that is going to bu run on clienHisto, as defined in XML file
   QTestName_ = parameters_.getUntrackedParameter<string>("QTestName","exampleQTest");  
   cout << "DQMClientExample: QTest name to be ran on clientHisto = " << QTestName_ << endl;
   //-- define where to run the Client
   clientOnEachEvent  = parameters_.getUntrackedParameter<bool>("clientOnEachEvent",false);
   if(clientOnEachEvent) cout << "DQMClientExample: run Client on each event" << endl;
   clientOnEndLumi  = parameters_.getUntrackedParameter<bool>("clientOnEndLumi",true);
   if(clientOnEndLumi) cout << "DQMClientExample: run Client at the end of each lumi section" << endl;
   clientOnEndRun   = parameters_.getUntrackedParameter<bool>("clientOnEndRun",false);
   if(clientOnEndRun) cout << "DQMClientExample: run Client at the end of each run" << endl;
   clientOnEndJob   = parameters_.getUntrackedParameter<bool>("clientOnEndJob",false);
   if(clientOnEndJob) cout << "DQMClientExample: run Client at the end of the job" << endl;
 
 }

void DQMClientExample::performClient ( )

protected

Definition at line 148 of file DQMClientExample.cc.

References gather_cfg::cout, dbe_, connectstrParser::f1, QReport::getBadChannels(), QReport::getMessage(), QReport::getStatus(), MonitorElement::getTH1F(), SiStripPI::mean, and SiStripPI::rms.

                                     {
 
    std::cout << "***** run  Client operations as defined in: *****" << std::endl;
    std::cout << "***** DQMClientExample::performClient    ********" << std::endl;
 
   //----------------------------------------------------------------------------------------------
   // example how to retrieve a ME created by the DQM producer (in Examples/src/DQMSourceExample.cc) 
   //---------------------------------------------------------------------------------------------
    float mean =0;  float rms = 0;
   
   string histoName = monitorName_ + "DQMsource/C1/histo2";
   MonitorElement * meHisto = dbe_->get(histoName);
   if (meHisto) { 
     if (TH1F *rootHisto = meHisto->getTH1F()) {
       if(counterClientOperation<1)
       std::cout<<"=== DQMClientExample::performClient => the histo is found: entries="<< rootHisto->GetEntries() << "\n" 
               <<" mean=" << rootHisto->GetMean() << " rms=" << rootHisto->GetRMS() << std::endl;
 
       TF1 *f1 = new TF1("f1","gaus",1,3);
       rootHisto->Fit(f1);
       mean = f1->GetParameter(1);
       rms = f1->GetParameter(2);
     }
   clientHisto->setBinContent(1,mean);
   clientHisto->setBinContent(2,rms);
   }
 
   else { //when it is not found !
   clientHisto->setBinContent(1,-1);
   clientHisto->setBinContent(2,-1);
  if(counterClientOperation<1)  edm::LogError ("DQMClientExample") <<"--- The following ME :"<< histoName <<" cannot be found\n" 
                            <<"--- on the DQM source side !\n";
   }
  
   //----------------------------------------------------------------------------------------------
   // example  how to access the Quality test result for clientHisto
   //---------------------------------------------------------------------------------------------
 
  // qtest to be ran on clientHisto is defined in Examples/test/QualityTests.xml
   const QReport * theQReport = clientHisto->getQReport(QTestName_);
   if(theQReport) {
     if(counterClientOperation<1)
     edm::LogWarning ("DQMClientExample") <<"*** Summary of Quality Test for clientHisto: \n"
                                        //<<"---  value  ="<< theQReport->getQTresult()<<"\n"
                                       <<"--- status ="<< theQReport->getStatus() << "\n"
                                       <<"--- message ="<< theQReport->getMessage() << "\n";
 
    vector<dqm::me_util::Channel> badChannels = theQReport->getBadChannels();
     for (vector<dqm::me_util::Channel>::iterator channel = badChannels.begin(); 
      channel != badChannels.end(); channel++) {
         if(counterClientOperation<1) 
         edm::LogError ("DQMClientExample") <<" Bad channels: "<<(*channel).getBin()<<" "<<(*channel).getContents();
     }
   } 
   else { 
   if(counterClientOperation<1) edm::LogError ("DQMClientExample") <<"--- No QReport is found for clientHisto!\n"
   << "--- Please check your XML and config files -> QTestName ( " << QTestName_ << " )must be the same!\n";
   }
 
  counterClientOperation++;
 }

Member Data Documentation

MonitorElement* DQMClientExample::clientHisto

private

Definition at line 89 of file DQMClientExample.h.

bool DQMClientExample::clientOnEachEvent

private

Definition at line 83 of file DQMClientExample.h.

bool DQMClientExample::clientOnEndJob

private

Definition at line 86 of file DQMClientExample.h.

bool DQMClientExample::clientOnEndLumi

private

Definition at line 84 of file DQMClientExample.h.

bool DQMClientExample::clientOnEndRun

private

Definition at line 85 of file DQMClientExample.h.

int DQMClientExample::counterClientOperation

private

Definition at line 78 of file DQMClientExample.h.

int DQMClientExample::counterEvt_

private

Definition at line 79 of file DQMClientExample.h.

int DQMClientExample::counterLS_

private

Definition at line 80 of file DQMClientExample.h.

DQMStore* DQMClientExample::dbe_

private

Definition at line 75 of file DQMClientExample.h.

std::string DQMClientExample::monitorName_

private

Definition at line 76 of file DQMClientExample.h.

edm::ParameterSet DQMClientExample::parameters_

private

Definition at line 73 of file DQMClientExample.h.

Referenced by Mixins._TypedParameterizable::clone(), Types.PSet::clone(), and Mixins._TypedParameterizable::copy().

int DQMClientExample::prescaleEvt_

private

Definition at line 81 of file DQMClientExample.h.

int DQMClientExample::prescaleLS_

private

Definition at line 82 of file DQMClientExample.h.

std::string DQMClientExample::QTestName_

private

Definition at line 77 of file DQMClientExample.h.

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation