#include <RivetAnalyzer.h>

Inheritance diagram for RivetAnalyzer:

Public Member Functions
void	analyze (const edm::Event &, const edm::EventSetup &) override

void	beginJob () override

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

void	endJob () override

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

	RivetAnalyzer (const edm::ParameterSet &)

	~RivetAnalyzer () override

Public Member Functions inherited from edm::one::EDAnalyzer< edm::one::WatchRuns, edm::one::SharedResources >
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

const EDAnalyzer &	operator= (const EDAnalyzer &)=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::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const noexcept

bool	wantsStreamRuns () const noexcept

	~EDAnalyzerBase () 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)

Private Attributes
std::unique_ptr< Rivet::AnalysisHandler >	_analysisHandler

std::vector< std::string >	_analysisNames

std::vector< std::string >	_cleanedWeightNames

std::string	_deselectMultiWeights

bool	_doFinalize

edm::EDGetTokenT< GenEventInfoProduct >	_genEventInfoCollection

edm::EDGetTokenT< GenLumiInfoHeader >	_genLumiInfoToken

edm::EDGetTokenT< edm::HepMC3Product >	_hepmcCollection

bool	_isFirstEvent

edm::EDGetTokenT< LHEEventProduct >	_LHECollection

const edm::InputTag	_lheLabel

edm::EDGetTokenT< LHERunInfoProduct >	_lheRunInfoToken

std::vector< std::string >	_lheWeightNames

double	_NLOSmearing

std::string	_outFileName

std::string	_selectMultiWeights

bool	_setIgnoreBeams

std::string	_setNominalWeightName

bool	_skipMultiWeights

bool	_useLHEweights

double	_weightCap

std::vector< std::string >	_weightNames

double	_xsection

std::shared_ptr< HepMC3::GenRunInfo >	runinfo

Additional Inherited Members
Public Types inherited from edm::one::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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)

Detailed Description

Definition at line 22 of file RivetAnalyzer.h.

Constructor & Destructor Documentation

◆ RivetAnalyzer()

RivetAnalyzer::RivetAnalyzer ( const edm::ParameterSet & pset )

Definition at line 19 of file RivetAnalyzer.cc.

References _deselectMultiWeights, _genLumiInfoToken, _hepmcCollection, _LHECollection, _lheLabel, _lheRunInfoToken, _NLOSmearing, _selectMultiWeights, _setIgnoreBeams, _setNominalWeightName, _skipMultiWeights, _useLHEweights, _weightCap, _xsection, muonDTDigis_cfi::pset, and AlCaHLTBitMon_QueryRunRegistry::string.

     : _isFirstEvent(true),
       _outFileName(pset.getParameter<std::string>("OutputFile")),
       _analysisNames(pset.getParameter<std::vector<std::string> >("AnalysisNames")),
       //decide whether to finalize the plots or not.
       //deciding not to finalize them can be useful for further harvesting of many jobs
       _doFinalize(pset.getParameter<bool>("DoFinalize")),
       _lheLabel(pset.getParameter<edm::InputTag>("LHECollection")),
       _xsection(-1.) {
   usesResource("Rivet");
 
   _hepmcCollection = consumes<HepMC3Product>(pset.getParameter<edm::InputTag>("HepMCCollection"));
   _genLumiInfoToken = consumes<GenLumiInfoHeader, edm::InLumi>(pset.getParameter<edm::InputTag>("genLumiInfo"));
 
   _useLHEweights = pset.getParameter<bool>("useLHEweights");
   if (_useLHEweights) {
     _lheRunInfoToken = consumes<LHERunInfoProduct, edm::InRun>(_lheLabel);
     _LHECollection = consumes<LHEEventProduct>(_lheLabel);
   }
 
   _weightCap = pset.getParameter<double>("weightCap");
   _NLOSmearing = pset.getParameter<double>("NLOSmearing");
   _setIgnoreBeams = pset.getParameter<bool>("setIgnoreBeams");
   _skipMultiWeights = pset.getParameter<bool>("skipMultiWeights");
   _selectMultiWeights = pset.getParameter<std::string>("selectMultiWeights");
   _deselectMultiWeights = pset.getParameter<std::string>("deselectMultiWeights");
   _setNominalWeightName = pset.getParameter<std::string>("setNominalWeightName");
 
   //set user cross section if needed
   _xsection = pset.getParameter<double>("CrossSection");
 }

◆ ~RivetAnalyzer()

RivetAnalyzer::~RivetAnalyzer ( )

override

Definition at line 51 of file RivetAnalyzer.cc.

51 {}

Member Function Documentation

◆ analyze()

void RivetAnalyzer::analyze	(	const edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overridevirtual

Set analysis handler weight options

Implements edm::one::EDAnalyzerBase.

Definition at line 96 of file RivetAnalyzer.cc.

References _analysisHandler, _analysisNames, _cleanedWeightNames, _deselectMultiWeights, _genLumiInfoToken, _hepmcCollection, _isFirstEvent, _LHECollection, _lheWeightNames, _NLOSmearing, _selectMultiWeights, _setIgnoreBeams, _setNominalWeightName, _skipMultiWeights, _useLHEweights, _weightCap, _weightNames, _xsection, genWeightsTable_cfi::genEvent, edm::HepMC3Product::GetEvent(), mps_fire::i, iEvent, LHEEventProduct::originalXWGTUP(), runinfo, AlCaHLTBitMon_QueryRunRegistry::string, to_string(), LHEEventProduct::weights(), and PostProcessor_cff::xsection.

                                                                                {
   //finalize weight names on the first event
   if (_isFirstEvent) {
     auto genLumiInfoHandle = iEvent.getLuminosityBlock().getHandle(_genLumiInfoToken);
     if (genLumiInfoHandle.isValid()) {
       _weightNames = genLumiInfoHandle->weightNames();
     }
 
     // need to reset the default weight name (or plotting will fail)
     if (!_weightNames.empty()) {
       _weightNames[0] = "";
     } else {  // Summer16 samples have 1 weight stored in HepMC but no weightNames
       _weightNames.push_back("");
     }
     if (_useLHEweights) {
       // Some samples have weights but no weight names -> assign generic names lheN
       if (_lheWeightNames.empty()) {
         edm::Handle<LHEEventProduct> lheEventHandle;
         iEvent.getByToken(_LHECollection, lheEventHandle);
         for (unsigned int i = 0; i < lheEventHandle->weights().size(); i++) {
           _lheWeightNames.push_back("lhe" + std::to_string(i + 1));  // start with 1 to match LHE weight IDs
         }
       }
       _weightNames.insert(_weightNames.end(), _lheWeightNames.begin(), _lheWeightNames.end());
     }
     // clean weight names to be accepted by Rivet plotting
     for (const std::string& wn : _weightNames) {
       _cleanedWeightNames.push_back(std::regex_replace(wn, std::regex("[^A-Za-z\\d\\._=]"), "_"));
     }
     runinfo = make_shared<HepMC3::GenRunInfo>();
     runinfo->set_weight_names(_cleanedWeightNames);
   }
 
   //get the hepmc product from the event
   edm::Handle<HepMC3Product> evt;
   iEvent.getByToken(_hepmcCollection, evt);
 
   // get HepMC GenEvent
   const HepMC3::GenEventData* genEventData = evt->GetEvent();
   std::unique_ptr<HepMC3::GenEvent> genEvent = std::make_unique<HepMC3::GenEvent>();
   genEvent->read_data(*genEventData);
 
   std::vector<double> mergedWeights;
   for (unsigned int i = 0; i < genEvent->weights().size(); i++) {
     mergedWeights.push_back(genEvent->weights()[i]);
   }
 
   if (_useLHEweights) {
     edm::Handle<LHEEventProduct> lheEventHandle;
     iEvent.getByToken(_LHECollection, lheEventHandle);
     for (unsigned int i = 0; i < _lheWeightNames.size(); i++) {
       mergedWeights.push_back(genEvent->weights()[0] * lheEventHandle->weights().at(i).wgt /
                               lheEventHandle->originalXWGTUP());
     }
   }
 
   double xsection = _xsection > 0 ? _xsection : genEvent->cross_section()->xsecs()[0];
   HepMC3::GenCrossSectionPtr xsec = make_shared<HepMC3::GenCrossSection>();
   xsec->set_cross_section(std::vector<double>(mergedWeights.size(), xsection),
                           std::vector<double>(mergedWeights.size(), 0.));
   genEvent->set_cross_section(xsec);
   genEvent->set_run_info(runinfo);
   genEvent->weights() = mergedWeights;
 
   //apply the beams initialization on the first event
   if (_isFirstEvent) {
     _analysisHandler = std::make_unique<Rivet::AnalysisHandler>();
     _analysisHandler->addAnalyses(_analysisNames);
 
     _analysisHandler->setCheckBeams(!_setIgnoreBeams);
     _analysisHandler->skipMultiWeights(_skipMultiWeights);
     _analysisHandler->matchWeightNames(_selectMultiWeights);
     _analysisHandler->unmatchWeightNames(_deselectMultiWeights);
     _analysisHandler->setNominalWeightName(_setNominalWeightName);
     _analysisHandler->setWeightCap(_weightCap);
     _analysisHandler->setNLOSmearing(_NLOSmearing);
 
     _analysisHandler->init(*genEvent);
 
     _isFirstEvent = false;
   }
 
   //run the analysis
   _analysisHandler->analyze(const_cast<GenEvent&>(*genEvent));
 }

◆ beginJob()

void RivetAnalyzer::beginJob ( void )

overridevirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 53 of file RivetAnalyzer.cc.

References SiStripCommissioningSource_FromEDM_cfg::cmsswbase, free(), and AlCaHLTBitMon_QueryRunRegistry::string.

                              {
   //set the environment, very ugly but rivet is monolithic when it comes to paths
   char* cmsswbase = std::getenv("CMSSW_BASE");
   char* cmsswrelease = std::getenv("CMSSW_RELEASE_BASE");
   if (!std::getenv("RIVET_REF_PATH")) {
     const std::string rivetref = string(cmsswbase) +
                                  "/src/GeneratorInterface/RivetInterface/data:" + string(cmsswrelease) +
                                  "/src/GeneratorInterface/RivetInterface/data:.";
     char* rivetrefCstr = strdup(rivetref.c_str());
     setenv("RIVET_REF_PATH", rivetrefCstr, 1);
     free(rivetrefCstr);
   }
   if (!std::getenv("RIVET_INFO_PATH")) {
     const std::string rivetinfo = string(cmsswbase) +
                                   "/src/GeneratorInterface/RivetInterface/data:" + string(cmsswrelease) +
                                   "/src/GeneratorInterface/RivetInterface/data:.";
     char* rivetinfoCstr = strdup(rivetinfo.c_str());
     setenv("RIVET_INFO_PATH", rivetinfoCstr, 1);
     free(rivetinfoCstr);
   }
 }

◆ beginRun()

void RivetAnalyzer::beginRun	(	const edm::Run &	iRun,
		const edm::EventSetup &	iSetup
	)

override

Definition at line 75 of file RivetAnalyzer.cc.

References _lheLabel, _lheWeightNames, _useLHEweights, edm::Run::getByLabel(), LHERunInfoProduct::headers_begin(), LHERunInfoProduct::headers_end(), groupFilesInBlocks::lines, and match().

                                                                             {
   if (_useLHEweights) {
     edm::Handle<LHERunInfoProduct> lheRunInfoHandle;
     iRun.getByLabel(_lheLabel, lheRunInfoHandle);
     typedef std::vector<LHERunInfoProduct::Header>::const_iterator headers_const_iterator;
 
     std::regex reg("<weight.*> ?(.*?) ?<\\/weight>");
     for (headers_const_iterator iter = lheRunInfoHandle->headers_begin(); iter != lheRunInfoHandle->headers_end();
          iter++) {
       std::vector<std::string> lines = iter->lines();
       for (unsigned int iLine = 0; iLine < lines.size(); iLine++) {
         std::smatch match;
         std::regex_search(lines.at(iLine), match, reg);
         if (!match.empty()) {
           _lheWeightNames.push_back(match[1]);
         }
       }
     }
   }
 }

◆ endJob()

void RivetAnalyzer::endJob ( void )

overridevirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 191 of file RivetAnalyzer.cc.

191 {}

◆ endRun()

void RivetAnalyzer::endRun	(	const edm::Run &	iRun,
		const edm::EventSetup &	iSetup
	)

override

Definition at line 183 of file RivetAnalyzer.cc.

References _analysisHandler, _doFinalize, and _outFileName.

                                                                           {
   if (_doFinalize)
     _analysisHandler->finalize();
   _analysisHandler->writeData(_outFileName);
 
   return;
 }

Member Data Documentation

◆ _analysisHandler

std::unique_ptr<Rivet::AnalysisHandler> RivetAnalyzer::_analysisHandler

private

Definition at line 52 of file RivetAnalyzer.h.

Referenced by analyze(), and endRun().

◆ _analysisNames

std::vector<std::string> RivetAnalyzer::_analysisNames

private

Definition at line 55 of file RivetAnalyzer.h.

Referenced by analyze().

◆ _cleanedWeightNames

std::vector<std::string> RivetAnalyzer::_cleanedWeightNames

private

Definition at line 61 of file RivetAnalyzer.h.

Referenced by analyze().

◆ _deselectMultiWeights

std::string RivetAnalyzer::_deselectMultiWeights

private

Definition at line 46 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _doFinalize

bool RivetAnalyzer::_doFinalize

private

Definition at line 56 of file RivetAnalyzer.h.

Referenced by endRun().

◆ _genEventInfoCollection

edm::EDGetTokenT<GenEventInfoProduct> RivetAnalyzer::_genEventInfoCollection

private

Definition at line 49 of file RivetAnalyzer.h.

◆ _genLumiInfoToken

edm::EDGetTokenT<GenLumiInfoHeader> RivetAnalyzer::_genLumiInfoToken

private

Definition at line 50 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _hepmcCollection

edm::EDGetTokenT<edm::HepMC3Product> RivetAnalyzer::_hepmcCollection

private

Definition at line 39 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _isFirstEvent

bool RivetAnalyzer::_isFirstEvent

private

Definition at line 53 of file RivetAnalyzer.h.

Referenced by analyze().

◆ _LHECollection

edm::EDGetTokenT<LHEEventProduct> RivetAnalyzer::_LHECollection

private

Definition at line 48 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _lheLabel

const edm::InputTag RivetAnalyzer::_lheLabel

private

Definition at line 57 of file RivetAnalyzer.h.

Referenced by beginRun(), and RivetAnalyzer().

◆ _lheRunInfoToken

edm::EDGetTokenT<LHERunInfoProduct> RivetAnalyzer::_lheRunInfoToken

private

Definition at line 51 of file RivetAnalyzer.h.

Referenced by RivetAnalyzer().

◆ _lheWeightNames

std::vector<std::string> RivetAnalyzer::_lheWeightNames

private

Definition at line 60 of file RivetAnalyzer.h.

Referenced by analyze(), and beginRun().

◆ _NLOSmearing

double RivetAnalyzer::_NLOSmearing

private

Definition at line 42 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _outFileName

std::string RivetAnalyzer::_outFileName

private

Definition at line 54 of file RivetAnalyzer.h.

Referenced by endRun().

◆ _selectMultiWeights

std::string RivetAnalyzer::_selectMultiWeights

private

Definition at line 45 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _setIgnoreBeams

bool RivetAnalyzer::_setIgnoreBeams

private

Definition at line 43 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _setNominalWeightName

std::string RivetAnalyzer::_setNominalWeightName

private

Definition at line 47 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _skipMultiWeights

bool RivetAnalyzer::_skipMultiWeights

private

Definition at line 44 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _useLHEweights

bool RivetAnalyzer::_useLHEweights

private

Definition at line 40 of file RivetAnalyzer.h.

Referenced by analyze(), beginRun(), and RivetAnalyzer().

◆ _weightCap

double RivetAnalyzer::_weightCap

private

Definition at line 41 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ _weightNames

std::vector<std::string> RivetAnalyzer::_weightNames

private

Definition at line 59 of file RivetAnalyzer.h.

Referenced by analyze().

◆ _xsection

double RivetAnalyzer::_xsection

private

Definition at line 58 of file RivetAnalyzer.h.

Referenced by analyze(), and RivetAnalyzer().

◆ runinfo

std::shared_ptr<HepMC3::GenRunInfo> RivetAnalyzer::runinfo

private

Definition at line 62 of file RivetAnalyzer.h.

Referenced by analyze().

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RivetAnalyzer()

◆ ~RivetAnalyzer()

Member Function Documentation

◆ analyze()

◆ beginJob()

◆ beginRun()

◆ endJob()

◆ endRun()

Member Data Documentation

◆ _analysisHandler

◆ _analysisNames

◆ _cleanedWeightNames

◆ _deselectMultiWeights

◆ _doFinalize

◆ _genEventInfoCollection

◆ _genLumiInfoToken

◆ _hepmcCollection

◆ _isFirstEvent

◆ _LHECollection

◆ _lheLabel

◆ _lheRunInfoToken

◆ _lheWeightNames

◆ _NLOSmearing

◆ _outFileName

◆ _selectMultiWeights

◆ _setIgnoreBeams

◆ _setNominalWeightName

◆ _skipMultiWeights

◆ _useLHEweights

◆ _weightCap

◆ _weightNames

◆ _xsection

◆ runinfo