Inheritance diagram for RawPCCProducer:

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

	~RawPCCProducer () override

Public Member Functions inherited from edm::global::EDProducer< edm::EndLuminosityBlockProducer >
	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 noexcept final

bool	wantsGlobalRuns () const noexcept final

bool	wantsInputProcessBlocks () const noexcept final

bool	wantsProcessBlocks () const noexcept final

bool	wantsStreamLuminosityBlocks () const noexcept final

bool	wantsStreamRuns () const noexcept 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 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 Member Functions
void	globalEndLuminosityBlockProduce (edm::LuminosityBlock &lumiSeg, const edm::EventSetup &iSetup) const final

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

Private Attributes
const bool	applyCorr_

const std::string	csvOutLabel_

std::mutex	fileLock_

const edm::ESGetToken< LumiCorrections, LumiCorrectionsRcd >	lumiCorrectionsToken_

const std::vector< int >	modVeto_

edm::EDGetTokenT< reco::PixelClusterCounts >	pccToken_

const edm::EDPutTokenT< LumiInfo >	putToken_

const bool	saveCSVFile_

const std::string	takeAverageValue_

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

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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)

Detailed Description

class: RawPCCProducer.cc

description: Creates a LumiInfo object that will contain the luminosity per bunch crossing, along with the total luminosity and the statistical error.

authors:Sam Higginbotham (shigg.nosp@m.inb@.nosp@m.cern..nosp@m.ch), Chris Palmer (capal.nosp@m.mer@.nosp@m.cern..nosp@m.ch), Jose Benitez (jose..nosp@m.beni.nosp@m.tez@c.nosp@m.ern..nosp@m.ch)

Definition at line 34 of file RawPCCProducer.cc.

Constructor & Destructor Documentation

◆ RawPCCProducer()

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

explicit

Definition at line 64 of file RawPCCProducer.cc.

     : pccToken_(consumes<reco::PixelClusterCounts, edm::InLumi>(edm::InputTag(
           iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters").getParameter<std::string>("inputPccLabel"),
           iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters").getParameter<std::string>("ProdInst")))),
       lumiCorrectionsToken_(esConsumes<edm::Transition::EndLuminosityBlock>()),
       modVeto_(
           iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters").getParameter<std::vector<int>>("modVeto")),
       applyCorr_(iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters")
                      .getUntrackedParameter<bool>("ApplyCorrections", false)),
       takeAverageValue_(iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters")
                             .getUntrackedParameter<std::string>("OutputValue", std::string("Average"))),
       putToken_(produces<LumiInfo, edm::Transition::EndLuminosityBlock>(
           iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters")
               .getUntrackedParameter<std::string>("outputProductName", "alcaLumi"))),
       saveCSVFile_(iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters")
                        .getUntrackedParameter<bool>("saveCSVFile", false)),
       csvOutLabel_(iConfig.getParameter<edm::ParameterSet>("RawPCCProducerParameters")
                        .getUntrackedParameter<std::string>("label", std::string("rawPCC.csv"))) {}

◆ ~RawPCCProducer()

RawPCCProducer::~RawPCCProducer ( )

override

Definition at line 84 of file RawPCCProducer.cc.

84 {}

Member Function Documentation

◆ globalEndLuminosityBlockProduce()

void RawPCCProducer::globalEndLuminosityBlockProduce	(	edm::LuminosityBlock &	lumiSeg,
		const edm::EventSetup &	iSetup
	)		const

finalprivate

read input , clusters per module per bx

Apply the module veto

Compute average number of clusters per event

Lumi saved in the LuminosityBlocks

Definition at line 90 of file RawPCCProducer.cc.

References applyCorr_, nano_mu_digi_cff::bx, csvOutLabel_, edm::LuminosityBlock::emplace(), events, fileLock_, spr::find(), nano_mu_digi_cff::float, edm::EventSetup::getData(), edm::LuminosityBlock::getHandle(), mps_fire::i, createfilelist::int, CommonMethods::lock(), lumiCorrectionsToken_, edm::LuminosityBlockBase::luminosityBlock(), modVeto_, eostools::move(), LumiConstants::numBX, pccToken_, edm::Handle< T >::product(), putToken_, reco::PixelClusterCounts::readCounts(), reco::PixelClusterCounts::readEvents(), reco::PixelClusterCounts::readModID(), edm::LuminosityBlockBase::run(), saveCSVFile_, LumiInfo::setErrorLumiAllBX(), LumiInfo::setInstLumiAllBX(), LumiInfo::setTotalInstLumi(), LumiInfo::setTotalInstStatError(), mathSSE::sqrt(), takeAverageValue_, and to_string().

                                                                                         {
   //The total raw luminosity from the pixel clusters - not scaled
   float totalLumi = 0.0;
   //the statistical error on the lumi - large num ie sqrt(N)
   float statErrOnLumi = 0.0;
 
   //new vector containing clusters per bxid
   std::vector<int> clustersPerBXOutput(LumiConstants::numBX, 0);
   //new vector containing clusters per bxid with afterglow corrections
   std::vector<float> corrClustersPerBXOutput(LumiConstants::numBX, 0);
 
   const edm::Handle<reco::PixelClusterCounts> pccHandle = lumiSeg.getHandle(pccToken_);
   const reco::PixelClusterCounts& inputPcc = *(pccHandle.product());
   //vector with Module IDs 1-1 map to bunch x-ing in clusers
   auto modID = inputPcc.readModID();
   //vector with total events at each bxid.
   auto events = inputPcc.readEvents();
   //cluster counts per module per bx
   auto clustersPerBXInput = inputPcc.readCounts();
 
   std::vector<int> goodMods;
   for (unsigned int i = 0; i < modID.size(); i++) {
     if (std::find(modVeto_.begin(), modVeto_.end(), modID.at(i)) == modVeto_.end()) {
       goodMods.push_back(i);
     }
   }
   for (int bx = 0; bx < int(LumiConstants::numBX); bx++) {
     for (unsigned int i = 0; i < goodMods.size(); i++) {
       clustersPerBXOutput.at(bx) += clustersPerBXInput.at(goodMods.at(i) * int(LumiConstants::numBX) + bx);
     }
   }
 
   std::vector<float> correctionScaleFactors;
   if (applyCorr_) {
     const auto pccCorrections = &iSetup.getData(lumiCorrectionsToken_);
     correctionScaleFactors = pccCorrections->getCorrectionsBX();
   } else {
     correctionScaleFactors.resize(LumiConstants::numBX, 1.0);
   }
 
   for (unsigned int i = 0; i < clustersPerBXOutput.size(); i++) {
     if (events.at(i) != 0) {
       corrClustersPerBXOutput[i] = clustersPerBXOutput[i] * correctionScaleFactors[i];
     } else {
       corrClustersPerBXOutput[i] = 0.0;
     }
     totalLumi += corrClustersPerBXOutput[i];
     statErrOnLumi += float(events[i]);
   }
 
   std::vector<float> errorPerBX;  //Stat error (or number of events)
   errorPerBX.assign(events.begin(), events.end());
 
   if (takeAverageValue_ == "Average") {
     unsigned int NActiveBX = 0;
     for (int bx = 0; bx < int(LumiConstants::numBX); bx++) {
       if (events[bx] > 0) {
         NActiveBX++;
         corrClustersPerBXOutput[bx] /= float(events[bx]);
         errorPerBX[bx] = 1 / sqrt(float(events[bx]));
       }
     }
     if (statErrOnLumi != 0) {
       totalLumi = totalLumi / statErrOnLumi * float(NActiveBX);
       statErrOnLumi = 1 / sqrt(statErrOnLumi) * totalLumi;
     }
   }
 
   LumiInfo outputLumiInfo;
   outputLumiInfo.setTotalInstLumi(totalLumi);
   outputLumiInfo.setTotalInstStatError(statErrOnLumi);
   outputLumiInfo.setErrorLumiAllBX(errorPerBX);
   outputLumiInfo.setInstLumiAllBX(corrClustersPerBXOutput);
   lumiSeg.emplace(putToken_, std::move(outputLumiInfo));
 
   //Lumi saved in the csv file
   if (saveCSVFile_) {
     std::lock_guard<std::mutex> lock(fileLock_);
     std::ofstream csfile(csvOutLabel_, std::ios_base::app);
     csfile << std::to_string(lumiSeg.run()) << ",";
     csfile << std::to_string(lumiSeg.luminosityBlock()) << ",";
     csfile << std::to_string(totalLumi);
 
     for (unsigned int bx = 0; bx < LumiConstants::numBX; bx++)
       csfile << "," << std::to_string(corrClustersPerBXOutput[bx]);
     csfile << std::endl;
 
     csfile.close();
   }
 }