#include <EcalSimpleProducer.h>

Inheritance diagram for EcalSimpleProducer:

Public Member Functions
void	beginJob () override

	EcalSimpleProducer (const edm::ParameterSet &pset)

void	produce (edm::Event &evt, const edm::EventSetup &) override

	~EcalSimpleProducer () override

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

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

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () 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< 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)

Private Member Functions
int	cIndex2iEta (int iEta0) const

int	cIndex2iPhi (int iPhi0) const

int	cIndex2iTtEta (int iEta0) const

int	cIndex2iTtPhi (int iPhi0) const

void	replaceAll (std::string &s, const std::string &from, const std::string &to) const

Private Attributes
std::unique_ptr< TFormula >	formula_

std::unique_ptr< TFormula >	simHitFormula_

std::unique_ptr< TFormula >	tpFormula_

bool	verbose_

Additional Inherited Members
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

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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

This edm producer generates Ecal Digis (data frames and TPGs) according to a given pattern. The pattern is defined as function of event id, crystal/TT, and time sample. Only barrel is currently supported for the crystal channel data.

Module parameters (in addition to standard source parameters):

string formula: formula of crystal channel time sample encoded ADC counts.
string tpFormula: formula of trigger primitives.
untracked bool verbose: verbosity switch

The crystal ADC formula is parametrized with the following variables:

ieta0: crystal eta index starting from 0 at eta- end of barrel
iphi0: crystal phi index starting at Phi=0deg. in std CMS coordinates
ievt0 event sequence number within the job run starting from 0
isample0 sample time position starting from 0

The trigger primitive formula is parametrized with the following variables:

ieta0: trigger tower eta index starting from 0 at eta- end of barrel
iphi0: trigger tower index starting at Phi=0deg. in std CMS coordinates
ievt0 event sequence number within the job run starting from 0
isample0 sample time position starting from 0

In both formulae 'itt0' shortcut can be used for the trigger tower index within the SM starting at 0 from lowest relative eta and lowest phi and increasing first with phi then with eta. The syntax for the formula is the syntax defined in ROOT TFormula

Definition at line 38 of file EcalSimpleProducer.h.

Constructor & Destructor Documentation

◆ EcalSimpleProducer()

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

Constructs an EcalSimpleProducer

Parameters

pset	CMSSW configuration
sdesc	description of this input source

Definition at line 99 of file EcalSimpleProducer.cc.

                                                                   : EDProducer() {
   string formula = pset.getParameter<string>("formula");
   string tpFormula = pset.getParameter<string>("tpFormula");
   string simHitFormula = pset.getParameter<string>("simHitFormula");
  
   verbose_ = pset.getUntrackedParameter<bool>("verbose", false);
   //  replaceAll(formula, "itt0",
   //  "((((ieta0<85)*(84-ieta0)+(ieta0>=85)*(ieta0-85))/5-18)*4+((iphi0/5+2)%4))");
   replaceAll(formula, "ebm", "(ieta0<85)");
   replaceAll(formula, "ebp", "(ieta0>84)");
   replaceAll(formula, "ieta0", "x");
   replaceAll(formula, "iphi0", "y");
   replaceAll(formula, "ievt0", "z");
   replaceAll(formula, "isample0", "t");
   //  cout << "----------> " << formula << endl;
  
   replaceAll(tpFormula, "itt0", "((ieta0<28)*(27-ieta0)+(ieta0>=28)*(ieta0-28))*4+(iphi0+2)%4");
   replaceAll(tpFormula, "eb", "(ieta0>10 && ieta0<45)");
   replaceAll(tpFormula, "ebm", "(ieta0>10 && ieta0<28)");
   replaceAll(tpFormula, "ebp", "(ieta0>27 && ieta0<45)");
   replaceAll(tpFormula, "ee", "(ieta0<11 || ieta0>44)");
   replaceAll(tpFormula, "eem", "(ieta0<11)");
   replaceAll(tpFormula, "eep", "(ieta0>44)");
   replaceAll(tpFormula, "ieta0", "x");
   replaceAll(tpFormula, "iphi0", "y");
   replaceAll(tpFormula, "ievt0", "z");
   replaceAll(tpFormula, "isample0", "t");
   // cout << "----------> " << tpFormula << endl;
  
   // replaceAll(simHitormula, "itt0",
   // "((((ieta0<85)*(84-ieta0)+(ieta0>=85)*(ieta0-85))/5-18)*4+((iphi0/5+2)%4))");
   replaceAll(simHitFormula, "ebm", "(ieta0<85)");
   replaceAll(simHitFormula, "ebp", "(ieta0>84)");
   replaceAll(simHitFormula, "ieta0", "x");
   replaceAll(simHitFormula, "iphi0", "y");
   replaceAll(simHitFormula, "ievt0", "z");
  
   if (!formula.empty()) {
     formula_ = std::make_unique<TFormula>("f", formula.c_str());
     Int_t err = formula_->Compile();
     if (err != 0) {
       throw cms::Exception("Error in EcalSimpleProducer 'formula' config.");
     }
     produces<EBDigiCollection>();
     produces<EEDigiCollection>();
   }
   if (!tpFormula.empty()) {
     tpFormula_ = std::make_unique<TFormula>("f", tpFormula.c_str());
     Int_t err = tpFormula_->Compile();
     if (err != 0) {
       throw cms::Exception("Error in EcalSimpleProducer 'tpFormula' config.");
     }
     produces<EcalTrigPrimDigiCollection>();
   }
   if (!simHitFormula.empty()) {
     simHitFormula_ = std::make_unique<TFormula>("f", simHitFormula.c_str());
     Int_t err = simHitFormula_->Compile();
     if (err != 0) {
       throw cms::Exception(
           "Error in EcalSimpleProducer "
           "'simHitFormula' config.");
     }
     produces<edm::PCaloHitContainer>("EcalHitsEB");
     produces<edm::PCaloHitContainer>("EcalHitsEE");
   }
 }

References submitPVResolutionJobs::err, Exception, pfMETCorrectionType0_cfi::formula, formula_, muonDTDigis_cfi::pset, replaceAll(), simHitFormula_, EcalElecEmulTccOnlyExample_cfg::tpFormula, tpFormula_, and verbose_.

◆ ~EcalSimpleProducer()

EcalSimpleProducer::~EcalSimpleProducer ( )

inlineoverride

Destructor

Definition at line 49 of file EcalSimpleProducer.h.

49 {};

Member Function Documentation

◆ beginJob()

void EcalSimpleProducer::beginJob ( void )

inlineoverridevirtual

Called at start of job.

Parameters

es	the event setup

Reimplemented from edm::one::EDProducerBase.

Definition at line 54 of file EcalSimpleProducer.h.

54 {};

◆ cIndex2iEta()

int EcalSimpleProducer::cIndex2iEta ( int iEta0 ) const

inlineprivate

Converts c-array index (contiguous integer starting from 0) to std CMSSW ECAL crystal eta index.

Parameters

iEta0 c-array index. '0' postfix reminds the index starts from 0

Returns: std CMSSW ECAL crystal index.

Definition at line 77 of file EcalSimpleProducer.h.

77 { return (iEta0 < 85) ? iEta0 - 85 : iEta0 - 84; }

◆ cIndex2iPhi()

int EcalSimpleProducer::cIndex2iPhi ( int iPhi0 ) const

inlineprivate

Converts c-array index (contiguous integer starting from 0) to std CMSSW ECAL crystal phi index.

Parameters

iPhi0 c-array index. '0' postfix reminds the index starts from 0

Returns: std CMSSW ECAL crystal index.

Definition at line 84 of file EcalSimpleProducer.h.

84 { return (iPhi0 + 10) % 360 + 1; }

◆ cIndex2iTtEta()

int EcalSimpleProducer::cIndex2iTtEta ( int iEta0 ) const

inlineprivate

Converts c-array index (contiguous integer starting from 0) to std CMSSW ECAL trigger tower eta index.

Parameters

iEta0 c-array index. '0' postfix reminds the index starts from 0

Returns: std CMSSW ECAL trigger tower index.

Definition at line 91 of file EcalSimpleProducer.h.

91 { return (iEta0 < 28) ? iEta0 - 28 : iEta0 - 27; }

◆ cIndex2iTtPhi()

int EcalSimpleProducer::cIndex2iTtPhi ( int iPhi0 ) const

inlineprivate

Converts c-array index (contiguous integer starting from 0) to std CMSSW ECAL trigger tower phi index.

Parameters

iPhi0 c-array index. '0' postfix reminds the index starts from 0

Returns: std CMSSW ECAL trigger tower index.

Definition at line 98 of file EcalSimpleProducer.h.

98 { return iPhi0 + 1; }

◆ produce()

void EcalSimpleProducer::produce	(	edm::Event &	evt,
		const edm::EventSetup &
	)

overridevirtual

The main method. It produces the event.

Parameters

evt	[out] produced event.

Implements edm::one::EDProducerBase.

Definition at line 18 of file EcalSimpleProducer.cc.

                                                                      {
   const int ievt = evt.id().event();
   if (formula_.get() != nullptr) {
     unique_ptr<EBDigiCollection> digis(new EBDigiCollection);
  
     digis->reserve(170 * 360);
  
     const int nSamples = digis->stride();
     for (int iEta0 = 0; iEta0 < 170; ++iEta0) {
       for (int iPhi0 = 0; iPhi0 < 360; ++iPhi0) {
         int iEta1 = cIndex2iEta(iEta0);
         int iPhi = cIndex2iPhi(iPhi0);
         if (verbose_)
           cout << "(" << iEta0 << "," << iPhi0 << "): ";
         digis->push_back(EBDetId(iEta1, iPhi));
         DataFrame dframe(digis->back());
  
         for (int t = 0; t < nSamples; ++t) {
           uint16_t encodedAdc = (uint16_t)formula_->Eval(iEta0, iPhi0, ievt - 1, t);
           if (verbose_)
             cout << encodedAdc << ((t < (nSamples - 1)) ? "\t" : "\n");
           dframe[t] = encodedAdc;
         }
       }
     }
     evt.put(std::move(digis));
     // puts an empty digi collecion for endcap:
     evt.put(std::make_unique<EEDigiCollection>());
   }
   if (tpFormula_.get() != nullptr) {
     unique_ptr<EcalTrigPrimDigiCollection> tps = std::make_unique<EcalTrigPrimDigiCollection>();
     tps->reserve(56 * 72);
     const int nSamples = 5;
     for (int iTtEta0 = 0; iTtEta0 < 56; ++iTtEta0) {
       for (int iTtPhi0 = 0; iTtPhi0 < 72; ++iTtPhi0) {
         int iTtEta1 = cIndex2iTtEta(iTtEta0);
         int iTtPhi = cIndex2iTtPhi(iTtPhi0);
  
         if (verbose_)
           cout << "(" << iTtEta0 << "," << iTtPhi0 << "): ";
         int zside = iTtEta1 < 0 ? -1 : 1;
         EcalTriggerPrimitiveDigi tpframe(EcalTrigTowerDetId(zside, EcalTriggerTower, abs(iTtEta1), iTtPhi));
  
         tpframe.setSize(nSamples);
  
         if (verbose_)
           cout << "TP: ";
         for (int t = 0; t < nSamples; ++t) {
           uint16_t encodedTp = (uint16_t)tpFormula_->Eval(iTtEta0, iTtPhi0, ievt - 1, t);
  
           if (verbose_)
             cout << "TP(" << iTtEta0 << "," << iTtPhi0 << ") = " << encodedTp << ((t < (nSamples - 1)) ? "\t" : "\n");
           tpframe.setSample(t, EcalTriggerPrimitiveSample(encodedTp));
         }
         tps->push_back(tpframe);
       }
     }
     evt.put(std::move(tps));
   }
   if (simHitFormula_.get() != nullptr) {  // generation of barrel sim hits
     unique_ptr<PCaloHitContainer> hits = std::make_unique<PCaloHitContainer>();
     for (int iEta0 = 0; iEta0 < 170; ++iEta0) {
       for (int iPhi0 = 0; iPhi0 < 360; ++iPhi0) {
         int iEta1 = cIndex2iEta(iEta0);
         int iPhi = cIndex2iPhi(iPhi0);
         if (verbose_)
           cout << "(" << iEta0 << "," << iPhi0 << "): ";
  
         double em = simHitFormula_->Eval(iEta0, iPhi0, ievt - 1);
         double eh = 0.;
         double t = 0.;
         const PCaloHit hit(EBDetId(iEta1, iPhi).rawId(), em, eh, t, 0, 0);
         hits->push_back(hit);
       }
     }
     evt.put(std::move(hits), "EcalHitsEB");
     // puts an empty digi collecion for endcap:
     evt.put(std::make_unique<PCaloHitContainer>(), "EcalHitsEE");
   }
 }

References funct::abs(), gather_cfg::cout, EcalTriggerTower, edm::EventID::event(), hfClusterShapes_cfi::hits, edm::EventBase::id(), eostools::move(), PresampleTask_cfi::nSamples, edm::Event::put(), EcalTriggerPrimitiveDigi::setSample(), EcalTriggerPrimitiveDigi::setSize(), submitPVValidationJobs::t, and ecaldqm::zside().

◆ replaceAll()

void EcalSimpleProducer::replaceAll	(	std::string &	s,
		const std::string &	from,
		const std::string &	to
	)		const

private

Help function to replace a pattern within a string. Every occurance of the pattern is replaced. An exact match is performed: no wild card.

Parameters

s	string to operate on
pattern	to replace.
string	to substitute to the pattern

Definition at line 166 of file EcalSimpleProducer.cc.

                                                                                                   {
   string::size_type pos = 0;
   //  cout << "replaceAll(" << s << "," << from << "," << to << ")\n";
   while ((pos = s.find(from, pos)) != string::npos) {
     // cout << "replace(" << pos << "," << from.size() << "," << to << ")\n";
     s.replace(pos, from.size(), to);
     //   cout << " -> " << s << "\n";
   }
 }

References alignCSCRings::s.

Referenced by EcalSimpleProducer().

Member Data Documentation

◆ formula_

std::unique_ptr<TFormula> EcalSimpleProducer::formula_

private

Formula defining the data frame samples

Definition at line 105 of file EcalSimpleProducer.h.

Referenced by EcalSimpleProducer().

◆ simHitFormula_

std::unique_ptr<TFormula> EcalSimpleProducer::simHitFormula_

private

Formula defining the sim hits

Definition at line 113 of file EcalSimpleProducer.h.

Referenced by EcalSimpleProducer().

◆ tpFormula_

std::unique_ptr<TFormula> EcalSimpleProducer::tpFormula_

private

Formula defining the trigger primitives

Definition at line 109 of file EcalSimpleProducer.h.

Referenced by EcalSimpleProducer().

◆ verbose_

bool EcalSimpleProducer::verbose_

private

Verbosity switch

Definition at line 117 of file EcalSimpleProducer.h.

Referenced by EcalSimpleProducer().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EcalSimpleProducer()

◆ ~EcalSimpleProducer()

Member Function Documentation

◆ beginJob()

◆ cIndex2iEta()

◆ cIndex2iPhi()

◆ cIndex2iTtEta()

◆ cIndex2iTtPhi()

◆ produce()

◆ replaceAll()

Member Data Documentation

◆ formula_

◆ simHitFormula_

◆ tpFormula_

◆ verbose_