#include <EcalHitResponse.h>

Inheritance diagram for EcalHitResponse:

Public Types
enum	{ BUNCHSPACE = 25 }

typedef CaloTSamplesBase< float >	EcalSamples

typedef std::vector< unsigned int >	VecInd

Public Member Functions
void	add (const EcalSamples *pSam)

	EcalHitResponse (const CaloVSimParameterMap parameterMap, const CaloVShape shape)

const EcalSamples *	findDetId (const DetId &detId) const

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

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

virtual void	run (MixCollection< PCaloHit > &hits)

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)

virtual	~EcalHitResponse ()

Protected Member Functions
double	analogSignalAmplitude (const PCaloHit &hit) const

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::RandGaussQ *	ranGauss () const

CLHEP::RandPoissonQ *	ranPois () const

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

const EcalLaserDbService *	m_lasercals

int	m_maxBunch

int	m_minBunch

const CaloVSimParameterMap *	m_parameterMap

const CaloVPECorrection *	m_PECorrection

double	m_phaseShift

CLHEP::RandGaussQ *	m_RandGauss

CLHEP::RandPoissonQ *	m_RandPoisson

const CaloVShape *	m_shape

bool	m_useLCcorrection

Detailed Description

Definition at line 29 of file EcalHitResponse.h.

Member Typedef Documentation

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 37 of file EcalHitResponse.h.

37 { BUNCHSPACE = 25 } ;

EcalHitResponse::BUNCHSPACE

Definition: EcalHitResponse.h:37

Constructor & Destructor Documentation

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

Definition at line 25 of file EcalHitResponse.cc.

References edm::hlt::Exception, edm::RandomNumberGenerator::getEngine(), edm::Service< T >::isAvailable(), m_RandGauss, and m_RandPoisson.

                                                               :
    m_parameterMap    ( parameterMap ) ,
    m_shape           ( shape        ) ,
    m_hitCorrection   ( 0            ) ,
    m_PECorrection    ( 0            ) ,
    m_hitFilter       ( 0            ) ,
    m_geometry        ( 0            ) ,
    m_lasercals       ( 0            ) ,
    m_RandPoisson     ( 0            ) ,
    m_RandGauss       ( 0            ) ,
    m_minBunch        ( -10          ) ,
    m_maxBunch        (  10          ) ,
    m_phaseShift      ( 1            ) ,
    m_iTime           ( 0            ) ,
    m_useLCcorrection ( 0            )
 {
    edm::Service<edm::RandomNumberGenerator> rng ;
    if ( !rng.isAvailable() ) 
    {
       throw cms::Exception("Configuration")
      << "EcalHitResponse requires the RandomNumberGeneratorService\n"
      "which is not present in the configuration file.  You must add the service\n"
      "in the configuration file or remove the modules that require it.";
    }
    m_RandPoisson = new CLHEP::RandPoissonQ( rng->getEngine() ) ;
    m_RandGauss   = new CLHEP::RandGaussQ(   rng->getEngine() ) ;
 }

EcalHitResponse::~EcalHitResponse ( )

virtual

Definition at line 54 of file EcalHitResponse.cc.

References m_RandGauss, and m_RandPoisson.

 {
    delete m_RandPoisson ;
    delete m_RandGauss   ;
 }

Member Function Documentation

void EcalHitResponse::add ( const EcalSamples * pSam )

Definition at line 265 of file EcalHitResponse.cc.

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

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

double EcalHitResponse::analogSignalAmplitude ( const PCaloHit & hit ) const

protected

Definition at line 232 of file EcalHitResponse.cc.

References CaloVPECorrection::correctPE(), PCaloHit::energy(), findLaserConstant(), PCaloHit::id(), m_PECorrection, m_useLCcorrection, Parameters::parameters, params(), and ranPois().

Referenced by putAnalogSignal().

 {
    const DetId& detId ( hit.id() ) ;
 
    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
 
    float lasercalib = 1.;
    if(m_useLCcorrection == true && detId.subdetId() != 3) {
      lasercalib = findLaserConstant(detId);
    }
 
    double npe ( hit.energy()/lasercalib*parameters.simHitToPhotoelectrons( detId ) ) ;
 
    // do we need to doPoisson statistics for the photoelectrons?
    if( parameters.doPhotostatistics() ) npe = ranPois()->fire( npe ) ;
 
    if( 0 != m_PECorrection ) npe = m_PECorrection->correctPE( detId, npe ) ;
 
    return npe ;
 }

void EcalHitResponse::blankOutUsedSamples ( )

protected

Definition at line 151 of file EcalHitResponse.cc.

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

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

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

Definition at line 302 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 215 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 223 of file EcalHitResponse.cc.

References m_index, query::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 87 of file EcalHitResponse.cc.

References m_geometry.

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

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

const CaloVHitFilter * EcalHitResponse::hitFilter ( ) const

protected

Definition at line 296 of file EcalHitResponse.cc.

References m_hitFilter.

Referenced by EBHitResponse::run().

 { 
    return m_hitFilter ; 
 }

EcalHitResponse::VecInd & EcalHitResponse::index ( )

protected

Definition at line 284 of file EcalHitResponse.cc.

References m_index.

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

 {
    return m_index ; 
 }

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

protected

Definition at line 290 of file EcalHitResponse.cc.

References m_index.

Referenced by BeautifulSoup.PageElement::_invert().

 {
    return m_index ; 
 }

int EcalHitResponse::maxBunch ( ) const

protected

Definition at line 278 of file EcalHitResponse.cc.

References m_maxBunch.

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

 {
    return m_maxBunch ; 
 }

int EcalHitResponse::minBunch ( ) const

protected

Definition at line 272 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 73 of file EcalHitResponse.cc.

References m_parameterMap, and CaloVSimParameterMap::simParameters().

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

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

double EcalHitResponse::phaseShift ( ) const

protected

Definition at line 114 of file EcalHitResponse.cc.

References m_phaseShift.

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

 {
    return m_phaseShift ;
 }

void EcalHitResponse::putAnalogSignal ( const PCaloHit & inputHit )

protectedvirtual

Definition at line 182 of file EcalHitResponse.cc.

References analogSignalAmplitude(), newFWLiteAna::bin, BUNCHSPACE, CaloVHitCorrection::correct(), findSignal(), PCaloHit::id(), m_hitCorrection, m_phaseShift, Parameters::parameters, params(), query::result, shape(), CaloTSamplesBase< Ttype >::size(), PCaloHit::time(), timeOfFlight(), CaloVShape::timeToRise(), and tzero.

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

 {
    PCaloHit hit ( inputHit ) ;
 
    if( 0 != m_hitCorrection ) m_hitCorrection->correct( hit ) ;
 
    const DetId detId ( hit.id() ) ;
 
    const CaloSimParameters* parameters ( params( detId ) ) ;
 
    const double signal ( analogSignalAmplitude( hit ) ) ;
 
    const double jitter ( hit.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 ;
    }
 }

CLHEP::RandGaussQ * EcalHitResponse::ranGauss ( ) const

protected

Definition at line 67 of file EcalHitResponse.cc.

References m_RandGauss.

Referenced by EBHitResponse::EBHitResponse().

 {
    return m_RandGauss ;
 }

CLHEP::RandPoissonQ * EcalHitResponse::ranPois ( ) const

protected

Definition at line 61 of file EcalHitResponse.cc.

References m_RandPoisson.

Referenced by analogSignalAmplitude(), and EBHitResponse::apdSignalAmplitude().

 {
    return m_RandPoisson ;
 }

void EcalHitResponse::run ( MixCollection< PCaloHit > & hits )

virtual

Reimplemented in EBHitResponse.

Definition at line 164 of file EcalHitResponse.cc.

References CaloVHitFilter::accepts(), MixCollection< T >::begin(), blankOutUsedSamples(), MixCollection< T >::end(), edm::detail::isnan(), m_hitFilter, m_maxBunch, m_minBunch, putAnalogSignal(), and PCaloHit::time().

 {
    blankOutUsedSamples() ;
 
    for( MixCollection<PCaloHit>::MixItr hitItr ( hits.begin() ) ;
     hitItr != hits.end() ; ++hitItr )
    {
       const PCaloHit& hit ( *hitItr ) ;
       const int bunch ( hitItr.bunch() ) ;
       if( m_minBunch <= bunch  &&
       m_maxBunch >= bunch  &&
       !isnan( hit.time() ) &&
       ( 0 == m_hitFilter ||
         m_hitFilter->accepts( hit ) ) ) putAnalogSignal( hit ) ;
    }
 }

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 94 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 138 of file EcalHitResponse.cc.

References m_iTime.

Referenced by EcalDigiProducer::checkCalibrations().

 {
   m_iTime = iTime;
 }

void EcalHitResponse::setGeometry ( const CaloSubdetectorGeometry * geometry )

Definition at line 102 of file EcalHitResponse.cc.

References geometry(), and m_geometry.

Referenced by EcalDigiProducer::updateGeometry().

 {
    m_geometry = geometry ;
 }

void EcalHitResponse::setHitCorrection ( const CaloVHitCorrection * hitCorrection )

Definition at line 126 of file EcalHitResponse.cc.

References m_hitCorrection.

 {
    m_hitCorrection = hitCorrection ;
 }

void EcalHitResponse::setHitFilter ( const CaloVHitFilter * filter )

Definition at line 120 of file EcalHitResponse.cc.

References alcazmumu_cfi::filter, and m_hitFilter.

 {
    m_hitFilter = filter ;
 }

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

Definition at line 144 of file EcalHitResponse.cc.

References m_lasercals, and m_useLCcorrection.

Referenced by EcalDigiProducer::checkCalibrations().

 {
   m_lasercals = laser;
   m_useLCcorrection = useLCcorrection;
 }

void EcalHitResponse::setPECorrection ( const CaloVPECorrection * peCorrection )

Definition at line 132 of file EcalHitResponse.cc.

References m_PECorrection.

 {
    m_PECorrection = peCorrection ;
 }

void EcalHitResponse::setPhaseShift ( double phaseShift )

Definition at line 108 of file EcalHitResponse.cc.

References m_phaseShift, and phaseShift().

Referenced by EcalDigiProducer::EcalDigiProducer(), and EcalTBDigiProducer::setPhaseShift().

 {
    m_phaseShift = phaseShift ;
 }

const CaloVShape * EcalHitResponse::shape ( void ) const

protected

Definition at line 80 of file EcalHitResponse.cc.

References m_shape.

Referenced by putAnalogSignal().

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

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

protected

Definition at line 257 of file EcalHitResponse.cc.

References geometry(), CaloCellGeometry::getPosition(), and PV3DBase< T, PVType, FrameType >::mag().

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

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