CSCMonitorModule Class Reference

Common CSC DQM Module that uses CSCDQM Framework. More...

#include <CSCMonitorModule.h>

Inheritance diagram for CSCMonitorModule:

Public Member Functions
cscdqm::MonitorObject *	bookMonitorObject (const cscdqm::HistoBookRequest &p_req)
	Book Monitor Object on Request. More...
	CSCMonitorModule (const edm::ParameterSet &ps)
	Constructor. More...
bool	getCSCDetId (const unsigned int crateId, const unsigned int dmbId, CSCDetId &detId) const
virtual	~CSCMonitorModule ()
	Destructor. More...
Public Member Functions inherited from DQMEDAnalyzer
virtual void	beginRun (edm::Run const &, edm::EventSetup const &) final
virtual void	beginStream (edm::StreamID id) final
virtual void	dqmBeginRun (edm::Run const &, edm::EventSetup const &)
	DQMEDAnalyzer (void)
virtual void	endLuminosityBlockSummary (edm::LuminosityBlock const &, edm::EventSetup const &, dqmDetails::NoCache *) const final
virtual void	endRunSummary (edm::Run const &, edm::EventSetup const &, dqmDetails::NoCache *) const final
uint32_t	streamId () const
Public Member Functions inherited from edm::stream::EDAnalyzer< edm::RunSummaryCache< dqmDetails::NoCache >, edm::LuminosityBlockSummaryCache< dqmDetails::NoCache > >
	EDAnalyzer ()=default
Public Member Functions inherited from edm::stream::EDAnalyzerBase
	EDAnalyzerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDAnalyzerBase ()
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Protected Member Functions
void	analyze (const edm::Event &e, const edm::EventSetup &c)
	Begin the run. More...
void	beginJob ()
void	beginLuminosityBlock (const edm::LuminosityBlock &lumiSeg, const edm::EventSetup &context)
void	bookHistograms (DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &) override
	Book Histograms in the beginRun. More...
void	endJob ()
void	endRun (const edm::Run &r, const edm::EventSetup &c)
void	setup ()
Protected Member Functions inherited from edm::stream::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
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 Attributes
cscdqm::Configuration	config
cscdqm::Dispatcher *	dispatcher
DQMStore::IBooker *	ibooker
edm::InputTag	inputTag
std::vector< std::string >	maskedHW
const CSCCrateMap *	pcrate
bool	prebookEffParams
bool	processDcsScalers

Additional Inherited Members
Public Types inherited from edm::stream::EDAnalyzer< edm::RunSummaryCache< dqmDetails::NoCache >, edm::LuminosityBlockSummaryCache< dqmDetails::NoCache > >
typedef CacheContexts< T...>	CacheTypes
typedef CacheTypes::GlobalCache	GlobalCache
typedef AbilityChecker< T...>	HasAbility
typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache
typedef LuminosityBlockContextT < LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext
typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache
typedef CacheTypes::RunCache	RunCache
typedef RunContextT< RunCache, GlobalCache >	RunContext
typedef CacheTypes::RunSummaryCache	RunSummaryCache
Public Types inherited from edm::stream::EDAnalyzerBase
typedef EDAnalyzerAdaptorBase	ModuleType
Static Public Member Functions inherited from DQMEDAnalyzer
static std::shared_ptr < dqmDetails::NoCache >	globalBeginLuminosityBlockSummary (edm::LuminosityBlock const &, edm::EventSetup const &, LuminosityBlockContext const *)
static std::shared_ptr < dqmDetails::NoCache >	globalBeginRunSummary (edm::Run const &, edm::EventSetup const &, RunContext const *)
static void	globalEndLuminosityBlockSummary (edm::LuminosityBlock const &, edm::EventSetup const &, LuminosityBlockContext const *, dqmDetails::NoCache *)
static void	globalEndRunSummary (edm::Run const &, edm::EventSetup const &, RunContext const *, dqmDetails::NoCache *)
Static Public Member Functions inherited from edm::stream::EDAnalyzerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Detailed Description

Common CSC DQM Module that uses CSCDQM Framework.

Definition at line 77 of file CSCMonitorModule.h.

Constructor & Destructor Documentation

CSCMonitorModule::CSCMonitorModule

(

const edm::ParameterSet &

ps

)

Constructor.

Global stuff

Parameters

ps	Parameters.

Definition at line 25 of file CSCMonitorModule.cc.

References config, edm::EDConsumerBase::consumesCollector(), dispatcher, edm::ParameterSet::exists(), edm::FileInPath::fullPath(), edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), cscdqm::Dispatcher::init(), INPUT_TAG_LABEL, inputTag, HLT_25ns14e33_v1_cff::InputTag, maskedHW, prebookEffParams, and processDcsScalers.

                                                            {

  edm::FileInPath fp;

  inputTag = ps.getUntrackedParameter<edm::InputTag>("InputObjects", (edm::InputTag)INPUT_TAG_LABEL);
  prebookEffParams = ps.getUntrackedParameter<bool>("PREBOOK_EFF_PARAMS", false);
  processDcsScalers = ps.getUntrackedParameter<bool>("PROCESS_DCS_SCALERS", true);
  edm::ParameterSet params = ps.getUntrackedParameter<edm::ParameterSet>("EventProcessor");
  config.load(params);

  fp = ps.getParameter<edm::FileInPath>("BOOKING_XML_FILE");
  config.setBOOKING_XML_FILE(fp.fullPath());
    
  // dbe = edm::Service<DQMStore>().operator->();

#ifdef DQMLOCAL
  dispatcher = new cscdqm::Dispatcher(&config, const_cast<CSCMonitorModule*>(this));
#endif
#ifdef DQMGLOBAL
  //  edm::ConsumesCollector coco( consumesCollector() );
  dispatcher = new cscdqm::Dispatcher(&config, const_cast<CSCMonitorModule*>(this), 
                      inputTag, consumesCollector() );
  dcstoken = consumes<DcsStatusCollection>(edm::InputTag("scalersRawToDigi") );

#endif

  dispatcher->init();

  if (ps.exists("MASKEDHW")) {
    maskedHW = ps.getUntrackedParameter<std::vector<std::string> >("MASKEDHW");
    //dispatcher->maskHWElements(maskedHW);
  }

}

CSCMonitorModule::~CSCMonitorModule ( )

virtual

Destructor.

Definition at line 63 of file CSCMonitorModule.cc.

References dispatcher.

                                    {
  if (dispatcher) delete dispatcher;
}

Member Function Documentation

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

protectedvirtual

Begin the run.

Parameters

r	Run object
c	Event setup Analyze Event.
e	Event to analyze
c	Event Setup

Implements edm::stream::EDAnalyzerBase.

Definition at line 88 of file CSCMonitorModule.cc.

References cscdqm::HWStandbyType::applyMeM(), cscdqm::HWStandbyType::applyMeP(), DcsStatus::CSCm, DcsStatus::CSCp, dispatcher, edm::EventSetup::get(), edm::Event::getByToken(), inputTag, pcrate, cscdqm::HWStandbyType::process, processDcsScalers, and edm::ESHandle< class >::product().

                                                                        {

  // Get crate mapping from database
  edm::ESHandle<CSCCrateMap> hcrate;
  c.get<CSCCrateMapRcd>().get(hcrate);
  pcrate = hcrate.product();

  cscdqm::HWStandbyType standby;

  // Get DCS status scalers
  if (processDcsScalers) {
    edm::Handle<DcsStatusCollection> dcsStatus;
#ifdef DQMLOCAL
    if (e.getByToken(dcstoken, dcsStatus)) {
#endif
#ifdef DQMGLOBAL
    if (e.getByToken(dcstoken, dcsStatus) ) {
#endif
      DcsStatusCollection::const_iterator dcsStatusItr = dcsStatus->begin();
      for (; dcsStatusItr != dcsStatus->end(); ++dcsStatusItr) {
        standby.applyMeP(dcsStatusItr->ready(DcsStatus::CSCp));
        standby.applyMeM(dcsStatusItr->ready(DcsStatus::CSCm));
      }
    }
    standby.process = true;
  }

void CSCMonitorModule::beginJob ( void  )

inlineprotected

EDAnalyzer Implementation

Definition at line 130 of file CSCMonitorModule.h.

{ }

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

inlineprotectedvirtual

Reimplemented from edm::stream::EDAnalyzerBase.

Definition at line 134 of file CSCMonitorModule.h.

{ }

void CSCMonitorModule::bookHistograms ( DQMStore::IBooker &  ib, edm::Run const &  , edm::EventSetup const &    )

overrideprotectedvirtual

Book Histograms in the beginRun.

Parameters

ib	- DQMStore::IBooker interface access object
edm::Run	const & - not used
edm::EventSetup	const & - not used

Store pointer to IBooker to use it in ::bookMonitorObject() callback function used by the Dispatcher::book() method

Call Dispatcher histogram booking method to pre-boook all available histograms before processing data. New PREBOOK_ALL_HISTOS config option should be set to true (default). That should disable original CSC on-the-fly histo booking during data processing. Changed for multi-threaded framework compatibility. (pre-booking of all histos is not most efficient way for CSCi DQM).

Implements DQMEDAnalyzer.

Definition at line 125 of file CSCMonitorModule.cc.

References cscdqm::Dispatcher::book(), dispatcher, cuy::ib, ibooker, maskedHW, cscdqm::Dispatcher::maskHWElements(), prebookEffParams, and cscdqm::Dispatcher::updateFractionAndEfficiencyHistos().

{
  ibooker = &ib;
  
  dispatcher->book();

  if (maskedHW.size() != 0)
     dispatcher->maskHWElements(maskedHW);
  if (prebookEffParams) {
    dispatcher->updateFractionAndEfficiencyHistos();
  }
  
}

cscdqm::MonitorObject * CSCMonitorModule::bookMonitorObject ( const cscdqm::HistoBookRequest &  req )

virtual

Book Monitor Object on Request.

Parameters

req

Request.

Returns

MonitorObject created.

Implements cscdqm::MonitorObjectProvider.

Definition at line 154 of file CSCMonitorModule.cc.

References DQMStore::IBooker::book1D(), DQMStore::IBooker::book2D(), DQMStore::IBooker::book3D(), DQMStore::IBooker::bookFloat(), DQMStore::IBooker::bookInt(), DQMStore::IBooker::bookProfile(), DQMStore::IBooker::bookProfile2D(), DQMStore::IBooker::bookString(), DQMStore::IBooker::cd(), cscdqm::HistoBookRequest::default_float, cscdqm::HistoBookRequest::default_int, cscdqm::HistoBookRequest::default_string, DIR_CRTINFO, DIR_DAQINFO, DIR_DCSINFO, DIR_EVENTINFO, cscdqm::h::EMU_CSC_STATS_SUMMARY, cscdqm::MonitorObject::Fill(), cscdqm::FLOAT, cscdqm::HistoBookRequest::folder, cscdqm::HistoDef::getId(), cscdqm::HistoDef::getName(), cscdqm::HistoDef::getPath(), cscdqm::H1D, cscdqm::H2D, cscdqm::H3D, cscdqm::HistoBookRequest::hdef, cscdqm::HistoBookRequest::highX, cscdqm::HistoBookRequest::highY, cscdqm::HistoBookRequest::highZ, cscdqm::HistoBookRequest::htype, ibooker, cscdqm::INT, cscdqm::h::keys, cscdqm::HistoBookRequest::lowX, cscdqm::HistoBookRequest::lowY, cscdqm::HistoBookRequest::lowZ, mergeVDriftHistosByStation::name, cscdqm::HistoBookRequest::nchX, cscdqm::HistoBookRequest::nchY, cscdqm::HistoBookRequest::nchZ, NULL, cscdqm::HistoBookRequest::option, cscdqm::h::PAR_CRT_SUMMARY, cscdqm::h::PAR_DAQ_SUMMARY, cscdqm::h::PAR_DCS_SUMMARY, cscdqm::h::PAR_REPORT_SUMMARY, cmsHarvester::path, cscdqm::PROFILE, cscdqm::PROFILE2D, cscdqm::Utility::regexMatch(), DQMStore::IBooker::setCurrentFolder(), cscdqm::STRING, AlCaHLTBitMon_QueryRunRegistry::string, and cscdqm::HistoBookRequest::title.

                                                                                          {

  cscdqm::MonitorObject *me = NULL;
  std::string name = req.hdef->getName();

  std::string path = req.folder;
  if (req.hdef->getPath().size() > 0) {
    path = path + req.hdef->getPath() + "/";
  }
  
  //std::cout << "Moving to " << path << " for name = " << name << " with fullPath = " << req.hdef->getFullPath() << "\n";

  //dbe->setCurrentFolder(path);
  ibooker->cd();
  ibooker->setCurrentFolder(path);

  if (req.htype == cscdqm::INT) {
    me = new CSCMonitorObject(ibooker->bookInt(name));
    me->Fill(req.default_int);
  } else 
  if (req.htype == cscdqm::FLOAT) {
    if (req.hdef->getId() == cscdqm::h::PAR_REPORT_SUMMARY ||
        req.hdef->getId() == cscdqm::h::PAR_CRT_SUMMARY ||
        req.hdef->getId() == cscdqm::h::PAR_DAQ_SUMMARY ||
        req.hdef->getId() == cscdqm::h::PAR_DCS_SUMMARY) {
      ibooker->cd();
      ibooker->setCurrentFolder(DIR_EVENTINFO);
    } else if (cscdqm::Utility::regexMatch("^PAR_DCS_", cscdqm::h::keys[req.hdef->getId()])) {
      ibooker->cd();
      ibooker->setCurrentFolder(DIR_DCSINFO);
    } else if (cscdqm::Utility::regexMatch("^PAR_DAQ_", cscdqm::h::keys[req.hdef->getId()])) {
      ibooker->cd();
      ibooker->setCurrentFolder(DIR_DAQINFO);
    } else if (cscdqm::Utility::regexMatch("^PAR_CRT_", cscdqm::h::keys[req.hdef->getId()])) {
      ibooker->cd();
      ibooker->setCurrentFolder(DIR_CRTINFO);
    }
    me = new CSCMonitorObject(ibooker->bookFloat(name));
    me->Fill(req.default_float);
  } else 
  if (req.htype == cscdqm::STRING) {
    me = new CSCMonitorObject(ibooker->bookString(name, req.default_string));
  } else 
  if (req.htype == cscdqm::H1D) { 
    me = new CSCMonitorObject(ibooker->book1D(name, req.title, req.nchX, req.lowX, req.highX));
  } else 
  if (req.htype == cscdqm::H2D) {
    if (req.hdef->getId() == cscdqm::h::EMU_CSC_STATS_SUMMARY) {
      ibooker->cd();
      ibooker->setCurrentFolder(DIR_EVENTINFO);
      name = "reportSummaryMap";
    }
    me = new CSCMonitorObject(ibooker->book2D(name, req.title, req.nchX, req.lowX, req.highX, req.nchY, req.lowY, req.highY));
  } else 
  if (req.htype == cscdqm::H3D) {
    me = new CSCMonitorObject(ibooker->book3D(name, req.title, req.nchX, req.lowX, req.highX, req.nchY, req.lowY, req.highY, req.nchZ, req.lowZ, req.highZ));
  } else 
  if (req.htype == cscdqm::PROFILE) {
    me = new CSCMonitorObject(ibooker->bookProfile(name, req.title, req.nchX, req.lowX, req.highX, req.nchY, req.lowY, req.highY, req.option.c_str()));
  } else 
  if (req.htype == cscdqm::PROFILE2D) {
    me = new CSCMonitorObject(ibooker->bookProfile2D(name, req.title, req.nchX, req.lowX, req.highX, req.nchY, req.lowY, req.highY, req.nchZ, req.lowZ, req.highZ, req.option.c_str()));
  }

  return me;

}

void CSCMonitorModule::endJob ( void  )

inlineprotected

Definition at line 136 of file CSCMonitorModule.h.

{ }

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

inlineprotectedvirtual

Reimplemented from edm::stream::EDAnalyzerBase.

Definition at line 135 of file CSCMonitorModule.h.

{ }

bool CSCMonitorModule::getCSCDetId ( const unsigned int  crateId, const unsigned int  dmbId, CSCDetId &  detId  ) const

inlinevirtual

MonitorObjectProvider Implementation

Implements cscdqm::MonitorObjectProvider.

Definition at line 113 of file CSCMonitorModule.h.

References CSCCrateMap::detId(), MAX_CRATE_ID, MAX_DMB_SLOT, pcrate, and DetId::rawId().

                                                                                                  { 
      // Check parameter values
      if (crateId < MIN_CRATE_ID || crateId > MAX_CRATE_ID || dmbId < MIN_DMB_SLOT || dmbId > MAX_DMB_SLOT) {
        return false;
      }
      detId = pcrate->detId(crateId, dmbId, 0, 0);
      return (detId.rawId() != 0);
    }

void CSCMonitorModule::setup ( )

inlineprotected

Definition at line 132 of file CSCMonitorModule.h.

{ }

Member Data Documentation

cscdqm::Configuration CSCMonitorModule::config

private

Definition at line 90 of file CSCMonitorModule.h.

Referenced by CSCMonitorModule().

cscdqm::Dispatcher* CSCMonitorModule::dispatcher

private

Definition at line 91 of file CSCMonitorModule.h.

Referenced by analyze(), bookHistograms(), CSCMonitorModule(), and ~CSCMonitorModule().

DQMStore::IBooker* CSCMonitorModule::ibooker

private

Definition at line 93 of file CSCMonitorModule.h.

Referenced by bookHistograms(), and bookMonitorObject().

edm::InputTag CSCMonitorModule::inputTag

private

Definition at line 94 of file CSCMonitorModule.h.

Referenced by analyze(), and CSCMonitorModule().

std::vector<std::string> CSCMonitorModule::maskedHW

private

Definition at line 101 of file CSCMonitorModule.h.

Referenced by bookHistograms(), and CSCMonitorModule().

const CSCCrateMap* CSCMonitorModule::pcrate

private

Pointer to crate mapping from database

Definition at line 99 of file CSCMonitorModule.h.

Referenced by analyze(), and getCSCDetId().

bool CSCMonitorModule::prebookEffParams

private

Definition at line 95 of file CSCMonitorModule.h.

Referenced by bookHistograms(), and CSCMonitorModule().

bool CSCMonitorModule::processDcsScalers

private

Definition at line 96 of file CSCMonitorModule.h.

Referenced by analyze(), and CSCMonitorModule().