Creates electronics signals from hits. More...

#include <CaloHitResponse.h>

Inheritance diagram for CaloHitResponse:

Public Types
enum	{ BUNCHSPACE = 25 }

typedef std::map< DetId, CaloSamples >	AnalogSignalMap

Public Member Functions
virtual void	add (const CaloSamples &signal)
	add a signal, in units of pe More...

virtual void	add (const PCaloHit &hit, CLHEP::HepRandomEngine *)
	process a single SimHit More...

void	addHit (const PCaloHit *hit, CaloSamples &frame) const
	adds the amplitude for a single hit to the frame More...

double	analogSignalAmplitude (const DetId &id, float energy, const CaloSimParameters &parameters, CLHEP::HepRandomEngine *) const

	CaloHitResponse (const CaloVSimParameterMap parameterMap, const CaloShapes shapes)

	CaloHitResponse (const CaloVSimParameterMap parameterMap, const CaloVShape shape)

void	clear ()
	frees up memory More...

virtual void	finalizeHits (CLHEP::HepRandomEngine *)
	Finalize hits. More...

CaloSamples *	findSignal (const DetId &detId)
	users can look for the signal for a given cell More...

virtual void	initializeHits ()
	Initialize hits. More...

virtual bool	keepBlank () const

virtual CaloSamples	makeAnalogSignal (const PCaloHit &inputHit, CLHEP::HepRandomEngine *) const
	creates the signal corresponding to this hit More...

CaloSamples	makeBlankSignal (const DetId &detId) const
	creates an empty signal for this DetId More...

int	nSignals () const
	number of signals in the current cache More...

virtual void	run (const MixCollection< PCaloHit > &hits, CLHEP::HepRandomEngine *)
	Complete cell digitization. More...

void	setBunchRange (int minBunch, int maxBunch)
	tells it which pileup bunches to do More...

void	setGeometry (const CaloGeometry *geometry)
	geometry needed for time-of-flight More...

void	setHitCorrection (const CaloVHitCorrection *hitCorrection)
	If you want to correct hits, for attenuation or delay, set this. More...

void	setHitFilter (const CaloVHitFilter *filter)

void	setIgnoreGeantTime (bool gt)

void	setPECorrection (const CaloVPECorrection *peCorrection)
	if you want to correct the photoelectrons More...

void	setPhaseShift (const double &thePhaseShift)
	setting the phase shift for asynchronous trigger (e.g. test beams) More...

void	setStorePrecise (bool sp)

double	timeOfFlight (const DetId &detId) const

bool	withinBunchRange (int bunchCrossing) const
	check if crossing is within bunch range: More...

virtual	~CaloHitResponse ()
	doesn't delete the pointers passed in More...

Protected Attributes
bool	ignoreTime

bool	storePrecise

AnalogSignalMap	theAnalogSignalMap

const CaloGeometry *	theGeometry

const CaloVHitCorrection *	theHitCorrection

const CaloVHitFilter *	theHitFilter

int	theMaxBunch

int	theMinBunch

const CaloVSimParameterMap *	theParameterMap

const CaloVPECorrection *	thePECorrection

double	thePhaseShift_

const CaloVShape *	theShape

const CaloShapes *	theShapes

Detailed Description

Creates electronics signals from hits.

Definition at line 33 of file CaloHitResponse.h.

Member Typedef Documentation

◆ AnalogSignalMap

typedef std::map<DetId, CaloSamples> CaloHitResponse::AnalogSignalMap

Definition at line 35 of file CaloHitResponse.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
BUNCHSPACE

Definition at line 37 of file CaloHitResponse.h.

37 { BUNCHSPACE = 25 };

Constructor & Destructor Documentation

◆ CaloHitResponse() [1/2]

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

Definition at line 21 of file CaloHitResponse.cc.

     : theAnalogSignalMap(),
       theParameterMap(parametersMap),
       theShapes(nullptr),
       theShape(shape),
       theHitCorrection(nullptr),
       thePECorrection(nullptr),
       theHitFilter(nullptr),
       theGeometry(nullptr),
       theMinBunch(-10),
       theMaxBunch(10),
       thePhaseShift_(1.),
       storePrecise(false),
       ignoreTime(false) {}

◆ CaloHitResponse() [2/2]

CaloHitResponse::CaloHitResponse	(	const CaloVSimParameterMap *	parameterMap,
		const CaloShapes *	shapes
	)

Definition at line 36 of file CaloHitResponse.cc.

     : theAnalogSignalMap(),
       theParameterMap(parametersMap),
       theShapes(shapes),
       theShape(nullptr),
       theHitCorrection(nullptr),
       thePECorrection(nullptr),
       theHitFilter(nullptr),
       theGeometry(nullptr),
       theMinBunch(-10),
       theMaxBunch(10),
       thePhaseShift_(1.),
       storePrecise(false),
       ignoreTime(false) {}

◆ ~CaloHitResponse()

CaloHitResponse::~CaloHitResponse ( )

virtual

doesn't delete the pointers passed in

Definition at line 51 of file CaloHitResponse.cc.

51 {}

Member Function Documentation

◆ add() [1/2]

void CaloHitResponse::add ( const CaloSamples & signal )

virtual

add a signal, in units of pe

Reimplemented in HcalSiPMHitResponse.

Definition at line 91 of file CaloHitResponse.cc.

                                                    {
   DetId id(signal.id());
   CaloSamples *oldSignal = findSignal(id);
   if (oldSignal == nullptr) {
     theAnalogSignalMap[id] = signal;
  
   } else {
     (*oldSignal) += signal;
   }
 }

References findSignal(), CaloSamples::id(), triggerObjects_cff::id, and theAnalogSignalMap.

Referenced by counter.Counter::register().

◆ add() [2/2]

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

virtual

process a single SimHit

Reimplemented in HcalSiPMHitResponse.

Definition at line 66 of file CaloHitResponse.cc.

                                                                            {
   // check the hit time makes sense
   if (edm::isNotFinite(hit.time())) {
     return;
   }
  
   // maybe it's not from this subdetector
   if (theHitFilter == nullptr || theHitFilter->accepts(hit)) {
     LogDebug("CaloHitResponse") << hit;
     CaloSamples signal(makeAnalogSignal(hit, engine));
     bool keep(keepBlank());  // here we  check for blank signal if not keeping them
     if (!keep) {
       const unsigned int size(signal.size());
       if (0 != size) {
         for (unsigned int i(0); i != size; ++i) {
           keep = keep || signal[i] > 1.e-7;
         }
       }
     }
  
     if (keep)
       add(signal);
   }
 }

References CaloVHitFilter::accepts(), mps_fire::i, edm::isNotFinite(), keep, keepBlank(), LogDebug, makeAnalogSignal(), CaloSamples::size(), findQualityFiles::size, and theHitFilter.

Referenced by HcalSiPMHitResponse::add(), CaloTDigitizer< Traits, runHelper >::add(), CaloTDigitizer< Traits, runHelper >::addNoiseSignals(), HcalSiPMHitResponse::finalizeHits(), counter.Counter::register(), and run().

◆ addHit()

void CaloHitResponse::addHit	(	const PCaloHit *	hit,
		CaloSamples &	frame
	)		const

adds the amplitude for a single hit to the frame

◆ analogSignalAmplitude()

double CaloHitResponse::analogSignalAmplitude	(	const DetId &	id,
		float	energy,
		const CaloSimParameters &	parameters,
		CLHEP::HepRandomEngine *	engine
	)		const

finds the amplitude contribution from this hit, applying photostatistics, if needed. Results are in photoelectrons

Definition at line 147 of file CaloHitResponse.cc.

                                                                                   {
   // OK, the "energy" in the hit could be a real energy, deposited energy,
   // or pe count.  This factor converts to photoelectrons
   // GMA Smeared in photon production it self
   double npe = energy * parameters.simHitToPhotoelectrons(detId);
   // do we need to doPoisson statistics for the photoelectrons?
   if (parameters.doPhotostatistics()) {
     npe = CLHEP::RandPoissonQ::shoot(engine, npe);
   }
   if (thePECorrection)
     npe = thePECorrection->correctPE(detId, npe, engine);
   return npe;
 }

References CaloVPECorrection::correctPE(), HCALHighEnergyHPDFilter_cfi::energy, and thePECorrection.

Referenced by HcalSiPMHitResponse::add(), and makeAnalogSignal().

◆ clear()

void CaloHitResponse::clear ( void )

inline

frees up memory

Definition at line 79 of file CaloHitResponse.h.

79 { theAnalogSignalMap.clear(); }

References theAnalogSignalMap.

Referenced by EcalMixingModuleValidation::computeSDBunchDigi(), and CaloTDigitizer< Traits, runHelper >::run().

◆ finalizeHits()

virtual void CaloHitResponse::finalizeHits ( CLHEP::HepRandomEngine * )

inlinevirtual

Finalize hits.

Reimplemented in HcalSiPMHitResponse.

Definition at line 57 of file CaloHitResponse.h.

57 {}

Referenced by CaloTDigitizer< Traits, runHelper >::run().

◆ findSignal()

CaloSamples * CaloHitResponse::findSignal ( const DetId & detId )

users can look for the signal for a given cell

Definition at line 164 of file CaloHitResponse.cc.

                                                            {
   CaloSamples *result = nullptr;
   AnalogSignalMap::iterator signalItr = theAnalogSignalMap.find(detId);
   if (signalItr == theAnalogSignalMap.end()) {
     result = nullptr;
   } else {
     result = &(signalItr->second);
   }
   return result;
 }

References mps_fire::result, and theAnalogSignalMap.

Referenced by add(), EcalMixingModuleValidation::computeSDBunchDigi(), and CaloTDigitizer< Traits, runHelper >::run().

◆ initializeHits()

virtual void CaloHitResponse::initializeHits ( )

inlinevirtual

Initialize hits.

Reimplemented in HcalSiPMHitResponse.

Definition at line 54 of file CaloHitResponse.h.

54 {}

Referenced by CaloTDigitizer< Traits, runHelper >::initializeHits().

◆ keepBlank()

virtual bool CaloHitResponse::keepBlank ( ) const

inlinevirtual

Definition at line 51 of file CaloHitResponse.h.

51 { return true; }

Referenced by add(), and HcalSiPMHitResponse::finalizeHits().

◆ makeAnalogSignal()

CaloSamples CaloHitResponse::makeAnalogSignal	(	const PCaloHit &	inputHit,
		CLHEP::HepRandomEngine *	engine
	)		const

virtual

creates the signal corresponding to this hit

Definition at line 102 of file CaloHitResponse.cc.

                                                                                                      {
   DetId detId(hit.id());
   const CaloSimParameters &parameters = theParameterMap->simParameters(detId);
   double signal = analogSignalAmplitude(detId, hit.energy(), parameters, engine);
  
   double time = hit.time();
   double tof = timeOfFlight(detId);
   if (ignoreTime)
     time = tof;
   if (theHitCorrection != nullptr) {
     time += theHitCorrection->delay(hit, engine);
   }
   double jitter = time - tof;
  
   const CaloVShape *shape = theShape;
   if (!shape) {
     shape = theShapes->shape(detId, storePrecise);
   }
   // assume bins count from zero, go for center of bin
   const double tzero = (shape->timeToRise() + parameters.timePhase() - jitter -
                         BUNCHSPACE * (parameters.binOfMaximum() - thePhaseShift_));
   double binTime = tzero;
  
   CaloSamples result(makeBlankSignal(detId));
  
   if (storePrecise) {
     result.resetPrecise();
     int sampleBin(0);
     // use 1ns binning for precise sample
     for (int bin = 0; bin < result.size() * BUNCHSPACE; bin++) {
       sampleBin = bin / BUNCHSPACE;
       double pulseBit = (*shape)(binTime)*signal;
       result[sampleBin] += pulseBit;
       result.preciseAtMod(bin) += pulseBit;
       binTime += 1.0;
     }
   } else {
     for (int bin = 0; bin < result.size(); bin++) {
       result[bin] += (*shape)(binTime)*signal;
       binTime += BUNCHSPACE;
     }
   }
   return result;
 }

References analogSignalAmplitude(), newFWLiteAna::bin, BUNCHSPACE, CaloVHitCorrection::delay(), hit::id, ignoreTime, makeBlankSignal(), mps_fire::result, CaloShapes::shape(), CaloVSimParameterMap::simParameters(), storePrecise, theHitCorrection, theParameterMap, thePhaseShift_, theShape, theShapes, ntuplemaker::time, timeOfFlight(), CaloVShape::timeToRise(), and tzero.

Referenced by add().

◆ makeBlankSignal()

CaloSamples CaloHitResponse::makeBlankSignal ( const DetId & detId ) const

creates an empty signal for this DetId

Definition at line 175 of file CaloHitResponse.cc.

                                                                      {
   const CaloSimParameters &parameters = theParameterMap->simParameters(detId);
   int preciseSize(storePrecise ? parameters.readoutFrameSize() * BUNCHSPACE : 0);
   CaloSamples result(detId, parameters.readoutFrameSize(), preciseSize);
   result.setPresamples(parameters.binOfMaximum() - 1);
   if (storePrecise)
     result.setPrecise(result.presamples() * BUNCHSPACE, 1.0);
   return result;
 }

References BUNCHSPACE, mps_fire::result, CaloVSimParameterMap::simParameters(), storePrecise, and theParameterMap.

Referenced by makeAnalogSignal(), and CaloTDigitizer< Traits, runHelper >::run().

◆ nSignals()

int CaloHitResponse::nSignals ( ) const

inline

number of signals in the current cache

Definition at line 98 of file CaloHitResponse.h.

98 { return theAnalogSignalMap.size(); }

References theAnalogSignalMap.

Referenced by CaloTDigitizer< Traits, runHelper >::run().

◆ run()

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

virtual

Complete cell digitization.

Definition at line 58 of file CaloHitResponse.cc.

                                                                                            {
   for (MixCollection<PCaloHit>::MixItr hitItr = hits.begin(); hitItr != hits.end(); ++hitItr) {
     if (withinBunchRange(hitItr.bunch())) {
       add(*hitItr, engine);
     }  // loop over hits
   }
 }

References add(), hfClusterShapes_cfi::hits, and withinBunchRange().

Referenced by EcalMixingModuleValidation::computeSDBunchDigi().

◆ setBunchRange()

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

tells it which pileup bunches to do

Definition at line 53 of file CaloHitResponse.cc.

                                                               {
   theMinBunch = minBunch;
   theMaxBunch = maxBunch;
 }

References MixingModule_cfi::maxBunch, MixingModule_cfi::minBunch, theMaxBunch, and theMinBunch.

Referenced by EcalMixingModuleValidation::computeSDBunchDigi().

◆ setGeometry()

void CaloHitResponse::setGeometry ( const CaloGeometry * geometry )

inline

geometry needed for time-of-flight

Definition at line 49 of file CaloHitResponse.h.

49 { theGeometry = geometry; }

References geometry, and theGeometry.

Referenced by CastorDigiProducer::checkGeometry(), EcalMixingModuleValidation::computeSDBunchDigi(), and HcalTBDigiProducer::updateGeometry().

◆ setHitCorrection()

void CaloHitResponse::setHitCorrection ( const CaloVHitCorrection * hitCorrection )

inline

If you want to correct hits, for attenuation or delay, set this.

Definition at line 73 of file CaloHitResponse.h.

73 { theHitCorrection = hitCorrection; }

References theHitCorrection.

Referenced by CastorDigiProducer::CastorDigiProducer().

◆ setHitFilter()

void CaloHitResponse::setHitFilter ( const CaloVHitFilter * filter )

inline

if you want to reject hits, for example, from a certain subdetector, set this

Definition at line 70 of file CaloHitResponse.h.

70 { theHitFilter = filter; }

References ALCARECOTkAlBeamHalo_cff::filter, and theHitFilter.

Referenced by CastorDigiProducer::CastorDigiProducer(), and HcalTBDigiProducer::HcalTBDigiProducer().

◆ setIgnoreGeantTime()

void CaloHitResponse::setIgnoreGeantTime ( bool gt )

inline

Definition at line 118 of file CaloHitResponse.h.

118 { ignoreTime = gt; }

References ignoreTime.

◆ setPECorrection()

void CaloHitResponse::setPECorrection ( const CaloVPECorrection * peCorrection )

inline

if you want to correct the photoelectrons

Definition at line 76 of file CaloHitResponse.h.

76 { thePECorrection = peCorrection; }

References thePECorrection.

◆ setPhaseShift()

void CaloHitResponse::setPhaseShift ( const double & thePhaseShift )

inline

setting the phase shift for asynchronous trigger (e.g. test beams)

Definition at line 108 of file CaloHitResponse.h.

108 { thePhaseShift_ = thePhaseShift; }

References thePhaseShift_.

Referenced by HcalTBDigiProducer::setPhaseShift().

◆ setStorePrecise()

void CaloHitResponse::setStorePrecise ( bool sp )

inline

Definition at line 116 of file CaloHitResponse.h.

116 { storePrecise = sp; }

References storePrecise.

Referenced by CaloTDigitizer< Traits, runHelper >::run().

◆ timeOfFlight()

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

time-of-flight, in ns, to get to this cell returns 0 if no geometry has been set

Definition at line 185 of file CaloHitResponse.cc.

                                                              {
   // not going to assume there's one of these per subdetector.
   // Take the whole CaloGeometry and find the right subdet
   double result = 0.;
   if (theGeometry == nullptr) {
     edm::LogWarning("CaloHitResponse") << "No Calo Geometry set, so no time of flight correction";
   } else {
     auto cellGeometry = theGeometry->getSubdetectorGeometry(detId)->getGeometry(detId);
     if (cellGeometry == nullptr) {
       edm::LogWarning("CaloHitResponse") << "No Calo cell found for ID" << detId.rawId()
                                          << " so no time-of-flight subtraction will be done";
     } else {
       double distance = cellGeometry->getPosition().mag();
       result = distance * cm / c_light;  // Units of c_light: mm/ns
     }
   }
   return result;
 }

References HLT_2018_cff::distance, CaloSubdetectorGeometry::getGeometry(), CaloGeometry::getSubdetectorGeometry(), DetId::rawId(), mps_fire::result, and theGeometry.

Referenced by HcalSiPMHitResponse::add(), and makeAnalogSignal().

◆ withinBunchRange()

bool CaloHitResponse::withinBunchRange ( int bunchCrossing ) const

inline

check if crossing is within bunch range:

Definition at line 112 of file CaloHitResponse.h.

                                                  {
     return (bunchCrossing >= theMinBunch && bunchCrossing <= theMaxBunch);
   }

References theMaxBunch, and theMinBunch.

Referenced by CaloTDigitizer< Traits, runHelper >::add(), and run().

Member Data Documentation

◆ ignoreTime

bool CaloHitResponse::ignoreTime

protected

Definition at line 137 of file CaloHitResponse.h.

Referenced by HcalSiPMHitResponse::add(), makeAnalogSignal(), and setIgnoreGeantTime().

◆ storePrecise

bool CaloHitResponse::storePrecise

protected

Definition at line 136 of file CaloHitResponse.h.

Referenced by makeAnalogSignal(), makeBlankSignal(), and setStorePrecise().

◆ theAnalogSignalMap

AnalogSignalMap CaloHitResponse::theAnalogSignalMap

protected

Definition at line 121 of file CaloHitResponse.h.

Referenced by add(), clear(), findSignal(), and nSignals().

◆ theGeometry

const CaloGeometry* CaloHitResponse::theGeometry

protected

Definition at line 130 of file CaloHitResponse.h.

Referenced by setGeometry(), and timeOfFlight().

◆ theHitCorrection

const CaloVHitCorrection* CaloHitResponse::theHitCorrection

protected

Definition at line 126 of file CaloHitResponse.h.

Referenced by makeAnalogSignal(), and setHitCorrection().

◆ theHitFilter

const CaloVHitFilter* CaloHitResponse::theHitFilter

protected

Definition at line 128 of file CaloHitResponse.h.

Referenced by HcalSiPMHitResponse::add(), add(), and setHitFilter().

◆ theMaxBunch

int CaloHitResponse::theMaxBunch

protected

Definition at line 133 of file CaloHitResponse.h.

Referenced by setBunchRange(), and withinBunchRange().

◆ theMinBunch

int CaloHitResponse::theMinBunch

protected

Definition at line 132 of file CaloHitResponse.h.

Referenced by setBunchRange(), and withinBunchRange().

◆ theParameterMap

const CaloVSimParameterMap* CaloHitResponse::theParameterMap

protected

Definition at line 123 of file CaloHitResponse.h.

Referenced by HcalSiPMHitResponse::add(), HcalSiPMHitResponse::addPEnoise(), HcalSiPMHitResponse::getReadoutFrameSize(), makeAnalogSignal(), HcalSiPMHitResponse::makeBlankSignal(), makeBlankSignal(), and HcalSiPMHitResponse::makeSiPMSignal().

◆ thePECorrection

const CaloVPECorrection* CaloHitResponse::thePECorrection

protected

Definition at line 127 of file CaloHitResponse.h.

Referenced by analogSignalAmplitude(), and setPECorrection().

◆ thePhaseShift_

double CaloHitResponse::thePhaseShift_

protected

Definition at line 135 of file CaloHitResponse.h.

Referenced by HcalSiPMHitResponse::add(), makeAnalogSignal(), and setPhaseShift().

◆ theShape

const CaloVShape* CaloHitResponse::theShape

protected

Definition at line 125 of file CaloHitResponse.h.

Referenced by makeAnalogSignal().

◆ theShapes

const CaloShapes* CaloHitResponse::theShapes

protected

Definition at line 124 of file CaloHitResponse.h.

Referenced by makeAnalogSignal().

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ AnalogSignalMap

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ CaloHitResponse() [1/2]

◆ CaloHitResponse() [2/2]

◆ ~CaloHitResponse()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ addHit()

◆ analogSignalAmplitude()

◆ clear()

◆ finalizeHits()

◆ findSignal()

◆ initializeHits()

◆ keepBlank()

◆ makeAnalogSignal()

◆ makeBlankSignal()

◆ nSignals()

◆ run()

◆ setBunchRange()

◆ setGeometry()

◆ setHitCorrection()

◆ setHitFilter()

◆ setIgnoreGeantTime()

◆ setPECorrection()

◆ setPhaseShift()

◆ setStorePrecise()

◆ timeOfFlight()

◆ withinBunchRange()

Member Data Documentation

◆ ignoreTime

◆ storePrecise

◆ theAnalogSignalMap

◆ theGeometry

◆ theHitCorrection

◆ theHitFilter

◆ theMaxBunch

◆ theMinBunch

◆ theParameterMap

◆ thePECorrection

◆ thePhaseShift_

◆ theShape

◆ theShapes