#include <EcalHitResponse.h>

Inheritance diagram for EcalHitResponse:

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

typedef CaloTSamplesBase< float >	EcalSamples

typedef std::vector< unsigned int >	VecInd

Public Member Functions
virtual void	add (const CaloSamples &hit)

void	add (const EcalSamples *pSam)

virtual void	add (const PCaloHit &hit, CLHEP::HepRandomEngine *)

	EcalHitResponse (const CaloVSimParameterMap parameterMap, const CaloVShape shape)

virtual void	finalizeHits ()

const EcalSamples *	findDetId (const DetId &detId) const

virtual void	initializeHits ()

virtual const EcalSamples *	operator[] (unsigned int i) const =0

virtual EcalSamples *	operator[] (unsigned int i)=0

virtual void	run (MixCollection< PCaloHit > &hits, CLHEP::HepRandomEngine *)

virtual unsigned int	samplesSize () const =0

void	setBunchRange (int minBunch, int maxBunch)

void	setEventTime (const edm::TimeValue_t &iTime)

void	setGeometry (const CaloSubdetectorGeometry *geometry)

void	setHitCorrection (const CaloVHitCorrection *hitCorrection)

void	setHitFilter (const CaloVHitFilter *filter)

void	setLaserConstants (const EcalLaserDbService *laser, bool &useLCcorrection)

void	setPECorrection (const CaloVPECorrection *peCorrection)

void	setPhaseShift (double phaseShift)

bool	withinBunchRange (int bunchCrossing) const

virtual	~EcalHitResponse ()

Public Attributes
const float	kSamplePeriod = ecalPh1::Samp_Period

Protected Member Functions
double	analogSignalAmplitude (const DetId &id, double energy, CLHEP::HepRandomEngine *)

void	blankOutUsedSamples ()

double	findLaserConstant (const DetId &detId) const

EcalSamples *	findSignal (const DetId &detId)

const CaloSubdetectorGeometry *	geometry () const

const CaloVHitFilter *	hitFilter () const

VecInd &	index ()

const VecInd &	index () const

int	maxBunch () const

int	minBunch () const

const CaloSimParameters *	params (const DetId &detId) const

double	phaseShift () const

virtual void	putAnalogSignal (const PCaloHit &inputHit, CLHEP::HepRandomEngine *)

virtual unsigned int	samplesSizeAll () const =0

const CaloVShape *	shape () const

double	timeOfFlight (const DetId &detId) const

virtual EcalSamples *	vSam (unsigned int i)=0

virtual const EcalSamples *	vSamAll (unsigned int i) const =0

virtual EcalSamples *	vSamAll (unsigned int i)=0

Protected Attributes
const CaloSubdetectorGeometry *	m_geometry

const CaloVHitCorrection *	m_hitCorrection

const CaloVHitFilter *	m_hitFilter

const EcalLaserDbService *	m_lasercals

const CaloVSimParameterMap *	m_parameterMap

const CaloVPECorrection *	m_PECorrection

const CaloVShape *	m_shape

Private Attributes
VecInd	m_index

edm::TimeValue_t	m_iTime

CalibCache	m_laserCalibCache

int	m_maxBunch

int	m_minBunch

double	m_phaseShift

bool	m_useLCcorrection

Detailed Description

Definition at line 29 of file EcalHitResponse.h.

Member Typedef Documentation

◆ CalibCache

typedef std::unordered_map<uint32_t, double> EcalHitResponse::CalibCache

Definition at line 35 of file EcalHitResponse.h.

◆ EcalSamples

typedef CaloTSamplesBase<float> EcalHitResponse::EcalSamples

Definition at line 31 of file EcalHitResponse.h.

◆ VecInd

typedef std::vector<unsigned int> EcalHitResponse::VecInd

Definition at line 33 of file EcalHitResponse.h.

Constructor & Destructor Documentation

◆ EcalHitResponse()

EcalHitResponse::EcalHitResponse	(	const CaloVSimParameterMap *	parameterMap,
		const CaloVShape *	shape
	)

Definition at line 20 of file EcalHitResponse.cc.

     : m_parameterMap(parameterMap),
       m_shape(shape),
       m_hitCorrection(nullptr),
       m_PECorrection(nullptr),
       m_hitFilter(nullptr),
       m_geometry(nullptr),
       m_lasercals(nullptr),
       m_minBunch(-32),
       m_maxBunch(10),
       m_phaseShift(1),
       m_iTime(0),
       m_useLCcorrection(false) {}

◆ ~EcalHitResponse()

EcalHitResponse::~EcalHitResponse ( )

virtual

Definition at line 34 of file EcalHitResponse.cc.

34 {}

Member Function Documentation

◆ add() [1/3]

void EcalHitResponse::add ( const CaloSamples & hit )

virtual

Definition at line 96 of file EcalHitResponse.cc.

                                                 {
   const DetId detId(hit.id());
  
   EcalSamples& result(*findSignal(detId));
  
   const int rsize(result.size());
  
   if (rsize != hit.size()) {
     throw cms::Exception("EcalDigitization") << "CaloSamples and EcalSamples have different sizes. Type Mismatach";
   }
  
   for (int bin(0); bin != rsize; ++bin) {
     result[bin] += hit[bin];
   }
 }

References newFWLiteAna::bin, Exception, findSignal(), hit::id, and mps_fire::result.

Referenced by counter.Counter::register().

◆ add() [2/3]

void EcalHitResponse::add ( const EcalSamples * pSam )

Definition at line 209 of file EcalHitResponse.cc.

                                                  {
   EcalSamples& sam(*findSignal(pSam->id()));
   sam += (*pSam);
 }

References findSignal(), and CaloTSamplesBase< Ttype >::id().

Referenced by counter.Counter::register().

◆ add() [3/3]

void EcalHitResponse::add	(	const PCaloHit &	hit,
		CLHEP::HepRandomEngine *	engine
	)

virtual

Reimplemented in EBHitResponseImpl< constset >.

Definition at line 90 of file EcalHitResponse.cc.

                                                                            {
   if (!edm::isNotFinite(hit.time()) && (nullptr == m_hitFilter || m_hitFilter->accepts(hit))) {
     putAnalogSignal(hit, engine);
   }
 }

References CaloVHitFilter::accepts(), edm::isNotFinite(), m_hitFilter, and putAnalogSignal().

Referenced by counter.Counter::register().

◆ analogSignalAmplitude()

double EcalHitResponse::analogSignalAmplitude	(	const DetId &	id,
		double	energy,
		CLHEP::HepRandomEngine *	engine
	)

protected

Definition at line 174 of file EcalHitResponse.cc.

                                                                                                              {
   const CaloSimParameters& parameters(*params(detId));
  
   // OK, the "energy" in the hit could be a real energy, deposited energy,
   // or pe count.  This factor converts to photoelectrons
  
   double lasercalib = 1.;
   if (m_useLCcorrection == true && detId.subdetId() != 3) {
     auto cache = m_laserCalibCache.find(detId);
     if (cache != m_laserCalibCache.end()) {
       lasercalib = cache->second;
     } else {
       lasercalib = 1.0 / findLaserConstant(detId);
       m_laserCalibCache.emplace(detId, lasercalib);
     }
   }
  
   double npe(energy * lasercalib * parameters.simHitToPhotoelectrons(detId));
  
   // do we need to doPoisson statistics for the photoelectrons?
   if (parameters.doPhotostatistics()) {
     npe = CLHEP::RandPoissonQ::shoot(engine, npe);
   }
   if (nullptr != m_PECorrection)
     npe = m_PECorrection->correctPE(detId, npe, engine);
  
   return npe;
 }

References utilities::cache(), CaloVPECorrection::correctPE(), HCALHighEnergyHPDFilter_cfi::energy, findLaserConstant(), m_laserCalibCache, m_PECorrection, m_useLCcorrection, params(), and DetId::subdetId().

Referenced by putAnalogSignal().

◆ blankOutUsedSamples()

void EcalHitResponse::blankOutUsedSamples ( )

protected

Definition at line 79 of file EcalHitResponse.cc.

 {
   const unsigned int size(m_index.size());
  
   for (unsigned int i(0); i != size; ++i) {
     vSamAll(m_index[i])->setZero();
   }
   m_index.erase(m_index.begin(),  // done and make ready to start over
                 m_index.end());
 }

References mps_fire::i, m_index, CaloTSamplesBase< Ttype >::setZero(), findQualityFiles::size, and vSamAll().

Referenced by initializeHits(), and run().

◆ finalizeHits()

void EcalHitResponse::finalizeHits ( )

virtual

Reimplemented in EBHitResponseImpl< constset >.

Definition at line 118 of file EcalHitResponse.cc.

118 {}

◆ findDetId()

const EcalHitResponse::EcalSamples * EcalHitResponse::findDetId ( const DetId & detId ) const

Definition at line 224 of file EcalHitResponse.cc.

                                                                                      {
   const unsigned int di(CaloGenericDetId(detId).denseIndex());
   return vSamAll(di);
 }

References vSamAll().

Referenced by ESDigitizer::run().

◆ findLaserConstant()

double EcalHitResponse::findLaserConstant ( const DetId & detId ) const

protected

Definition at line 161 of file EcalHitResponse.cc.

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

References EcalLaserDbService::getLaserCorrection(), m_iTime, and m_lasercals.

Referenced by analogSignalAmplitude().

◆ findSignal()

EcalHitResponse::EcalSamples * EcalHitResponse::findSignal ( const DetId & detId )

protected

Definition at line 166 of file EcalHitResponse.cc.

                                                                           {
   const unsigned int di(CaloGenericDetId(detId).denseIndex());
   EcalSamples* result(vSamAll(di));
   if (result->zero())
     m_index.push_back(di);
   return result;
 }

References m_index, mps_fire::result, and vSamAll().

Referenced by add(), and putAnalogSignal().

◆ geometry()

const CaloSubdetectorGeometry * EcalHitResponse::geometry ( ) const

protected

Definition at line 46 of file EcalHitResponse.cc.

                                                                {
   assert(nullptr != m_geometry);
   return m_geometry;
 }

References cms::cuda::assert(), and m_geometry.

Referenced by setGeometry(), and timeOfFlight().

◆ hitFilter()

const CaloVHitFilter * EcalHitResponse::hitFilter ( ) const

protected

Definition at line 222 of file EcalHitResponse.cc.

222 { return m_hitFilter; }

References m_hitFilter.

◆ index() [1/2]

EcalHitResponse::VecInd & EcalHitResponse::index ( )

protected

Definition at line 218 of file EcalHitResponse.cc.

218 { return m_index; }

References m_index.

Referenced by BeautifulSoup.PageElement::insert(), ESHitResponse::operator[](), ESHitResponse::samplesSize(), and ESHitResponse::vSam().

◆ index() [2/2]

const EcalHitResponse::VecInd & EcalHitResponse::index ( ) const

protected

Definition at line 220 of file EcalHitResponse.cc.

220 { return m_index; }

References m_index.

Referenced by BeautifulSoup.PageElement::insert().

◆ initializeHits()

void EcalHitResponse::initializeHits ( )

virtual

Reimplemented in EBHitResponseImpl< constset >.

Definition at line 116 of file EcalHitResponse.cc.

116 { blankOutUsedSamples(); }

References blankOutUsedSamples().

◆ maxBunch()

int EcalHitResponse::maxBunch ( ) const

protected

Definition at line 216 of file EcalHitResponse.cc.

216 { return m_maxBunch; }

References m_maxBunch.

Referenced by setBunchRange().

◆ minBunch()

int EcalHitResponse::minBunch ( ) const

protected

Definition at line 214 of file EcalHitResponse.cc.

214 { return m_minBunch; }

References m_minBunch.

Referenced by setBunchRange().

◆ operator[]() [1/2]

virtual const EcalSamples* EcalHitResponse::operator[] ( unsigned int i ) const

pure virtual

Implemented in EBHitResponseImpl< constset >, EEHitResponse, and ESHitResponse.

◆ operator[]() [2/2]

virtual EcalSamples* EcalHitResponse::operator[] ( unsigned int i )

pure virtual

Implemented in EBHitResponseImpl< constset >, EEHitResponse, and ESHitResponse.

◆ params()

const CaloSimParameters * EcalHitResponse::params ( const DetId & detId ) const

protected

Definition at line 36 of file EcalHitResponse.cc.

                                                                          {
   assert(nullptr != m_parameterMap);
   return &m_parameterMap->simParameters(detId);
 }

References cms::cuda::assert(), m_parameterMap, and CaloVSimParameterMap::simParameters().

Referenced by analogSignalAmplitude(), and putAnalogSignal().

◆ phaseShift()

double EcalHitResponse::phaseShift ( ) const

protected

Definition at line 60 of file EcalHitResponse.cc.

60 { return m_phaseShift; }

References m_phaseShift.

Referenced by setPhaseShift().

◆ putAnalogSignal()

void EcalHitResponse::putAnalogSignal	(	const PCaloHit &	inputHit,
		CLHEP::HepRandomEngine *	engine
	)

protectedvirtual

Reimplemented in EBHitResponseImpl< constset >.

Definition at line 132 of file EcalHitResponse.cc.

                                                                                        {
   const DetId detId(hit.id());
  
   const CaloSimParameters* parameters(params(detId));
  
   const double signal(analogSignalAmplitude(detId, hit.energy(), engine));
  
   double time = hit.time();
  
   if (m_hitCorrection) {
     time += m_hitCorrection->delay(hit, engine);
   }
  
   const double jitter(time - timeOfFlight(detId));
  
   const double tzero = (shape()->timeToRise() + parameters->timePhase() - jitter -
                         kSamplePeriod * (parameters->binOfMaximum() - m_phaseShift));
   double binTime(tzero);
  
   EcalSamples& result(*findSignal(detId));
  
   const unsigned int rsize(result.size());
  
   for (unsigned int bin(0); bin != rsize; ++bin) {
     result[bin] += (*shape())(binTime)*signal;
     binTime += kSamplePeriod;
   }
 }

References analogSignalAmplitude(), newFWLiteAna::bin, CaloVHitCorrection::delay(), findSignal(), hit::id, kSamplePeriod, m_hitCorrection, m_phaseShift, params(), mps_fire::result, shape(), protons_cff::time, timeOfFlight(), CaloVShape::timeToRise(), and tzero.

Referenced by add(), and run().

◆ run()

void EcalHitResponse::run	(	MixCollection< PCaloHit > &	hits,
		CLHEP::HepRandomEngine *	engine
	)

virtual

Reimplemented in EBHitResponseImpl< constset >.

Definition at line 120 of file EcalHitResponse.cc.

                                                                                      {
   blankOutUsedSamples();
  
   for (MixCollection<PCaloHit>::MixItr hitItr(hits.begin()); hitItr != hits.end(); ++hitItr) {
     const PCaloHit& hit(*hitItr);
     const int bunch(hitItr.bunch());
     if (withinBunchRange(bunch) && !edm::isNotFinite(hit.time()) &&
         (nullptr == m_hitFilter || m_hitFilter->accepts(hit)))
       putAnalogSignal(hit, engine);
   }
 }

References CaloVHitFilter::accepts(), blankOutUsedSamples(), hfClusterShapes_cfi::hits, edm::isNotFinite(), m_hitFilter, putAnalogSignal(), and withinBunchRange().

◆ samplesSize()

virtual unsigned int EcalHitResponse::samplesSize ( ) const

pure virtual

Implemented in EBHitResponseImpl< constset >, EEHitResponse, and ESHitResponse.

◆ samplesSizeAll()

virtual unsigned int EcalHitResponse::samplesSizeAll ( ) const

protectedpure virtual

Implemented in EBHitResponseImpl< constset >, EEHitResponse, and ESHitResponse.

◆ setBunchRange()

void EcalHitResponse::setBunchRange	(	int	minBunch,
		int	maxBunch
	)

Definition at line 51 of file EcalHitResponse.cc.

                                                               {
   m_minBunch = minBunch;
   m_maxBunch = maxBunch;
 }

References m_maxBunch, m_minBunch, maxBunch(), and minBunch().

◆ setEventTime()

void EcalHitResponse::setEventTime ( const edm::TimeValue_t & iTime )

Definition at line 68 of file EcalHitResponse.cc.

                                                               {
   m_iTime = iTime;
   //clear the laser cache for each event time
   CalibCache().swap(m_laserCalibCache);
 }

References m_iTime, and m_laserCalibCache.

◆ setGeometry()

void EcalHitResponse::setGeometry ( const CaloSubdetectorGeometry * geometry )

Definition at line 56 of file EcalHitResponse.cc.

56 { m_geometry = geometry; }

References geometry(), and m_geometry.

◆ setHitCorrection()

void EcalHitResponse::setHitCorrection ( const CaloVHitCorrection * hitCorrection )

Definition at line 64 of file EcalHitResponse.cc.

64 { m_hitCorrection = hitCorrection; }

References m_hitCorrection.

◆ setHitFilter()

void EcalHitResponse::setHitFilter ( const CaloVHitFilter * filter )

Definition at line 62 of file EcalHitResponse.cc.

62 { m_hitFilter = filter; }

References ALCARECOTkAlBeamHalo_cff::filter, and m_hitFilter.

◆ setLaserConstants()

void EcalHitResponse::setLaserConstants	(	const EcalLaserDbService *	laser,
		bool &	useLCcorrection
	)

Definition at line 74 of file EcalHitResponse.cc.

                                                                                               {
   m_lasercals = laser;
   m_useLCcorrection = useLCcorrection;
 }

References EcalCondDBWriter_cfi::laser, m_lasercals, and m_useLCcorrection.

◆ setPECorrection()

void EcalHitResponse::setPECorrection ( const CaloVPECorrection * peCorrection )

Definition at line 66 of file EcalHitResponse.cc.

66 { m_PECorrection = peCorrection; }

References m_PECorrection.

◆ setPhaseShift()

void EcalHitResponse::setPhaseShift ( double phaseShift )

Definition at line 58 of file EcalHitResponse.cc.

58 { m_phaseShift = phaseShift; }

References m_phaseShift, and phaseShift().

◆ shape()

const CaloVShape * EcalHitResponse::shape ( void ) const

protected

Definition at line 41 of file EcalHitResponse.cc.

                                                {
   assert(nullptr != m_shape);
   return m_shape;
 }

References cms::cuda::assert(), and m_shape.

Referenced by ESHitResponse::ESHitResponse(), and putAnalogSignal().

◆ timeOfFlight()

double EcalHitResponse::timeOfFlight ( const DetId & detId ) const

protected

Definition at line 203 of file EcalHitResponse.cc.

                                                              {
   auto cellGeometry(geometry()->getGeometry(detId));
   assert(nullptr != cellGeometry);
   return cellGeometry->getPosition().mag() * cm / c_light;  // Units of c_light: mm/ns
 }

References cms::cuda::assert(), and geometry().

Referenced by putAnalogSignal().

◆ vSam()

virtual EcalSamples* EcalHitResponse::vSam ( unsigned int i )

protectedpure virtual

Implemented in EBHitResponseImpl< constset >, EEHitResponse, and ESHitResponse.

◆ vSamAll() [1/2]

virtual const EcalSamples* EcalHitResponse::vSamAll ( unsigned int i ) const

protectedpure virtual

Implemented in EBHitResponseImpl< constset >, EEHitResponse, and ESHitResponse.

◆ vSamAll() [2/2]

virtual EcalSamples* EcalHitResponse::vSamAll ( unsigned int i )

protectedpure virtual

Implemented in EBHitResponseImpl< constset >, EEHitResponse, and ESHitResponse.

Referenced by blankOutUsedSamples(), findDetId(), and findSignal().

◆ withinBunchRange()

bool EcalHitResponse::withinBunchRange ( int bunchCrossing ) const

Definition at line 112 of file EcalHitResponse.cc.

                                                               {
   return (m_minBunch <= bunchCrossing && m_maxBunch >= bunchCrossing);
 }

Referenced by run().

Member Data Documentation

◆ kSamplePeriod

const float EcalHitResponse::kSamplePeriod = ecalPh1::Samp_Period

Definition at line 41 of file EcalHitResponse.h.

Referenced by putAnalogSignal().

◆ m_geometry

const CaloSubdetectorGeometry* EcalHitResponse::m_geometry

protected

Definition at line 125 of file EcalHitResponse.h.

Referenced by geometry(), and setGeometry().

◆ m_hitCorrection

const CaloVHitCorrection* EcalHitResponse::m_hitCorrection

protected

Definition at line 122 of file EcalHitResponse.h.

Referenced by putAnalogSignal(), and setHitCorrection().

◆ m_hitFilter

const CaloVHitFilter* EcalHitResponse::m_hitFilter

protected

Definition at line 124 of file EcalHitResponse.h.

Referenced by add(), hitFilter(), run(), and setHitFilter().

◆ m_index

VecInd EcalHitResponse::m_index

private

Definition at line 137 of file EcalHitResponse.h.

Referenced by blankOutUsedSamples(), findSignal(), and index().

◆ m_iTime

edm::TimeValue_t EcalHitResponse::m_iTime

private

Definition at line 133 of file EcalHitResponse.h.

Referenced by findLaserConstant(), and setEventTime().

◆ m_laserCalibCache

CalibCache EcalHitResponse::m_laserCalibCache

private

Definition at line 135 of file EcalHitResponse.h.

Referenced by analogSignalAmplitude(), and setEventTime().

◆ m_lasercals

const EcalLaserDbService* EcalHitResponse::m_lasercals

protected

Definition at line 126 of file EcalHitResponse.h.

Referenced by findLaserConstant(), and setLaserConstants().

◆ m_maxBunch

int EcalHitResponse::m_maxBunch

private

Definition at line 130 of file EcalHitResponse.h.

Referenced by maxBunch(), and setBunchRange().

◆ m_minBunch

int EcalHitResponse::m_minBunch

private

Definition at line 129 of file EcalHitResponse.h.

Referenced by minBunch(), and setBunchRange().

◆ m_parameterMap

const CaloVSimParameterMap* EcalHitResponse::m_parameterMap

protected

Definition at line 120 of file EcalHitResponse.h.

Referenced by params().

◆ m_PECorrection

const CaloVPECorrection* EcalHitResponse::m_PECorrection

protected

Definition at line 123 of file EcalHitResponse.h.

Referenced by analogSignalAmplitude(), and setPECorrection().

◆ m_phaseShift

double EcalHitResponse::m_phaseShift

private

Definition at line 131 of file EcalHitResponse.h.

Referenced by phaseShift(), putAnalogSignal(), and setPhaseShift().

◆ m_shape

const CaloVShape* EcalHitResponse::m_shape

protected

Definition at line 121 of file EcalHitResponse.h.

Referenced by shape().

◆ m_useLCcorrection

bool EcalHitResponse::m_useLCcorrection

private

Definition at line 134 of file EcalHitResponse.h.

Referenced by analogSignalAmplitude(), and setLaserConstants().

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CalibCache

◆ EcalSamples

◆ VecInd

Constructor & Destructor Documentation

◆ EcalHitResponse()

◆ ~EcalHitResponse()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ analogSignalAmplitude()

◆ blankOutUsedSamples()

◆ finalizeHits()

◆ findDetId()

◆ findLaserConstant()

◆ findSignal()

◆ geometry()

◆ hitFilter()

◆ index() [1/2]

◆ index() [2/2]

◆ initializeHits()

◆ maxBunch()

◆ minBunch()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ params()

◆ phaseShift()

◆ putAnalogSignal()

◆ run()

◆ samplesSize()

◆ samplesSizeAll()

◆ setBunchRange()

◆ setEventTime()

◆ setGeometry()

◆ setHitCorrection()

◆ setHitFilter()

◆ setLaserConstants()

◆ setPECorrection()

◆ setPhaseShift()

◆ shape()

◆ timeOfFlight()

◆ vSam()

◆ vSamAll() [1/2]

◆ vSamAll() [2/2]

◆ withinBunchRange()

Member Data Documentation

◆ kSamplePeriod

◆ m_geometry

◆ m_hitCorrection

◆ m_hitFilter

◆ m_index

◆ m_iTime

◆ m_laserCalibCache

◆ m_lasercals

◆ m_maxBunch

◆ m_minBunch

◆ m_parameterMap

◆ m_PECorrection

◆ m_phaseShift

◆ m_shape

◆ m_useLCcorrection