#include <EcalHitResponse.h>

Inheritance diagram for EcalHitResponse:

Public Types
enum	{ BUNCHSPACE = 25 }

typedef std::unordered_map< uint32_t, double >	CalibCache

typedef CaloTSamplesBase< float >	EcalSamples

typedef std::vector< unsigned int >	VecInd

Public Member Functions
void	add (const EcalSamples *pSam)

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

virtual void	add (const CaloSamples &hit)

	EcalHitResponse (const CaloVSimParameterMap parameterMap, const CaloVShape shape)

virtual void	finalizeHits ()

const EcalSamples *	findDetId (const DetId &detId) const

virtual void	initializeHits ()

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

virtual const EcalSamples *	operator[] (unsigned int i) const =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 ()

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 EcalSamples *	vSamAll (unsigned int i)=0

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

Private Attributes
const CaloSubdetectorGeometry *	m_geometry

const CaloVHitCorrection *	m_hitCorrection

const CaloVHitFilter *	m_hitFilter

VecInd	m_index

edm::TimeValue_t	m_iTime

CalibCache	m_laserCalibCache

const EcalLaserDbService *	m_lasercals

int	m_maxBunch

int	m_minBunch

const CaloVSimParameterMap *	m_parameterMap

const CaloVPECorrection *	m_PECorrection

double	m_phaseShift

const CaloVShape *	m_shape

bool	m_useLCcorrection

Detailed Description

Definition at line 29 of file EcalHitResponse.h.

Member Typedef Documentation

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

Definition at line 37 of file EcalHitResponse.h.

typedef CaloTSamplesBase<float> EcalHitResponse::EcalSamples

Definition at line 33 of file EcalHitResponse.h.

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

Definition at line 35 of file EcalHitResponse.h.

Member Enumeration Documentation

anonymous enum

Enumerator
BUNCHSPACE

Definition at line 39 of file EcalHitResponse.h.

39 { BUNCHSPACE = 25 } ;

EcalHitResponse::BUNCHSPACE

Definition: EcalHitResponse.h:39

Constructor & Destructor Documentation

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

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

virtual

Definition at line 39 of file EcalHitResponse.cc.

40 {

41 }

Member Function Documentation

void EcalHitResponse::add ( const EcalSamples * pSam )

Definition at line 291 of file EcalHitResponse.cc.

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

Referenced by counter.Counter::register().

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

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

virtual

Reimplemented in EBHitResponse.

Definition at line 137 of file EcalHitResponse.cc.

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

Referenced by counter.Counter::register().

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

void EcalHitResponse::add ( const CaloSamples & hit )

virtual

Definition at line 145 of file EcalHitResponse.cc.

References stringResolutionProvider_cfi::bin, Exception, findSignal(), CaloSamples::id(), mps_fire::result, and CaloSamples::size().

Referenced by counter.Counter::register().

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

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

protected

Definition at line 253 of file EcalHitResponse.cc.

References helperFunctions::cache(), CaloVPECorrection::correctPE(), CaloSimParameters::doPhotostatistics(), findLaserConstant(), m_laserCalibCache, m_PECorrection, m_useLCcorrection, params(), CaloSimParameters::simHitToPhotoelectrons(), and DetId::subdetId().

Referenced by putAnalogSignal().

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

void EcalHitResponse::blankOutUsedSamples ( )

protected

Definition at line 124 of file EcalHitResponse.cc.

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

Referenced by EBHitResponse::initializeHits(), initializeHits(), EBHitResponse::run(), and run().

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

void EcalHitResponse::finalizeHits ( )

virtual

Reimplemented in EBHitResponse.

Definition at line 179 of file EcalHitResponse.cc.

180 {

181 }

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

Definition at line 328 of file EcalHitResponse.cc.

References vSamAll().

Referenced by ESDigitizer::run().

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

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

protected

Definition at line 237 of file EcalHitResponse.cc.

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

Referenced by analogSignalAmplitude().

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

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

protected

Definition at line 244 of file EcalHitResponse.cc.

References m_index, mps_fire::result, vSamAll(), and CaloTSamplesBase< Ttype >::zero().

Referenced by add(), putAnalogSignal(), and EBHitResponse::putAPDSignal().

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

const CaloSubdetectorGeometry * EcalHitResponse::geometry ( ) const

protected

Definition at line 58 of file EcalHitResponse.cc.

References m_geometry.

Referenced by Vispa.Gui.ConnectableWidget.ConnectableWidget::leaveEvent(), setGeometry(), and timeOfFlight().

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

const CaloVHitFilter * EcalHitResponse::hitFilter ( ) const

protected

Definition at line 322 of file EcalHitResponse.cc.

References m_hitFilter.

Referenced by EBHitResponse::add(), and EBHitResponse::run().

 { 
    return m_hitFilter ; 
 }

EcalHitResponse::VecInd & EcalHitResponse::index ( )

protected

Definition at line 310 of file EcalHitResponse.cc.

References m_index.

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

 {
    return m_index ; 
 }

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

protected

Definition at line 316 of file EcalHitResponse.cc.

References m_index.

Referenced by BeautifulSoup.PageElement::insert().

 {
    return m_index ; 
 }

void EcalHitResponse::initializeHits ( )

virtual

Reimplemented in EBHitResponse.

Definition at line 173 of file EcalHitResponse.cc.

References blankOutUsedSamples().

 {
    blankOutUsedSamples() ;
 }

int EcalHitResponse::maxBunch ( ) const

protected

Definition at line 304 of file EcalHitResponse.cc.

References m_maxBunch.

Referenced by EBHitResponse::run(), and setBunchRange().

 {
    return m_maxBunch ; 
 }

int EcalHitResponse::minBunch ( ) const

protected

Definition at line 298 of file EcalHitResponse.cc.

References m_minBunch.

Referenced by EBHitResponse::run(), and setBunchRange().

 {
    return m_minBunch ; 
 }

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

pure virtual

Implemented in EBHitResponse, EEHitResponse, and ESHitResponse.

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

pure virtual

Implemented in EBHitResponse, EEHitResponse, and ESHitResponse.

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

protected

Definition at line 44 of file EcalHitResponse.cc.

References m_parameterMap, and CaloVSimParameterMap::simParameters().

Referenced by analogSignalAmplitude(), putAnalogSignal(), and EBHitResponse::putAPDSignal().

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

double EcalHitResponse::phaseShift ( ) const

protected

Definition at line 85 of file EcalHitResponse.cc.

References m_phaseShift.

Referenced by EBHitResponse::putAPDSignal(), and setPhaseShift().

 {
    return m_phaseShift ;
 }

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

protectedvirtual

Definition at line 202 of file EcalHitResponse.cc.

References analogSignalAmplitude(), stringResolutionProvider_cfi::bin, BUNCHSPACE, CaloVHitCorrection::delay(), PCaloHit::energy(), findSignal(), PCaloHit::id(), m_hitCorrection, m_phaseShift, params(), mps_fire::result, shape(), CaloTSamplesBase< Ttype >::size(), PCaloHit::time(), ntuplemaker::time, timeOfFlight(), CaloVShape::timeToRise(), and tzero.

Referenced by EBHitResponse::add(), add(), EBHitResponse::run(), and run().

 {
    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 
               - BUNCHSPACE*( 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 += BUNCHSPACE ;
    }
 }

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

virtual

Reimplemented in EBHitResponse.

Definition at line 184 of file EcalHitResponse.cc.

References CaloVHitFilter::accepts(), MixCollection< T >::begin(), blankOutUsedSamples(), MixCollection< T >::end(), edm::isNotFinite(), m_hitFilter, putAnalogSignal(), PCaloHit::time(), and withinBunchRange().

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

virtual unsigned int EcalHitResponse::samplesSize ( ) const

pure virtual

Implemented in EBHitResponse, EEHitResponse, and ESHitResponse.

virtual unsigned int EcalHitResponse::samplesSizeAll ( ) const

protectedpure virtual

Implemented in EBHitResponse, EEHitResponse, and ESHitResponse.

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

Definition at line 65 of file EcalHitResponse.cc.

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

 {
    m_minBunch = minBunch ;
    m_maxBunch = maxBunch ;
 }

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

Definition at line 109 of file EcalHitResponse.cc.

References m_iTime, and m_laserCalibCache.

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

void EcalHitResponse::setGeometry ( const CaloSubdetectorGeometry * geometry )

Definition at line 73 of file EcalHitResponse.cc.

References geometry(), and m_geometry.

 {
   m_geometry = geometry ;
 }

void EcalHitResponse::setHitCorrection ( const CaloVHitCorrection * hitCorrection )

Definition at line 97 of file EcalHitResponse.cc.

References m_hitCorrection.

 {
    m_hitCorrection = hitCorrection ;
 }

void EcalHitResponse::setHitFilter ( const CaloVHitFilter * filter )

Definition at line 91 of file EcalHitResponse.cc.

References ALCARECOTkAlBeamHalo_cff::filter, and m_hitFilter.

 {
    m_hitFilter = filter ;
 }

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

Definition at line 117 of file EcalHitResponse.cc.

References m_lasercals, and m_useLCcorrection.

 {
   m_lasercals = laser;
   m_useLCcorrection = useLCcorrection;
 }

void EcalHitResponse::setPECorrection ( const CaloVPECorrection * peCorrection )

Definition at line 103 of file EcalHitResponse.cc.

References m_PECorrection.

 {
    m_PECorrection = peCorrection ;
 }

void EcalHitResponse::setPhaseShift ( double phaseShift )

Definition at line 79 of file EcalHitResponse.cc.

References m_phaseShift, and phaseShift().

 {
    m_phaseShift = phaseShift ;
 }

const CaloVShape * EcalHitResponse::shape ( void ) const

protected

Definition at line 51 of file EcalHitResponse.cc.

References m_shape.

Referenced by putAnalogSignal().

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

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

protected

Definition at line 283 of file EcalHitResponse.cc.

References geometry(), and ecaldqm::getGeometry().

Referenced by putAnalogSignal(), and EBHitResponse::putAPDSignal().

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

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

protectedpure virtual

Implemented in EBHitResponse, EEHitResponse, and ESHitResponse.

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

protectedpure virtual

Implemented in EBHitResponse, EEHitResponse, and ESHitResponse.

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

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

protectedpure virtual

Implemented in EBHitResponse, EEHitResponse, and ESHitResponse.

bool EcalHitResponse::withinBunchRange ( int bunchCrossing ) const

Definition at line 167 of file EcalHitResponse.cc.

Referenced by run().

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

Member Data Documentation

const CaloSubdetectorGeometry* EcalHitResponse::m_geometry

private

Definition at line 132 of file EcalHitResponse.h.

Referenced by geometry(), and setGeometry().

const CaloVHitCorrection* EcalHitResponse::m_hitCorrection

private

Definition at line 129 of file EcalHitResponse.h.

Referenced by putAnalogSignal(), and setHitCorrection().

const CaloVHitFilter* EcalHitResponse::m_hitFilter

private

Definition at line 131 of file EcalHitResponse.h.

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

VecInd EcalHitResponse::m_index

private

Definition at line 143 of file EcalHitResponse.h.

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

edm::TimeValue_t EcalHitResponse::m_iTime

private

Definition at line 139 of file EcalHitResponse.h.

Referenced by findLaserConstant(), and setEventTime().

CalibCache EcalHitResponse::m_laserCalibCache

private

Definition at line 141 of file EcalHitResponse.h.

Referenced by analogSignalAmplitude(), and setEventTime().

const EcalLaserDbService* EcalHitResponse::m_lasercals

private

Definition at line 133 of file EcalHitResponse.h.

Referenced by findLaserConstant(), and setLaserConstants().

int EcalHitResponse::m_maxBunch

private

Definition at line 136 of file EcalHitResponse.h.

Referenced by maxBunch(), and setBunchRange().

int EcalHitResponse::m_minBunch

private

Definition at line 135 of file EcalHitResponse.h.

Referenced by minBunch(), and setBunchRange().

const CaloVSimParameterMap* EcalHitResponse::m_parameterMap

private

Definition at line 127 of file EcalHitResponse.h.

Referenced by params().

const CaloVPECorrection* EcalHitResponse::m_PECorrection

private

Definition at line 130 of file EcalHitResponse.h.

Referenced by analogSignalAmplitude(), and setPECorrection().

double EcalHitResponse::m_phaseShift

private

Definition at line 137 of file EcalHitResponse.h.

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

const CaloVShape* EcalHitResponse::m_shape

private

Definition at line 128 of file EcalHitResponse.h.

Referenced by shape().

bool EcalHitResponse::m_useLCcorrection

private

Definition at line 140 of file EcalHitResponse.h.

Referenced by analogSignalAmplitude(), and setLaserConstants().

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation