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) override
	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 override
	~CSCMonitorModule () override
	Destructor. More...
Public Member Functions inherited from DQMOneEDAnalyzer<>
void	accumulate (edm::Event const &event, edm::EventSetup const &setup) override
void	beginRun (edm::Run const &run, edm::EventSetup const &setup) final
	DQMOneEDAnalyzer ()
void	endRun (edm::Run const &, edm::EventSetup const &) final
void	endRunProduce (edm::Run &run, edm::EventSetup const &setup) final
virtual bool	getCanSaveByLumi ()
Public Member Functions inherited from edm::one::EDProducer< edm::EndRunProducer, edm::one::WatchRuns, edm::Accumulator, Args...>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
SerialTaskQueue *	globalLuminosityBlocksQueue () final
SerialTaskQueue *	globalRunsQueue () final
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsInputProcessBlocks () const final
bool	wantsProcessBlocks () const final
Public Member Functions inherited from edm::one::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
bool	wantsStreamLuminosityBlocks () const
bool	wantsStreamRuns () const
	~EDProducerBase () override
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector < edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector < edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
	~ProducerBase () noexcept(false) 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
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const
std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const
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::array< std::vector< ModuleDescription const * > *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, 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	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)
Public Member Functions inherited from cscdqm::MonitorObjectProvider
virtual	~MonitorObjectProvider () noexcept(false)

Protected Member Functions
void	analyze (const edm::Event &e, const edm::EventSetup &c) override
	Begin the run. More...
void	bookHistograms (DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &) override
	Book Histograms in the beginRun. More...
Protected Member Functions inherited from DQMOneEDAnalyzer<>
virtual void	dqmBeginRun (edm::Run const &, edm::EventSetup const &)
virtual void	dqmEndRun (edm::Run const &, edm::EventSetup const &)
Protected Member Functions inherited from edm::ProducerBase
ProducesCollector	producesCollector ()
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept
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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()
template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)
template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...
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)
void	resetItemsToGetFrom (BranchType iType)

Private Attributes
cscdqm::Configuration	config
cscdqm::Dispatcher *	dispatcher
const edm::ESGetToken < CSCCrateMap, CSCCrateMapRcd >	hcrateToken_
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 DQMOneEDAnalyzer<>
typedef dqm::reco::DQMStore	DQMStore
typedef dqm::reco::MonitorElement	MonitorElement
Public Types inherited from edm::one::EDProducerBase
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >>
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Static Public Member Functions inherited from edm::one::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)
Protected Attributes inherited from DQMOneEDAnalyzer<>
edm::EDPutTokenT< DQMToken >	runToken_

Detailed Description

Common CSC DQM Module that uses CSCDQM Framework.

Definition at line 73 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(), personalPlayback::fp, edm::FileInPath::fullPath(), edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), cscdqm::Dispatcher::init(), INPUT_TAG_LABEL, inputTag, HLT_FULL_cff::InputTag, maskedHW, submitPVValidationJobs::params, prebookEffParams, and processDcsScalers.

    : hcrateToken_(esConsumes<CSCCrateMap, CSCCrateMapRcd>()) {
  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 ( )

override

Destructor.

Definition at line 61 of file CSCMonitorModule.cc.

References dispatcher.

                                    {
  if (dispatcher)
    delete dispatcher;
}

Member Function Documentation

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

overrideprotectedvirtual

Begin the run.

EDAnalyzer Implementation

Parameters

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

Use esConsumes to get crate mapping

Reimplemented from DQMOneEDAnalyzer<>.

Definition at line 87 of file CSCMonitorModule.cc.

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

                                                                        {
  // Get crate mapping from database
  edm::ESHandle<CSCCrateMap> hcrate;
  hcrate = c.getHandle(hcrateToken_);
  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::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 DQMOneEDAnalyzer<>.

Definition at line 123 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.empty())
      dispatcher->maskHWElements(maskedHW);
    if (prebookEffParams) {
      dispatcher->updateFractionAndEfficiencyHistos();
    }
  }

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

overridevirtual

Book Monitor Object on Request.

Parameters

req

Request.

Returns

MonitorObject created.

Implements cscdqm::MonitorObjectProvider.

Definition at line 149 of file CSCMonitorModule.cc.

References dqm::implementation::IBooker::book1D(), dqm::implementation::IBooker::book2D(), dqm::implementation::IBooker::book3D(), dqm::implementation::IBooker::bookFloat(), dqm::implementation::IBooker::bookInt(), dqm::implementation::IBooker::bookProfile(), dqm::implementation::IBooker::bookProfile2D(), dqm::implementation::IBooker::bookString(), dqm::implementation::NavigatorBase::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, hlt_dqm_clientPB-live_cfg::me, mergeVDriftHistosByStation::name, cscdqm::HistoBookRequest::nchX, cscdqm::HistoBookRequest::nchY, cscdqm::HistoBookRequest::nchZ, cscdqm::HistoBookRequest::option, cscdqm::h::PAR_CRT_SUMMARY, cscdqm::h::PAR_DAQ_SUMMARY, cscdqm::h::PAR_DCS_SUMMARY, cscdqm::h::PAR_REPORT_SUMMARY, fed_dqm_sourceclient-live_cfg::path, cscdqm::PROFILE, cscdqm::PROFILE2D, cscdqm::Utility::regexMatch(), dqm::implementation::NavigatorBase::setCurrentFolder(), cscdqm::STRING, AlCaHLTBitMon_QueryRunRegistry::string, and cscdqm::HistoBookRequest::title.

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

    std::string path = req.folder;
    if (!req.hdef->getPath().empty()) {
      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;
  }

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

inlineoverridevirtual

MonitorObjectProvider Implementation

Implements cscdqm::MonitorObjectProvider.

Definition at line 107 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);
  }

Member Data Documentation

cscdqm::Configuration CSCMonitorModule::config

private

Definition at line 83 of file CSCMonitorModule.h.

Referenced by CSCMonitorModule(), and zMuMuValidation.ZMuMuValidation::trackcollection().

cscdqm::Dispatcher* CSCMonitorModule::dispatcher

private

Definition at line 84 of file CSCMonitorModule.h.

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

const edm::ESGetToken<CSCCrateMap, CSCCrateMapRcd> CSCMonitorModule::hcrateToken_

private

Definition at line 91 of file CSCMonitorModule.h.

Referenced by analyze().

DQMStore::IBooker* CSCMonitorModule::ibooker

private

Definition at line 86 of file CSCMonitorModule.h.

Referenced by bookHistograms(), and bookMonitorObject().

edm::InputTag CSCMonitorModule::inputTag

private

Definition at line 87 of file CSCMonitorModule.h.

Referenced by analyze(), and CSCMonitorModule().

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

private

Definition at line 96 of file CSCMonitorModule.h.

Referenced by bookHistograms(), and CSCMonitorModule().

const CSCCrateMap* CSCMonitorModule::pcrate

private

Pointer to crate mapping from database

Definition at line 94 of file CSCMonitorModule.h.

Referenced by analyze(), and getCSCDetId().

bool CSCMonitorModule::prebookEffParams

private

Definition at line 88 of file CSCMonitorModule.h.

Referenced by bookHistograms(), and CSCMonitorModule().

bool CSCMonitorModule::processDcsScalers

private

Definition at line 89 of file CSCMonitorModule.h.

Referenced by analyze(), and CSCMonitorModule().