CaloHitResponse Class Reference

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 PCaloHit &hit, CLHEP::HepRandomEngine *)
	process a single SimHit More...
virtual void	add (const CaloSamples &signal)
	add a signal, in units of pe 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 CaloVShape *shape)
	CaloHitResponse (const CaloVSimParameterMap *parameterMap, const CaloShapes *shapes)
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)
	if you want to reject hits, for example, from a certain subdetector, set this More...
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

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

Definition at line 36 of file CaloHitResponse.h.

Member Enumeration Documentation

anonymous enum

Enumerator
BUNCHSPACE

Definition at line 38 of file CaloHitResponse.h.

{BUNCHSPACE=25};

Constructor & Destructor Documentation

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::CaloHitResponse	(	const CaloVSimParameterMap *	parameterMap,
		const CaloShapes *	shapes
	)

Definition at line 37 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 ( )

virtual

doesn't delete the pointers passed in

Definition at line 53 of file CaloHitResponse.cc.

                                  {
}

Member Function Documentation

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

virtual

process a single SimHit

Reimplemented in HcalSiPMHitResponse.

Definition at line 71 of file CaloHitResponse.cc.

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

Referenced by HcalSiPMHitResponse::add(), HcalSiPMHitResponse::finalizeHits(), counter.Counter::register(), and run().

                                                                             {
  // 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);
  }
}

void CaloHitResponse::add ( const CaloSamples &  signal )

virtual

add a signal, in units of pe

Reimplemented in HcalSiPMHitResponse.

Definition at line 97 of file CaloHitResponse.cc.

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

Referenced by counter.Counter::register().

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

  } else  {
    (*oldSignal) += signal;
  }
}

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

adds the amplitude for a single hit to the frame

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 159 of file CaloHitResponse.cc.

References CaloVPECorrection::correctPE(), CaloSimParameters::doPhotostatistics(), CaloSimParameters::simHitToPhotoelectrons(), and thePECorrection.

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

                                                                                                                                                         {

  // 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;
}

void CaloHitResponse::clear ( void  )

inline

frees up memory

Definition at line 85 of file CaloHitResponse.h.

References metProducer_cfi::parameters.

Referenced by EcalMixingModuleValidation::computeSDBunchDigi().

{theAnalogSignalMap.clear();}

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

inlinevirtual

Finalize hits.

Reimplemented in HcalSiPMHitResponse.

Definition at line 58 of file CaloHitResponse.h.

References PVValHelper::add(), hfClusterShapes_cfi::hits, and findQualityFiles::run.

{}

CaloSamples * CaloHitResponse::findSignal

(

const DetId &

detId

)

users can look for the signal for a given cell

Definition at line 174 of file CaloHitResponse.cc.

References mps_fire::result, and theAnalogSignalMap.

Referenced by add(), and EcalMixingModuleValidation::computeSDBunchDigi().

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

virtual void CaloHitResponse::initializeHits ( )

inlinevirtual

Initialize hits.

Reimplemented in HcalSiPMHitResponse.

Definition at line 55 of file CaloHitResponse.h.

{}

virtual bool CaloHitResponse::keepBlank ( ) const

inlinevirtual

Definition at line 52 of file CaloHitResponse.h.

References funct::true.

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

{ return true ; }

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

virtual

creates the signal corresponding to this hit

Definition at line 110 of file CaloHitResponse.cc.

References analogSignalAmplitude(), stringResolutionProvider_cfi::bin, BUNCHSPACE, CaloVHitCorrection::delay(), PCaloHit::energy(), PCaloHit::id(), ignoreTime, makeBlankSignal(), metProducer_cfi::parameters, CaloSamples::preciseAtMod(), CaloSamples::resetPrecise(), mps_fire::result, CaloShapes::shape(), CaloVSimParameterMap::simParameters(), CaloSamples::size(), storePrecise, theHitCorrection, theParameterMap, thePhaseShift_, theShape, theShapes, PCaloHit::time(), ntuplemaker::time, timeOfFlight(), CaloVShape::timeToRise(), and tzero.

Referenced by add().

                                                                                                      {

  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;
} 

CaloSamples CaloHitResponse::makeBlankSignal

(

const DetId &

detId

)

const

creates an empty signal for this DetId

Definition at line 186 of file CaloHitResponse.cc.

References CaloSimParameters::binOfMaximum(), BUNCHSPACE, metProducer_cfi::parameters, CaloSimParameters::readoutFrameSize(), mps_fire::result, CaloVSimParameterMap::simParameters(), storePrecise, and theParameterMap.

Referenced by makeAnalogSignal().

                                                                      {
  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;
}

int CaloHitResponse::nSignals ( ) const

inline

number of signals in the current cache

Definition at line 101 of file CaloHitResponse.h.

References spr::timeOfFlight().

{return theAnalogSignalMap.size();}

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

virtual

Complete cell digitization.

Definition at line 61 of file CaloHitResponse.cc.

References add(), MixCollection< T >::begin(), MixCollection< T >::end(), and withinBunchRange().

Referenced by EcalMixingModuleValidation::computeSDBunchDigi().

                                                                                            {

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

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

tells it which pileup bunches to do

Definition at line 56 of file CaloHitResponse.cc.

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

Referenced by EcalMixingModuleValidation::computeSDBunchDigi().

                                                              {
  theMinBunch = minBunch;
  theMaxBunch = maxBunch;
}

void CaloHitResponse::setGeometry ( const CaloGeometry *  geometry )

inline

geometry needed for time-of-flight

Definition at line 50 of file CaloHitResponse.h.

References geometry.

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

{ theGeometry = geometry; }

void CaloHitResponse::setHitCorrection ( const CaloVHitCorrection *  hitCorrection )

inline

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

Definition at line 75 of file CaloHitResponse.h.

Referenced by CastorDigiProducer::CastorDigiProducer().

                                                                  {
    theHitCorrection = hitCorrection;
  }

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.

References ALCARECOTkAlBeamHalo_cff::filter.

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

                                                   {
    theHitFilter = filter;
  }

void CaloHitResponse::setIgnoreGeantTime ( bool  gt )

inline

Definition at line 124 of file CaloHitResponse.h.

Referenced by HcalDigitizer::HcalDigitizer().

                                   {
    ignoreTime = gt;
  }

void CaloHitResponse::setPECorrection ( const CaloVPECorrection *  peCorrection )

inline

if you want to correct the photoelectrons

Definition at line 80 of file CaloHitResponse.h.

Referenced by HcalDigitizer::HcalDigitizer().

                                                               {
    thePECorrection = peCorrection;
  }

void CaloHitResponse::setPhaseShift ( const double &  thePhaseShift )

inline

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

Definition at line 112 of file CaloHitResponse.h.

Referenced by HcalTBDigiProducer::setPhaseShift().

{ thePhaseShift_ = thePhaseShift; }

void CaloHitResponse::setStorePrecise ( bool  sp )

inline

Definition at line 120 of file CaloHitResponse.h.

                                {
    storePrecise = sp;
  }

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 196 of file CaloHitResponse.cc.

References SoftLeptonByDistance_cfi::distance, CaloSubdetectorGeometry::getGeometry(), CaloCellGeometry::getPosition(), CaloGeometry::getSubdetectorGeometry(), PV3DBase< T, PVType, FrameType >::mag(), DetId::rawId(), mps_fire::result, and theGeometry.

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

                                                              {
  // 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 {
    const CaloCellGeometry* 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;
}

bool CaloHitResponse::withinBunchRange ( int  bunchCrossing ) const

inline

check if crossing is within bunch range:

Definition at line 116 of file CaloHitResponse.h.

Referenced by run().

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

Member Data Documentation

bool CaloHitResponse::ignoreTime

protected

Definition at line 146 of file CaloHitResponse.h.

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

bool CaloHitResponse::storePrecise

protected

Definition at line 145 of file CaloHitResponse.h.

Referenced by makeAnalogSignal(), and makeBlankSignal().

AnalogSignalMap CaloHitResponse::theAnalogSignalMap

protected

Definition at line 130 of file CaloHitResponse.h.

Referenced by add(), and findSignal().

const CaloGeometry* CaloHitResponse::theGeometry

protected

Definition at line 139 of file CaloHitResponse.h.

Referenced by timeOfFlight().

const CaloVHitCorrection* CaloHitResponse::theHitCorrection

protected

Definition at line 135 of file CaloHitResponse.h.

Referenced by makeAnalogSignal().

const CaloVHitFilter* CaloHitResponse::theHitFilter

protected

Definition at line 137 of file CaloHitResponse.h.

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

int CaloHitResponse::theMaxBunch

protected

Definition at line 142 of file CaloHitResponse.h.

Referenced by setBunchRange().

int CaloHitResponse::theMinBunch

protected

Definition at line 141 of file CaloHitResponse.h.

Referenced by setBunchRange().

const CaloVSimParameterMap* CaloHitResponse::theParameterMap

protected

Definition at line 132 of file CaloHitResponse.h.

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

const CaloVPECorrection* CaloHitResponse::thePECorrection

protected

Definition at line 136 of file CaloHitResponse.h.

Referenced by analogSignalAmplitude().

double CaloHitResponse::thePhaseShift_

protected

Definition at line 144 of file CaloHitResponse.h.

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

const CaloVShape* CaloHitResponse::theShape

protected

Definition at line 134 of file CaloHitResponse.h.

Referenced by makeAnalogSignal().

const CaloShapes* CaloHitResponse::theShapes

protected

Definition at line 133 of file CaloHitResponse.h.

Referenced by makeAnalogSignal().