CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
DQMOneEDAnalyzer< Args > Class Template Referenceabstract

#include <DQMOneEDAnalyzer.h>

Inheritance diagram for DQMOneEDAnalyzer< Args >:
edm::one::EDProducer< edm::EndRunProducer, edm::one::WatchRuns, edm::Accumulator, Args... > edm::one::EDProducerBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

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
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
 
SerialTaskQueueglobalLuminosityBlocksQueue () final
 
SerialTaskQueueglobalRunsQueue () final
 
bool hasAbilityToProduceInBeginLumis () const final
 
bool hasAbilityToProduceInBeginRuns () const final
 
bool hasAbilityToProduceInEndLumis () const final
 
bool hasAbilityToProduceInEndRuns () const final
 
bool wantsGlobalLuminosityBlocks () const final
 
bool wantsGlobalRuns () 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
 
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< ConsumesInfoconsumesInfo () const
 
void convertCurrentProcessAlias (std::string const &processName)
 Convert "@currentProcess" in InputTag process names to the actual current process name. More...
 
 EDConsumerBase ()
 
 EDConsumerBase (EDConsumerBase &&)=default
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
ESProxyIndex const * esGetTokenIndices (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::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
ProductResolverIndexAndSkipBit uncheckedIndexFrom (EDGetToken) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
void updateLookup (eventsetup::ESRecordsToProxyIndices 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<class ProductType >
BranchAliasSetterT< ProductType > produces ()
 declare what type of product will make and with which optional label More...
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces ()
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces ()
 
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)
 
template<Transition B>
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 (std::string instanceName)
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
ProducesCollector producesCollector ()
 
- Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (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)
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 

Protected Attributes

edm::EDPutTokenT< DQMTokenrunToken_
 

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.

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

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.

52  {
53  auto& lumi = event.getLuminosityBlock();
55  lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
58  lumi.run(), lumi.luminosityBlock(), this->moduleDescription().id());
59  }

◆ analyze()

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

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

Definition at line 75 of file DQMOneEDAnalyzer.h.

75 {}

Referenced by DQMOneEDAnalyzer< edm::LuminosityBlockCache< l1tderct::Empty > >::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.

34  {
35  // if we run booking multiple times because there are multiple runs in a
36  // job, this is needed to make sure all existing MEs are in a valid state
37  // before the booking code runs.
38  edm::Service<DQMStore>()->initLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
39  edm::Service<DQMStore>()->enterLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
41  edm::Service<DQMStore>()->bookTransaction(
42  [this, &run, &setup](DQMStore::IBooker& booker) {
43  booker.cd();
44  this->bookHistograms(booker, run, setup);
45  },
46  this->moduleDescription().id(),
47  this->getCanSaveByLumi());
48  edm::Service<DQMStore>()->initLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
49  edm::Service<DQMStore>()->enterLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
50  }

◆ bookHistograms()

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

◆ dqmBeginRun()

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

◆ dqmEndRun()

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

◆ endRun()

template<typename... Args>
void DQMOneEDAnalyzer< Args >::endRun ( edm::Run const &  ,
edm::EventSetup const &   
)
inlinefinal

Definition at line 69 of file DQMOneEDAnalyzer.h.

69 {};

◆ endRunProduce()

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

Definition at line 61 of file DQMOneEDAnalyzer.h.

61  {
62  dqmEndRun(run, setup);
63  edm::Service<DQMStore>()->leaveLumi(run.run(), /* lumi */ 0, this->moduleDescription().id());
65  }

◆ getCanSaveByLumi()

template<typename... Args>
virtual bool DQMOneEDAnalyzer< Args >::getCanSaveByLumi ( )
inlinevirtual

Member Data Documentation

◆ runToken_

template<typename... Args>
edm::EDPutTokenT<DQMToken> DQMOneEDAnalyzer< Args >::runToken_
protected
singleTopDQM_cfi.setup
setup
Definition: singleTopDQM_cfi.py:37
DQMOneEDAnalyzer::bookHistograms
virtual void bookHistograms(DQMStore::IBooker &, edm::Run const &, edm::EventSetup const &)=0
dqm::legacy::DQMStore::IBooker
dqm::implementation::IBooker IBooker
Definition: DQMStore.h:729
DQMToken
Definition: DQMToken.h:21
edm::one::EDProducerBase::moduleDescription
ModuleDescription const & moduleDescription() const
Definition: EDProducerBase.h:64
edm::Service
Definition: Service.h:30
DQMOneEDAnalyzer::getCanSaveByLumi
virtual bool getCanSaveByLumi()
Definition: DQMOneEDAnalyzer.h:26
writedatasetfile.run
run
Definition: writedatasetfile.py:27
DQMOneEDAnalyzer::analyze
virtual void analyze(edm::Event const &, edm::EventSetup const &)
Definition: DQMOneEDAnalyzer.h:75
edm::Run::emplace
void emplace(EDPutTokenT< PROD > token, Args &&... args)
puts a new product
Definition: Run.h:245
DQMOneEDAnalyzer::dqmEndRun
virtual void dqmEndRun(edm::Run const &, edm::EventSetup const &)
Definition: DQMOneEDAnalyzer.h:76
event
Definition: event.py:1
lumi
Definition: LumiSectionData.h:20
DQMOneEDAnalyzer::runToken_
edm::EDPutTokenT< DQMToken > runToken_
Definition: DQMOneEDAnalyzer.h:78
DQMOneEDAnalyzer::dqmBeginRun
virtual void dqmBeginRun(edm::Run const &, edm::EventSetup const &)
Definition: DQMOneEDAnalyzer.h:73
edm::ModuleDescription::id
unsigned int id() const
Definition: ModuleDescription.h:46