#include <RecoLuminosity/LumiProducer/plugins/LumiProducerFromBrilcalc.cc>

Inheritance diagram for LumiProducerFromBrilcalc:

Public Member Functions
	LumiProducerFromBrilcalc (const edm::ParameterSet &)

	~LumiProducerFromBrilcalc () override=default

Public Member Functions inherited from edm::global::EDProducer<>
	EDProducer ()=default

	EDProducer (const EDProducer &)=delete

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginProcessBlocks () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndProcessBlocks () const final

bool	hasAbilityToProduceInEndRuns () const final

EDProducer &	operator= (const EDProducer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

bool	wantsStreamLuminosityBlocks () const final

bool	wantsStreamRuns () const final

Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () 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< 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 &&)=default

	EDConsumerBase (EDConsumerBase const &)=delete

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 &	operator= (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)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	produce (edm::StreamID, edm::Event &, const edm::EventSetup &) const override

Private Attributes
const bool	doBunchByBunch_

std::map< std::pair< int, int >, std::pair< float, float > >	lumiData_

const std::string	lumiFile_

const bool	throwIfNotFound_

Additional Inherited Members
Public Types inherited from edm::global::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

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 = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

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)

Detailed Description

Description: Takes a csv file with luminosity information produced by brilcalc and reads it into the event.

Implementation: [Notes on implementation]

Definition at line 42 of file LumiProducerFromBrilcalc.cc.

Constructor & Destructor Documentation

◆ LumiProducerFromBrilcalc()

LumiProducerFromBrilcalc::LumiProducerFromBrilcalc ( const edm::ParameterSet & iConfig )

explicit

Definition at line 63 of file LumiProducerFromBrilcalc.cc.

     : lumiFile_(iConfig.getParameter<std::string>("lumiFile")),
       throwIfNotFound_(iConfig.getParameter<bool>("throwIfNotFound")),
       doBunchByBunch_(iConfig.getParameter<bool>("doBunchByBunch")) {
   //register your products
   produces<LumiInfo>("brilcalc");
  
   //now do what ever other initialization is needed
   if (doBunchByBunch_) {
     throw cms::Exception("LumiProducerFromBrilcalc")
         << "Sorry, bunch-by-bunch luminosity is not yet supported. Please bug your friendly lumi expert!";
   }
  
   // Read luminosity data and store it in lumiData_.
   edm::LogInfo("LumiProducerFromBrilcalc") << "Reading luminosity data from " << lumiFile_ << "...one moment...";
   std::ifstream lumiFile(lumiFile_);
   if (!lumiFile.is_open()) {
     throw cms::Exception("LumiProducerFromBrilcalc") << "Failed to open input luminosity file " << lumiFile_;
   }
  
   int nLS = 0;
   std::string line;
   while (true) {
     std::getline(lumiFile, line);
     if (lumiFile.eof() || lumiFile.fail())
       break;
     if (line.empty())
       continue;  // skip blank lines
     if (line.at(0) == '#')
       continue;  // skip comment lines
  
     // Break into fields. These should be, in order: run:fill, brills:cmsls, time, beam status, beam energy,
     // delivered lumi, recorded lumi, average pileup, source.
     std::stringstream ss(line);
     std::string field;
     std::vector<std::string> fields;
  
     while (std::getline(ss, field, ','))
       fields.push_back(field);
  
     if (fields.size() != 9) {
       edm::LogWarning("LumiProducerFromBrilcalc") << "Malformed line in csv file: " << line;
       continue;
     }
  
     // Extract the run number from fields[0] and the lumisection number from fields[1]. Fortunately since the
     // thing we want is before the colon, we don't have to split them again.
     int run, ls;
     std::stringstream runfill(fields[0]);
     runfill >> run;
     std::stringstream lsls(fields[1]);
     lsls >> ls;
  
     // Extract the delivered and recorded lumi from fields[5] and fields[6].
     float lumiDel, lumiRec, dtFrac;
     std::stringstream lumiDelString(fields[5]);
     lumiDelString >> lumiDel;
     std::stringstream lumiRecString(fields[6]);
     lumiRecString >> lumiRec;
  
     // Calculate the deadtime fraction
     dtFrac = 1.0 - lumiRec / lumiDel;
  
     // Finally, store it all.
     lumiData_[std::make_pair(run, ls)] = std::make_pair(lumiDel, dtFrac);
     nLS++;
   }
   edm::LogInfo("LumiProducerFromBrilcalc") << "Read " << nLS << " lumisections from " << lumiFile_;
   lumiFile.close();
 }

References doBunchByBunch_, Exception, l1GtPatternGenerator_cfi::fields, mps_splice::line, eostools::ls(), lumiData_, lumiFile_, writedatasetfile::run, contentValuesCheck::ss, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ ~LumiProducerFromBrilcalc()

LumiProducerFromBrilcalc::~LumiProducerFromBrilcalc ( )

overridedefault

Member Function Documentation

◆ fillDescriptions()

void LumiProducerFromBrilcalc::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 164 of file LumiProducerFromBrilcalc.cc.

                                                                                           {
   // Allowed parameters
   edm::ParameterSetDescription desc;
   desc.add<std::string>("lumiFile");
   desc.add<bool>("throwIfNotFound", false);
   desc.add<bool>("doBunchByBunch", false);
   descriptions.addDefault(desc);
 }

References edm::ConfigurationDescriptions::addDefault(), submitPVResolutionJobs::desc, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ produce()

void LumiProducerFromBrilcalc::produce	(	edm::StreamID	iStreamID,
		edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)		const

overrideprivatevirtual

Implements edm::global::EDProducerBase.

Definition at line 139 of file LumiProducerFromBrilcalc.cc.

                                                                           {
   std::vector<float> bxlumi(3564, 0);
   std::pair<int, int> runls = std::make_pair(iEvent.run(), iEvent.luminosityBlock());
   if (lumiData_.count(runls) == 1) {
     // if we have data for this run/LS, put it in the event
     LogDebug("LumiProducerFromBrilcalc") << "Filling for run " << runls.first << " ls " << runls.second
                                          << " with delivered " << lumiData_.at(runls).first << " dt "
                                          << lumiData_.at(runls).second;
     iEvent.put(std::make_unique<LumiInfo>(lumiData_.at(runls).second, bxlumi, lumiData_.at(runls).first), "brilcalc");
   } else {
     if (throwIfNotFound_) {
       throw cms::Exception("LumiProducerFromBrilcalc")
           << "Failed to find luminosity for run " << runls.first << " LS " << runls.second;
     } else {
       // just put in zeroes
       edm::LogWarning("LumiProducerFromBrilcalc")
           << "Failed to find luminosity for run " << runls.first << " ls " << runls.second;
       iEvent.put(std::make_unique<LumiInfo>(0, bxlumi, 0), "brilcalc");
     }
   }
 }