DQMOneEDAnalyzer< Args > Class Template Reference

#include <DQMOneEDAnalyzer.h>

Inheritance diagram for DQMOneEDAnalyzer< Args >:

Public Types
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
template<typename T >
using	BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >
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

Public Member Functions
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 noexcept final
bool	wantsGlobalRuns () const noexcept final
bool	wantsInputProcessBlocks () const noexcept final
bool	wantsProcessBlocks () const noexcept final
Public Member Functions inherited from edm::one::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
bool	wantsStreamLuminosityBlocks () const noexcept
bool	wantsStreamRuns () const noexcept
	~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
std::vector< bool > const &	recordProvenanceList () 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)
TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...
	~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
ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const
std::vector< ESResolverIndex > 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
void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Protected Member Functions
virtual void	analyze (edm::Event const &, edm::EventSetup const &)
virtual void	bookHistograms (DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &)=0
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
template<Transition Tr = Transition::Event>
auto	produces (std::string instanceName) noexcept
	declare what type of product will make and with which optional label More...
template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()
template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()
template<Transition Tr = Transition::Event>
auto	produces () noexcept
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 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)

Protected Attributes
edm::EDPutTokenT< DQMToken >	runToken_

Additional Inherited Members
Static Public Member Functions inherited from edm::one::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Detailed Description

template<typename... Args>
class DQMOneEDAnalyzer< Args >

A "one" module base class that can only produce per-run histograms. This allows to easily wrap non-thread-safe code and is ok'ish performance-wise, since it only blocks concurrent runs, not concurrent lumis. It can be combined with edm::LuminosityBlockCache to watch per-lumi things, and fill per-run histograms with the results.

Definition at line 20 of file DQMOneEDAnalyzer.h.

Member Typedef Documentation

DQMStore

template<typename... Args>

typedef dqm::reco::DQMStore DQMOneEDAnalyzer< Args >::DQMStore

Definition at line 23 of file DQMOneEDAnalyzer.h.

MonitorElement

template<typename... Args>

typedef dqm::reco::MonitorElement DQMOneEDAnalyzer< Args >::MonitorElement

Definition at line 24 of file DQMOneEDAnalyzer.h.

Constructor & Destructor Documentation

DQMOneEDAnalyzer()

template<typename... Args>

DQMOneEDAnalyzer< Args >::DQMOneEDAnalyzer ( )

inline

Definition at line 29 of file DQMOneEDAnalyzer.h.

                     {
    // for whatever reason we need the explicit `template` keyword here.
    runToken_ = this->template produces<DQMToken, edm::Transition::EndRun>("DQMGenerationRecoRun");
  }

Member Function Documentation

accumulate()

template<typename... Args>

void DQMOneEDAnalyzer< Args >::accumulate ( edm::Event const &  event, edm::EventSetup const &  setup  )

inlineoverride

Definition at line 52 of file DQMOneEDAnalyzer.h.

                                                                              {
    auto& lumi = event.getLuminosityBlock();
    edm::Service<dqm::legacy::DQMStore>()->enterLumi(
        lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
    analyze(event, setup);
    edm::Service<dqm::legacy::DQMStore>()->leaveLumi(
        lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
  }

analyze()

template<typename... Args>

virtual void DQMOneEDAnalyzer< Args >::analyze ( edm::Event const &  , edm::EventSetup const &    )

inlineprotectedvirtual

Reimplemented in TopDiLeptonOfflineDQM, SingleTopTChannelLeptonDQM, TopSingleLeptonDQM, SingleTopTChannelLeptonDQM_miniAOD, TopSingleLeptonDQM_miniAOD, L1ExtraDQM, QcdLowPtDQM, CSCMonitorModule, L1TBPTX, L1TSync_Offline, METAnalyzer, EcalMixingModuleValidation, DTLocalTriggerTask, L1TSync, DTDigiTask, EmDQM, CTPPSDiamondDQMSource, SiStripFEDMonitorPlugin, HLTScalers, CastorMonitorModule, DQMPFCandidateAnalyzer, SiPixelTrackingRecHitsValid, PhotonValidator, DTLocalTriggerLutTask, PixelLumiDQM, EcalSelectiveReadoutValidation, DiamondSampicCalibrationDQMSource, DTLocalTriggerBaseTask, L1TdeRCT, L1TGT, L1TPhase2CorrelatorOffline, SiStripFEDCheckPlugin, DiamondSampicDQMSource, TotemTimingDQMSource, DTDataIntegrityTask, LogMessageMonitor, TkConvValidator, DTDCSByLumiTask, DTNoiseTask, SiStripMonitorPedestals, ZDCDigiStudy, L1TRate, HigPhotonJetHLTOfflineSource, MuonTrackResidualAnalyzer, DTResolutionAnalysisTask, DTScalerInfoTask, L1TRate_Offline, Vx3DHLTAnalyzer, DTChamberEfficiencyTask, HLTExoticaValidator, L1TEGammaOffline, HcalSimHitsValidation, SiPixelStatusHarvester, SiStripMonitorRawData, DQMHcalIterativePhiSymAlCaReco, DQMHcalPhiSymAlCaReco, SiStripMonitorQuality, BeamMonitor, DTEfficiencyTask, DQMEventInfo, AlcaBeamMonitor, FakeBeamMonitor, GlobalMuonMatchAnalyzer, dqm::RamdiskMonitor, hcaldqm::DQTask, SiPixelDigiSource, SiStripMonitorDigi, DQMProvInfo, DemoOneDQMEDAnalyzer, RecoDisplacedMuonValidator, RecoMuonValidator, BeamSpotDipServer, BeamSpotProblemMonitor, CTPPSCommonDQMSource, EwkElecDQM, EcalDQMonitorTask, L1TdeStage2CaloLayer1, LheWeightValidation, EwkTauDQM, RPCMonitorLinkSynchro, ESIntegrityTask, L1TStage2RegionalShower, L1Scalers, L1TStage2EMTF, and ESOccupancyTask.

Definition at line 75 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::accumulate().

{}

beginRun()

template<typename... Args>

void DQMOneEDAnalyzer< Args >::beginRun ( edm::Run const &  run, edm::EventSetup const &  setup  )

inlinefinal

Definition at line 34 of file DQMOneEDAnalyzer.h.

                                                                     {
    // if we run booking multiple times because there are multiple runs in a
    // job, this is needed to make sure all existing MEs are in a valid state
    // before the booking code runs.
    edm::Service<DQMStore>()->initLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
    edm::Service<DQMStore>()->enterLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
    dqmBeginRun(run, setup);
    edm::Service<DQMStore>()->bookTransaction(
        [this, &run, &setup](DQMStore::IBooker& booker) {
          booker.cd();
          this->bookHistograms(booker, run, setup);
        },
        this->moduleDescription().id(),
        this->getCanSaveByLumi());
    edm::Service<DQMStore>()->initLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
    edm::Service<DQMStore>()->enterLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
  }

bookHistograms()

template<typename... Args>

virtual void DQMOneEDAnalyzer< Args >::bookHistograms ( DQMStore::IBooker &  , edm::Run const &  , edm::EventSetup const &    )

protectedpure virtual

Implemented in TopDiLeptonOfflineDQM, SingleTopTChannelLeptonDQM, TopSingleLeptonDQM, SingleTopTChannelLeptonDQM_miniAOD, TopSingleLeptonDQM_miniAOD, L1ExtraDQM, QcdLowPtDQM, CSCMonitorModule, L1TBPTX, L1TSync_Offline, METAnalyzer, L1TSync, EcalMixingModuleValidation, SiStripFEDMonitorPlugin, DTLocalTriggerBaseTask, EmDQM, CastorMonitorModule, CTPPSDiamondDQMSource, SiPixelTrackingRecHitsValid, HLTScalers, DQMPFCandidateAnalyzer, PhotonValidator, DTLocalTriggerTask, DTDigiTask, L1TdeRCT, CorrPCCProducer, PixelLumiDQM, SiStripFEDCheckPlugin, PFHcalGPUComparisonTask, DTDataIntegrityTask, LogMessageMonitor, DiamondSampicCalibrationDQMSource, L1TGT, SiStripMonitorPedestals, L1TPhase2CorrelatorOffline, TkConvValidator, EcalSelectiveReadoutValidation, DiamondSampicDQMSource, TotemTimingDQMSource, L1TRate, DTChamberEfficiencyTask, MuonTrackResidualAnalyzer, Vx3DHLTAnalyzer, DTEfficiencyTask, DTLocalTriggerLutTask, L1TRate_Offline, HigPhotonJetHLTOfflineSource, L1TEGammaOffline, ZDCDigiStudy, DTDCSByLumiTask, DTNoiseTask, SiStripMonitorRawData, DQMHcalIterativePhiSymAlCaReco, DQMHcalPhiSymAlCaReco, DQMEventInfo, HcalSimHitsValidation, SiPixelStatusHarvester, DTScalerInfoTask, SiStripMonitorQuality, GlobalMuonMatchAnalyzer, AlcaBeamMonitor, BeamMonitor, HLTExoticaValidator, FakeBeamMonitor, SiStripMonitorDigi, DTResolutionAnalysisTask, OnlineBeamMonitor, hcaldqm::DQTask, SiPixelDigiSource, HcalMLTask, DQMProvInfo, dqm::RamdiskMonitor, DemoOneDQMEDAnalyzer, BeamSpotProblemMonitor, L1TdeStage2CaloLayer1, LheWeightValidation, RecoDisplacedMuonValidator, RecoMuonValidator, BeamSpotDipServer, CTPPSCommonDQMSource, DigiTask, EwkElecDQM, EwkTauDQM, RecHitTask, LaserTask, RawTask, UMNioTask, LEDTask, QIE10Task, QIE11Task, TPTask, HcalGPUComparisonTask, EcalDQMonitorTask, PedestalTask, L1TStage2RegionalShower, RPCMonitorLinkSynchro, ESIntegrityTask, HFRaddamTask, L1Scalers, NoCQTask, L1TStage2EMTF, and ESOccupancyTask.

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::beginRun().

dqmBeginRun()

template<typename... Args>

virtual void DQMOneEDAnalyzer< Args >::dqmBeginRun ( edm::Run const &  , edm::EventSetup const &    )

inlineprotectedvirtual

Reimplemented in L1ExtraDQM, QcdLowPtDQM, L1TBPTX, L1TSync_Offline, METAnalyzer, EcalMixingModuleValidation, L1TSync, EmDQM, DQMPFCandidateAnalyzer, CastorMonitorModule, CTPPSDiamondDQMSource, HLTScalers, PhotonValidator, DTLocalTriggerTask, L1TRate, DTDigiTask, TkConvValidator, DiamondSampicCalibrationDQMSource, L1TGT, L1TPhase2CorrelatorOffline, DTLocalTriggerBaseTask, DTLocalTriggerLutTask, EcalSelectiveReadoutValidation, DiamondSampicDQMSource, TotemTimingDQMSource, HigPhotonJetHLTOfflineSource, DTEfficiencyTask, DTNoiseTask, DTScalerInfoTask, HLTExoticaValidator, L1TEGammaOffline, DTResolutionAnalysisTask, DTChamberEfficiencyTask, DTDCSByLumiTask, SiStripMonitorDigi, BeamMonitor, hcaldqm::DQTask, FakeBeamMonitor, SiPixelDigiSource, HcalMLTask, DQMProvInfo, LheWeightValidation, BeamSpotDipServer, EwkElecDQM, RecoDisplacedMuonValidator, RecoMuonValidator, EcalDQMonitorTask, and RPCMonitorLinkSynchro.

Definition at line 73 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::beginRun().

{}

dqmEndRun()

template<typename... Args>

virtual void DQMOneEDAnalyzer< Args >::dqmEndRun ( edm::Run const &  , edm::EventSetup const &    )

inlineprotectedvirtual

Reimplemented in L1ExtraDQM, QcdLowPtDQM, METAnalyzer, EcalMixingModuleValidation, EmDQM, CastorMonitorModule, HLTScalers, CTPPSDiamondDQMSource, PhotonValidator, EcalSelectiveReadoutValidation, L1TPhase2CorrelatorOffline, SiStripFEDCheckPlugin, TkConvValidator, CorrPCCProducer, SiStripMonitorPedestals, MuonTrackResidualAnalyzer, HigPhotonJetHLTOfflineSource, BeamMonitor, HLTExoticaValidator, ZDCDigiStudy, FakeBeamMonitor, L1TEGammaOffline, DQMHcalIterativePhiSymAlCaReco, DQMHcalPhiSymAlCaReco, AlcaBeamMonitor, SiStripMonitorRawData, SiStripMonitorQuality, SiPixelStatusHarvester, GlobalMuonMatchAnalyzer, OnlineBeamMonitor, BeamSpotProblemMonitor, BeamSpotDipServer, LheWeightValidation, EwkElecDQM, RecoDisplacedMuonValidator, RecoMuonValidator, EwkTauDQM, ESIntegrityTask, EcalDQMonitorTask, LaserTask, PedestalTask, UMNioTask, and LEDTask.

Definition at line 76 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::endRunProduce().

{}

endRun()

template<typename... Args>

void DQMOneEDAnalyzer< Args >::endRun ( edm::Run const &  , edm::EventSetup const &    )

inlinefinal

Definition at line 69 of file DQMOneEDAnalyzer.h.

{};

endRunProduce()

template<typename... Args>

void DQMOneEDAnalyzer< Args >::endRunProduce ( edm::Run &  run, edm::EventSetup const &  setup  )

inlinefinal

Definition at line 61 of file DQMOneEDAnalyzer.h.

                                                                    {
    dqmEndRun(run, setup);
    edm::Service<DQMStore>()->leaveLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
    run.emplace<DQMToken>(runToken_);
  }

getCanSaveByLumi()

template<typename... Args>

virtual bool DQMOneEDAnalyzer< Args >::getCanSaveByLumi ( )

inlinevirtual

Reimplemented in DQMOneLumiEDAnalyzer< Args >, and DQMOneLumiEDAnalyzer<>.

Definition at line 26 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::beginRun().

{ return true; }

Member Data Documentation

runToken_

template<typename... Args>

edm::EDPutTokenT<DQMToken> DQMOneEDAnalyzer< Args >::runToken_

protected

Definition at line 78 of file DQMOneEDAnalyzer.h.

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::DQMOneEDAnalyzer(), and DQMOneEDAnalyzer< edm::LuminosityBlockCache< totemds::Cache > >::endRunProduce().