#include <EcalSignalGenerator.h>

Inheritance diagram for EcalSignalGenerator< ECALDIGITIZERTRAITS >:

Public Types
typedef std::unordered_map< uint32_t, double >	CalibCache

typedef ECALDIGITIZERTRAITS::DigiCollection	COLLECTION

typedef ECALDIGITIZERTRAITS::Digi	DIGI

Public Member Functions
	EcalSignalGenerator ()

	EcalSignalGenerator (edm::ConsumesCollector &cc, const edm::InputTag &inputTag, const double EBs25notCont, const double EEs25notCont, const double peToABarrel, const double peToAEndcap, const bool timeDependent=false)

virtual void	fill (edm::ModuleCallingContext const *mcc)

void	initializeEvent (const edm::Event event, const edm::EventSetup eventSetup)

void	initializeEvent (const edm::EventPrincipal eventPrincipal, const edm::EventSetup eventSetup)
	some users use EventPrincipals, not Events. We support both More...

	~EcalSignalGenerator () override

Public Member Functions inherited from EcalBaseSignalGenerator
	EcalBaseSignalGenerator ()

	~EcalBaseSignalGenerator () override

Public Member Functions inherited from CaloVNoiseSignalGenerator
	CaloVNoiseSignalGenerator ()

bool	contains (const DetId &detId) const

void	fillEvent (CLHEP::HepRandomEngine *)
	fill theNoiseSignals with one event's worth of noise, in units of pe More...

void	fillEvent ()

void	getNoiseSignals (std::vector< CaloSamples > &noiseSignals)

void	setNoiseSignals (const std::vector< CaloSamples > &noiseSignals)

virtual	~CaloVNoiseSignalGenerator ()

Private Types
enum	{ NBITS = 12, MAXADC = 4095, ADCGAINSWITCH = 4079, NGAINS = 3 }

Private Member Functions
void	fillNoiseSignals () override

void	fillNoiseSignals (CLHEP::HepRandomEngine *) override

double	findLaserConstant_LC (const DetId &detId) const

double	findLaserConstant_LC_prime (const DetId &detId) const

double	fullScaleEnergy (const DetId &detId) const

const std::vector< float >	GetGainRatios (const DetId &detid)

double	peToAConversion (const DetId &detId) const

CaloSamples	samplesInPE (const DIGI &digi)

bool	validDigi (const DIGI &digi)

Private Attributes
const EcalADCToGeVConstant *	agc

const ESGain *	esgain

int	ESgain

const ESIntercalibConstants *	esmips

const ESMIPToGeVConstant *	esMipToGeV

double	ESMIPToGeV

const EcalIntercalibConstantsMC *	ical

const edm::ESGetToken< EcalADCToGeVConstant, EcalADCToGeVConstantRcd >	m_adcToGeVConstantToken

const double	m_EBs25notCont

const double	m_EEs25notCont

const edm::ESGetToken< ESGain, ESGainRcd >	m_esGainToken

const edm::ESGetToken< ESIntercalibConstants, ESIntercalibConstantsRcd >	m_esIntercalibConstantsToken

const edm::ESGetToken< ESMIPToGeVConstant, ESMIPToGeVConstantRcd >	m_esMIPToGeVConstantToken

const EcalGainRatios *	m_gainRatios

const edm::ESGetToken< EcalGainRatios, EcalGainRatiosRcd >	m_gainRatiosToken

const edm::ESGetToken< EcalIntercalibConstantsMC, EcalIntercalibConstantsMCRcd >	m_interCalibConstantsMCToken

edm::TimeValue_t	m_iTime

const EcalLaserDbService *	m_lasercals

const EcalLaserDbService *	m_lasercals_prime

edm::ESGetToken< EcalLaserDbService, EcalLaserDbRecordMC >	m_laserDbMCToken

edm::ESGetToken< EcalLaserDbService, EcalLaserDbRecord >	m_laserDbToken

double	m_maxEneEB

double	m_maxEneEE

const double	m_peToABarrel

const double	m_peToAEndcap

const bool	m_timeDependent

const edm::EDGetTokenT< COLLECTION >	m_tok

CalibCache	m_valueLCCache_LC

CalibCache	m_valueLCCache_LC_prime

double	theDefaultGains [NGAINS]

const edm::Event *	theEvent
	these fields are set in initializeEvent() More...

const edm::EventPrincipal *	theEventPrincipal

const edm::InputTag	theInputTag
	these come from the ParameterSet More...

Additional Inherited Members
Protected Attributes inherited from CaloVNoiseSignalGenerator
std::vector< CaloSamples >	theNoiseSignals

Detailed Description

template<class ECALDIGITIZERTRAITS>
class EcalSignalGenerator< ECALDIGITIZERTRAITS >

Definition at line 55 of file EcalSignalGenerator.h.

Member Typedef Documentation

◆ CalibCache

template<class ECALDIGITIZERTRAITS>

typedef std::unordered_map<uint32_t, double> EcalSignalGenerator< ECALDIGITIZERTRAITS >::CalibCache

Definition at line 60 of file EcalSignalGenerator.h.

◆ COLLECTION

template<class ECALDIGITIZERTRAITS>

typedef ECALDIGITIZERTRAITS::DigiCollection EcalSignalGenerator< ECALDIGITIZERTRAITS >::COLLECTION

Definition at line 58 of file EcalSignalGenerator.h.

◆ DIGI

template<class ECALDIGITIZERTRAITS>

typedef ECALDIGITIZERTRAITS::Digi EcalSignalGenerator< ECALDIGITIZERTRAITS >::DIGI

Definition at line 57 of file EcalSignalGenerator.h.

Member Enumeration Documentation

◆ anonymous enum

template<class ECALDIGITIZERTRAITS>

anonymous enum

private

Enumerator
NBITS
MAXADC
ADCGAINSWITCH
NGAINS

Definition at line 249 of file EcalSignalGenerator.h.

        {
     NBITS = 12,            // number of available bits
     MAXADC = 4095,         // 2^12 -1,  adc max range
     ADCGAINSWITCH = 4079,  // adc gain switch
     NGAINS = 3
   };  // number of electronic gains

Constructor & Destructor Documentation

◆ EcalSignalGenerator() [1/2]

template<class ECALDIGITIZERTRAITS>

EcalSignalGenerator< ECALDIGITIZERTRAITS >::EcalSignalGenerator ( )

inline

Definition at line 62 of file EcalSignalGenerator.h.

62 : EcalBaseSignalGenerator() {}

EcalBaseSignalGenerator::EcalBaseSignalGenerator

EcalBaseSignalGenerator()

Definition: EcalBaseSignalGenerator.h:9

◆ EcalSignalGenerator() [2/2]

template<class ECALDIGITIZERTRAITS>

EcalSignalGenerator< ECALDIGITIZERTRAITS >::EcalSignalGenerator	(	edm::ConsumesCollector &	cc,
		const edm::InputTag &	inputTag,
		const double	EBs25notCont,
		const double	EEs25notCont,
		const double	peToABarrel,
		const double	peToAEndcap,
		const bool	timeDependent = `false`
	)

inline

Definition at line 64 of file EcalSignalGenerator.h.

       : EcalBaseSignalGenerator(),
         m_gainRatiosToken(cc.esConsumes()),
         m_interCalibConstantsMCToken(cc.esConsumes()),
         m_adcToGeVConstantToken(cc.esConsumes()),
         m_esGainToken(cc.esConsumes()),
         m_esMIPToGeVConstantToken(cc.esConsumes()),
         m_esIntercalibConstantsToken(cc.esConsumes()),
         theEvent(nullptr),
         theEventPrincipal(nullptr),
         theInputTag(inputTag),
         m_tok(cc.consumes<COLLECTION>(inputTag)),
         m_EBs25notCont(EBs25notCont),
         m_EEs25notCont(EEs25notCont),
         m_peToABarrel(peToABarrel),
         m_peToAEndcap(peToAEndcap),
         m_timeDependent(timeDependent) {
     EcalMGPAGainRatio* defaultRatios = new EcalMGPAGainRatio();
     theDefaultGains[2] = defaultRatios->gain6Over1();
     theDefaultGains[1] = theDefaultGains[2] * (defaultRatios->gain12Over6());
 
     if (m_timeDependent) {
       m_laserDbToken = cc.esConsumes();
       m_laserDbMCToken = cc.esConsumes();
     }
   }

◆ ~EcalSignalGenerator()

template<class ECALDIGITIZERTRAITS>

EcalSignalGenerator< ECALDIGITIZERTRAITS >::~EcalSignalGenerator ( )

inlineoverride

Definition at line 97 of file EcalSignalGenerator.h.

97 {}

Member Function Documentation

◆ fill()

template<class ECALDIGITIZERTRAITS>

virtual void EcalSignalGenerator< ECALDIGITIZERTRAITS >::fill ( edm::ModuleCallingContext const * mcc )

inlinevirtual

Definition at line 201 of file EcalSignalGenerator.h.

Referenced by PreMixingEcalWorker::addPileups().

                                                         {
     theNoiseSignals.clear();
     edm::Handle<COLLECTION> pDigis;
     const COLLECTION* digis = nullptr;
     // try accessing by whatever is set, Event or EventPrincipal
     if (theEvent) {
       if (theEvent->getByToken(m_tok, pDigis)) {
         digis = pDigis.product();  // get a ptr to the product
       } else {
         throw cms::Exception("EcalSignalGenerator") << "Cannot find input data " << theInputTag;
       }
     } else if (theEventPrincipal) {
       std::shared_ptr<edm::Wrapper<COLLECTION> const> digisPTR =
           edm::getProductByTag<COLLECTION>(*theEventPrincipal, theInputTag, mcc);
       if (digisPTR) {
         digis = digisPTR->product();
       }
     } else {
       throw cms::Exception("EcalSignalGenerator") << "No Event or EventPrincipal was set";
     }
 
     if (digis) {
       // loop over digis, adding these to the existing maps
       for (typename COLLECTION::const_iterator it = digis->begin(); it != digis->end(); ++it) {
         // need to convert to something useful
         if (validDigi(*it)) {
           theNoiseSignals.push_back(samplesInPE(*it));
         }
       }
     }
     //else { std::cout << " NO digis for this input: " << theInputTag << std::endl;}
   }

◆ fillNoiseSignals() [1/2]

template<class ECALDIGITIZERTRAITS>

void EcalSignalGenerator< ECALDIGITIZERTRAITS >::fillNoiseSignals ( )

inlineoverrideprivatevirtual

Implements CaloVNoiseSignalGenerator.

Definition at line 244 of file EcalSignalGenerator.h.

244 {}

◆ fillNoiseSignals() [2/2]

template<class ECALDIGITIZERTRAITS>

void EcalSignalGenerator< ECALDIGITIZERTRAITS >::fillNoiseSignals ( CLHEP::HepRandomEngine * )

inlineoverrideprivatevirtual

if you want to fill signals on demand, override this subclass is responsible for clearing theNoiseSignals before adding

Implements CaloVNoiseSignalGenerator.

Definition at line 245 of file EcalSignalGenerator.h.

245 {}

◆ findLaserConstant_LC()

template<class ECALDIGITIZERTRAITS>

double EcalSignalGenerator< ECALDIGITIZERTRAITS >::findLaserConstant_LC ( const DetId & detId ) const

inlineprivate

Definition at line 259 of file EcalSignalGenerator.h.

                                                         {
     const edm::Timestamp& evtTimeStamp = edm::Timestamp(m_iTime);
     return (m_lasercals->getLaserCorrection(detId, evtTimeStamp));
   }

◆ findLaserConstant_LC_prime()

template<class ECALDIGITIZERTRAITS>

double EcalSignalGenerator< ECALDIGITIZERTRAITS >::findLaserConstant_LC_prime ( const DetId & detId ) const

inlineprivate

Definition at line 266 of file EcalSignalGenerator.h.

                                                               {
     const edm::Timestamp& evtTimeStamp = edm::Timestamp(m_iTime);
     return (m_lasercals_prime->getLaserCorrection(detId, evtTimeStamp));
   }

◆ fullScaleEnergy()

template<class ECALDIGITIZERTRAITS>

double EcalSignalGenerator< ECALDIGITIZERTRAITS >::fullScaleEnergy ( const DetId & detId ) const

inlineprivate

Definition at line 284 of file EcalSignalGenerator.h.

284 { return detId.subdetId() == EcalBarrel ? m_maxEneEB : m_maxEneEE; }

EcalSignalGenerator::m_maxEneEE

double m_maxEneEE

Definition: EcalSignalGenerator.h:322

DetId::subdetId

constexpr int subdetId() const

get the contents of the subdetector field (not cast into any detector's numbering enum) ...

Definition: DetId.h:48

EcalSignalGenerator::m_maxEneEB

double m_maxEneEB

Definition: EcalSignalGenerator.h:321

EcalBarrel

Definition: EcalSubdetector.h:10

◆ GetGainRatios()

template<class ECALDIGITIZERTRAITS>

const std::vector<float> EcalSignalGenerator< ECALDIGITIZERTRAITS >::GetGainRatios ( const DetId & detid )

inlineprivate

Definition at line 271 of file EcalSignalGenerator.h.

                                                            {
     std::vector<float> gainRatios(4);
     // get gain ratios
     EcalMGPAGainRatio theRatio = (*m_gainRatios)[detid];
 
     gainRatios[0] = 0.;
     gainRatios[3] = 1.;
     gainRatios[2] = theRatio.gain6Over1();
     gainRatios[1] = theRatio.gain6Over1() * theRatio.gain12Over6();
 
     return gainRatios;
   }

◆ initializeEvent() [1/2]

template<class ECALDIGITIZERTRAITS>

void EcalSignalGenerator< ECALDIGITIZERTRAITS >::initializeEvent	(	const edm::Event *	event,
		const edm::EventSetup *	eventSetup
	)

inline

Definition at line 99 of file EcalSignalGenerator.h.

Referenced by PreMixingEcalWorker::addPileups().

                                                                                {
     theEvent = event;
     m_gainRatios = &eventSetup->getData(m_gainRatiosToken);  // find the gains
     // Ecal Intercalibration Constants
     ical = &eventSetup->getData(m_interCalibConstantsMCToken);
     // adc to GeV
     agc = &eventSetup->getData(m_adcToGeVConstantToken);
 
     m_maxEneEB = (agc->getEBValue()) * theDefaultGains[1] * MAXADC * m_EBs25notCont;
     m_maxEneEE = (agc->getEEValue()) * theDefaultGains[1] * MAXADC * m_EEs25notCont;
 
     if (m_timeDependent) {
       //----
       //
       const edm::TimeValue_t eventTimeValue = theEvent->getRun().runAuxiliary().beginTime().value();
       //
       //         The "time" will have to match in the generation of the tag
       //         for the MC from ECAL (apd/pn, alpha, whatever time dependent is needed)
       //
       m_iTime = eventTimeValue;
 
       // Ecal LaserCorrection Constants for laser correction ratio
       m_lasercals = &eventSetup->getData(m_laserDbToken);
 
       //
       // the "prime" is exactly the same as the usual laser service, BUT
       // it has only 1 IOV, so that effectively you are dividing IOV_n / IOV_0
       // NB: in the creation of the tag make sure the "prime" (MC) tag is prepared properly!
       // NB again: if many IOVs also in "MC" tag, then fancy things could be perfomed ... left for the future
       //
       m_lasercals_prime = &eventSetup->getData(m_laserDbMCToken);
 
       //clear the laser cache for each event time
       CalibCache().swap(m_valueLCCache_LC);
       CalibCache().swap(m_valueLCCache_LC_prime);  //--- also the "prime" ... yes
       //----
     }
 
     //ES
     esgain = &eventSetup->getData(m_esGainToken);
     esmips = &eventSetup->getData(m_esIntercalibConstantsToken);
     esMipToGeV = &eventSetup->getData(m_esMIPToGeVConstantToken);
     if (1.1 > esgain->getESGain())
       ESgain = 1;
     else
       ESgain = 2;
     if (ESgain == 1)
       ESMIPToGeV = esMipToGeV->getESValueLow();
     else
       ESMIPToGeV = esMipToGeV->getESValueHigh();
   }

◆ initializeEvent() [2/2]

template<class ECALDIGITIZERTRAITS>

void EcalSignalGenerator< ECALDIGITIZERTRAITS >::initializeEvent	(	const edm::EventPrincipal *	eventPrincipal,
		const edm::EventSetup *	eventSetup
	)

inline

some users use EventPrincipals, not Events. We support both

Definition at line 152 of file EcalSignalGenerator.h.

                                                                                                  {
     theEventPrincipal = eventPrincipal;
     m_gainRatios = &eventSetup->getData(m_gainRatiosToken);  // find the gains
     // Ecal Intercalibration Constants
     ical = &eventSetup->getData(m_interCalibConstantsMCToken);
     // adc to GeV
     agc = &eventSetup->getData(m_adcToGeVConstantToken);
     m_maxEneEB = (agc->getEBValue()) * theDefaultGains[1] * MAXADC * m_EBs25notCont;
     m_maxEneEE = (agc->getEEValue()) * theDefaultGains[1] * MAXADC * m_EEs25notCont;
 
     if (m_timeDependent) {
       //----
       edm::TimeValue_t eventTimeValue = 0;
       if (theEventPrincipal) {
         //
         eventTimeValue = theEventPrincipal->runPrincipal().beginTime().value();
         //
         //         The "time" will have to match in the generation of the tag
         //         for the MC from ECAL (apd/pn, alpha, whatever time dependent is needed)
         //
       } else {
         edm::LogError("EcalSignalGenerator") << " theEventPrincipal not defined??? " << std::endl;
       }
       m_iTime = eventTimeValue;
 
       // Ecal LaserCorrection Constants for laser correction ratio
       m_lasercals = &eventSetup->getData(m_laserDbToken);
       m_lasercals_prime = &eventSetup->getData(m_laserDbMCToken);
 
       //clear the laser cache for each event time
       CalibCache().swap(m_valueLCCache_LC);
       CalibCache().swap(m_valueLCCache_LC_prime);  //--- also the "prime" ... yes
       //----
     }
 
     //ES
     esgain = &eventSetup->getData(m_esGainToken);
     esmips = &eventSetup->getData(m_esIntercalibConstantsToken);
     esMipToGeV = &eventSetup->getData(m_esMIPToGeVConstantToken);
     if (1.1 > esgain->getESGain())
       ESgain = 1;
     else
       ESgain = 2;
     if (ESgain == 1)
       ESMIPToGeV = esMipToGeV->getESValueLow();
     else
       ESMIPToGeV = esMipToGeV->getESValueHigh();
   }

◆ peToAConversion()

template<class ECALDIGITIZERTRAITS>

double EcalSignalGenerator< ECALDIGITIZERTRAITS >::peToAConversion ( const DetId & detId ) const

inlineprivate

Definition at line 286 of file EcalSignalGenerator.h.

                                                    {
     return detId.subdetId() == EcalBarrel ? m_peToABarrel : m_peToAEndcap;
   }

◆ samplesInPE()

template<class ECALDIGITIZERTRAITS>

CaloSamples EcalSignalGenerator< ECALDIGITIZERTRAITS >::samplesInPE ( const DIGI & digi )

private

Referenced by EcalSignalGenerator< EEDigitizerTraits >::fill().

◆ validDigi()

template<class ECALDIGITIZERTRAITS>

bool EcalSignalGenerator< ECALDIGITIZERTRAITS >::validDigi ( const DIGI & digi )

inlineprivate

Definition at line 235 of file EcalSignalGenerator.h.

Referenced by EcalSignalGenerator< EEDigitizerTraits >::fill().

                                    {
     int DigiSum = 0;
     for (int id = 0; id < digi.size(); id++) {
       if (digi[id].adc() > 0)
         ++DigiSum;
     }
     return (DigiSum > 0);
   }