EBHitResponse Class Reference

#include <EBHitResponse.h>

Inheritance diagram for EBHitResponse:

Public Types
enum	{ kNOffsets = 2000 }
typedef CaloTSamples< float, 10 >	EBSamples
typedef std::vector< double >	VecD
Public Types inherited from EcalHitResponse
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 PCaloHit &hit, CLHEP::HepRandomEngine *) override
	EBHitResponse (const CaloVSimParameterMap *parameterMap, const CaloVShape *shape, bool apdOnly, const APDSimParameters *apdPars, const CaloVShape *apdShape)
void	finalizeHits () override
void	initialize (CLHEP::HepRandomEngine *)
void	initializeHits () override
virtual bool	keepBlank () const
EcalSamples *	operator[] (unsigned int i) override
const EcalSamples *	operator[] (unsigned int i) const override
void	run (MixCollection< PCaloHit > &hits, CLHEP::HepRandomEngine *) override
unsigned int	samplesSize () const override
void	setIntercal (const EcalIntercalibConstantsMC *ical)
	~EBHitResponse () override
Public Member Functions inherited from EcalHitResponse
void	add (const EcalSamples *pSam)
virtual void	add (const CaloSamples &hit)
	EcalHitResponse (const CaloVSimParameterMap *parameterMap, const CaloVShape *shape)
const EcalSamples *	findDetId (const DetId &detId) const
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
void	putAPDSignal (const DetId &detId, double npe, double time)
unsigned int	samplesSizeAll () const override
EcalSamples *	vSam (unsigned int i) override
EcalSamples *	vSamAll (unsigned int i) override
const EcalSamples *	vSamAll (unsigned int i) const override
Protected Member Functions inherited from EcalHitResponse
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 *)
const CaloVShape *	shape () const
double	timeOfFlight (const DetId &detId) const

Private Member Functions
const APDSimParameters *	apdParameters () const
const CaloVShape *	apdShape () const
double	apdSignalAmplitude (const PCaloHit &hit, CLHEP::HepRandomEngine *) const
void	findIntercalibConstant (const DetId &detId, double &icalconst) const
const double	nonlFunc (double enr) const
const double	nonlFunc1 (double energy) const
const VecD &	offsets () const

Private Attributes
std::vector< double >	m_apdNpeVec
const bool	m_apdOnly
const APDSimParameters *	m_apdPars
const CaloVShape *	m_apdShape
std::vector< double >	m_apdTimeVec
const EcalIntercalibConstantsMC *	m_intercal
bool	m_isInitialized
std::vector< double >	m_timeOffVec
std::vector< EBSamples >	m_vSam
const double	pasy
const double	pcon
const double	pcub
const double	pehi
const double	pelo
const double	pext
const double	pfac
const double	plin
const double	poff
const double	pqua

Detailed Description

Definition at line 14 of file EBHitResponse.h.

Member Typedef Documentation

typedef CaloTSamples<float, 10> EBHitResponse::EBSamples

Definition at line 16 of file EBHitResponse.h.

typedef std::vector<double> EBHitResponse::VecD

Definition at line 18 of file EBHitResponse.h.

Member Enumeration Documentation

anonymous enum

Enumerator
kNOffsets

Definition at line 20 of file EBHitResponse.h.

{ kNOffsets = 2000 };

Constructor & Destructor Documentation

EBHitResponse::EBHitResponse	(	const CaloVSimParameterMap *	parameterMap,
		const CaloVShape *	shape,
		bool	apdOnly,
		const APDSimParameters *	apdPars = 0,
		const CaloVShape *	apdShape = 0
	)

Definition at line 15 of file EBHitResponse.cc.

References DetId::det(), EBDetId::detIdFromDenseIndex(), mps_fire::i, EBDetId::kSizeForDenseIndexing, m_vSam, CaloVSimParameterMap::simParameters(), findQualityFiles::size, and DetId::subdetId().

    :

      EcalHitResponse(parameterMap, shape),

      m_apdOnly(apdOnly),
      m_apdPars(apdPars),
      m_apdShape(apdShape),
      m_timeOffVec(kNOffsets, apdParameters()->timeOffset()),
      pcub(nullptr == apdPars ? 0 : apdParameters()->nonlParms()[0]),
      pqua(nullptr == apdPars ? 0 : apdParameters()->nonlParms()[1]),
      plin(nullptr == apdPars ? 0 : apdParameters()->nonlParms()[2]),
      pcon(nullptr == apdPars ? 0 : apdParameters()->nonlParms()[3]),
      pelo(nullptr == apdPars ? 0 : apdParameters()->nonlParms()[4]),
      pehi(nullptr == apdPars ? 0 : apdParameters()->nonlParms()[5]),
      pasy(nullptr == apdPars ? 0 : apdParameters()->nonlParms()[6]),
      pext(nullptr == apdPars ? 0 : nonlFunc1(pelo)),
      poff(nullptr == apdPars ? 0 : nonlFunc1(pehi)),
      pfac(nullptr == apdPars ? 0 : (pasy - poff) * 2. / M_PI),
      m_isInitialized(false) {
  const EBDetId detId(EBDetId::detIdFromDenseIndex(0));
  const CaloSimParameters& parameters(parameterMap->simParameters(detId));

  const unsigned int rSize(parameters.readoutFrameSize());
  const unsigned int nPre(parameters.binOfMaximum() - 1);

  const unsigned int size(EBDetId::kSizeForDenseIndexing);

  m_vSam.reserve(size);

  for (unsigned int i(0); i != size; ++i) {
    m_vSam.emplace_back(CaloGenericDetId(detId.det(), detId.subdetId(), i), rSize, nPre);
  }
}

EBHitResponse::~EBHitResponse ( )

override

Definition at line 54 of file EBHitResponse.cc.

{}

Member Function Documentation

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

overridevirtual

Reimplemented from EcalHitResponse.

Definition at line 178 of file EBHitResponse.cc.

References CaloVHitFilter::accepts(), apdParameters(), apdSignalAmplitude(), PCaloHit::depth(), EcalHitResponse::hitFilter(), PCaloHit::id(), edm::isNotFinite(), PCaloHit::kEcalDepthIdMask, m_apdNpeVec, m_apdOnly, m_apdTimeVec, EcalHitResponse::putAnalogSignal(), and PCaloHit::time().

Referenced by counter.Counter::register().

                                                                         {
  if (!edm::isNotFinite(hit.time()) && (nullptr == hitFilter() || hitFilter()->accepts(hit))) {
    int iddepth = (hit.depth() & PCaloHit::kEcalDepthIdMask);
    if (0 == iddepth)  // for now take only nonAPD hits
    {
      if (!m_apdOnly)
        putAnalogSignal(hit, engine);
    } else  // APD hits here
    {
      if (apdParameters()->addToBarrel() || m_apdOnly) {
        const unsigned int icell(EBDetId(hit.id()).denseIndex());
        m_apdNpeVec[icell] += apdSignalAmplitude(hit, engine);
        if (0 == m_apdTimeVec[icell])
          m_apdTimeVec[icell] = hit.time();
      }
    }
  }
}

const APDSimParameters * EBHitResponse::apdParameters ( ) const

private

Definition at line 63 of file EBHitResponse.cc.

References m_apdPars.

Referenced by add(), apdSignalAmplitude(), finalizeHits(), initialize(), and run().

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

const CaloVShape * EBHitResponse::apdShape ( ) const

private

Definition at line 68 of file EBHitResponse.cc.

References m_apdShape.

Referenced by putAPDSignal().

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

double EBHitResponse::apdSignalAmplitude ( const PCaloHit &  hit, CLHEP::HepRandomEngine *  engine  ) const

private

Definition at line 103 of file EBHitResponse.cc.

References apdParameters(), PCaloHit::depth(), PCaloHit::energy(), findIntercalibConstant(), PCaloHit::id(), PCaloHit::kEcalDepthIdMask, m_apdOnly, m_intercal, APDSimParameters::simToPEHigh(), and APDSimParameters::simToPELow().

Referenced by add(), and run().

                                                                                                {
  int iddepth = (hit.depth() & PCaloHit::kEcalDepthIdMask);
  assert(1 == iddepth || 2 == iddepth);

  double npe(hit.energy() * (2 == iddepth ? apdParameters()->simToPELow() : apdParameters()->simToPEHigh()));

  // do we need to do Poisson statistics for the photoelectrons?
  if (apdParameters()->doPEStats() && !m_apdOnly) {
    CLHEP::RandPoissonQ randPoissonQ(*engine, npe);
    npe = randPoissonQ.fire();
  }
  assert(nullptr != m_intercal);
  double fac(1);
  findIntercalibConstant(hit.id(), fac);

  npe *= fac;

  //   edm::LogError( "EBHitResponse" ) << "--- # photoelectrons for "
  /*   std::cout << "--- # photoelectrons for "
         << EBDetId( hit.id() ) 
         <<" is " << npe //;
         <<std::endl ;*/

  return npe;
}

void EBHitResponse::finalizeHits ( )

overridevirtual

Reimplemented from EcalHitResponse.

Definition at line 163 of file EBHitResponse.cc.

References apdParameters(), EBDetId::detIdFromDenseIndex(), mps_fire::i, EBDetId::kSizeForDenseIndexing, m_apdNpeVec, m_apdOnly, m_apdTimeVec, and putAPDSignal().

                                 {
  const unsigned int bSize(EBDetId::kSizeForDenseIndexing);
  if (apdParameters()->addToBarrel() || m_apdOnly) {
    for (unsigned int i(0); i != bSize; ++i) {
      if (0 < m_apdNpeVec[i]) {
        putAPDSignal(EBDetId::detIdFromDenseIndex(i), m_apdNpeVec[i], m_apdTimeVec[i]);

        // now zero out for next time
        m_apdNpeVec[i] = 0.;
        m_apdTimeVec[i] = 0.;
      }
    }
  }
}

void EBHitResponse::findIntercalibConstant ( const DetId &  detId, double &  icalconst  ) const

private

Definition at line 131 of file EBHitResponse.cc.

References EcalCondObjectContainer< T >::getMap(), m_intercal, and DetId::rawId().

Referenced by apdSignalAmplitude().

                                                                                      {
  EcalIntercalibConstantMC thisconst(1.);

  if (nullptr == m_intercal) {
    edm::LogError("EBHitResponse") << "No intercal constant defined for EBHitResponse";
  } else {
    const EcalIntercalibConstantMCMap& icalMap(m_intercal->getMap());
    EcalIntercalibConstantMCMap::const_iterator icalit(icalMap.find(detId));
    if (icalit != icalMap.end()) {
      thisconst = *icalit;
      if (thisconst == 0.)
        thisconst = 1.;
    } else {
      edm::LogError("EBHitResponse") << "No intercalib const found for xtal " << detId.rawId()
                                     << "! something wrong with EcalIntercalibConstants in your DB? ";
    }
  }
  icalconst = thisconst;
}

void EBHitResponse::initialize

(

CLHEP::HepRandomEngine *

engine

)

Definition at line 56 of file EBHitResponse.cc.

References apdParameters(), mps_fire::i, kNOffsets, m_isInitialized, and m_timeOffVec.

                                                           {
  m_isInitialized = true;
  for (unsigned int i(0); i != kNOffsets; ++i) {
    m_timeOffVec[i] += CLHEP::RandGaussQ::shoot(engine, 0, apdParameters()->timeOffWidth());
  }
}

void EBHitResponse::initializeHits ( )

overridevirtual

Reimplemented from EcalHitResponse.

Definition at line 151 of file EBHitResponse.cc.

References EcalHitResponse::blankOutUsedSamples(), relativeConstraints::empty, EcalHitResponse::index(), EBDetId::kSizeForDenseIndexing, m_apdNpeVec, and m_apdTimeVec.

                                   {
  if (!index().empty())
    blankOutUsedSamples();

  const unsigned int bSize(EBDetId::kSizeForDenseIndexing);

  if (m_apdNpeVec.empty()) {
    m_apdNpeVec = std::vector<double>(bSize, (double)0.0);
    m_apdTimeVec = std::vector<double>(bSize, (double)0.0);
  }
}

virtual bool EBHitResponse::keepBlank ( ) const

inlinevirtual

Definition at line 32 of file EBHitResponse.h.

References PVValHelper::add(), hfClusterShapes_cfi::hits, mps_fire::i, operator[](), writedatasetfile::run, and ntuplemaker::time.

{ return false; }

const double EBHitResponse::nonlFunc ( double  enr ) const

inlineprivate

Definition at line 64 of file EBHitResponse.h.

Referenced by putAPDSignal().

                                          {
    return (pelo > enr ? pext : (pehi > enr ? nonlFunc1(enr) : pfac * atan(log10(enr - pehi + 0.00001)) + poff));
  }

const double EBHitResponse::nonlFunc1 ( double  energy ) const

inlineprivate

Definition at line 68 of file EBHitResponse.h.

                                              {
    const double enr(log10(energy));
    const double enr2(enr * enr);
    const double enr3(enr2 * enr);
    return (pcub * enr3 + pqua * enr2 + plin * enr + pcon);
  }

const VecD& EBHitResponse::offsets ( ) const

inlineprivate

Definition at line 62 of file EBHitResponse.h.

Referenced by putAPDSignal().

{ return m_timeOffVec; }

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

overridevirtual

Implements EcalHitResponse.

Definition at line 249 of file EBHitResponse.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

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

overridevirtual

Implements EcalHitResponse.

Definition at line 247 of file EBHitResponse.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

void EBHitResponse::putAPDSignal ( const DetId &  detId, double  npe, double  time  )

protected

Definition at line 73 of file EBHitResponse.cc.

References apdShape(), stringResolutionProvider_cfi::bin, CaloSimParameters::binOfMaximum(), EcalHitResponse::BUNCHSPACE, Exception, EcalHitResponse::findSignal(), kNOffsets, m_isInitialized, nonlFunc(), offsets(), EcalHitResponse::params(), EcalHitResponse::phaseShift(), mps_fire::result, CaloSimParameters::simHitToPhotoelectrons(), CaloTSamplesBase< Ttype >::size(), EcalHitResponse::timeOfFlight(), and tzero.

Referenced by finalizeHits(), and run().

                                                                            {
  const CaloSimParameters& parameters(*params(detId));

  const double energyFac(1. / parameters.simHitToPhotoelectrons(detId));

  //   std::cout<<"******** Input APD Npe="<<npe<<", Efactor="<<energyFac
  //        <<", Energy="<<npe*energyFac
  //        <<", nonlFunc="<<nonlFunc( npe*energyFac )<<std::endl ;

  const double signal(npe * nonlFunc(npe * energyFac));

  const double jitter(time - timeOfFlight(detId));

  if (!m_isInitialized) {
    throw cms::Exception("LogicError") << "EBHitResponse::putAPDSignal called without initializing\n";
  }

  const double tzero(apdShape()->timeToRise() - jitter - offsets()[EBDetId(detId).denseIndex() % kNOffsets] -
                     BUNCHSPACE * (parameters.binOfMaximum() - phaseShift()));

  double binTime(tzero);

  EcalSamples& result(*findSignal(detId));

  for (unsigned int bin(0); bin != result.size(); ++bin) {
    result[bin] += (*apdShape())(binTime)*signal;
    binTime += BUNCHSPACE;
  }
}

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

overridevirtual

Reimplemented from EcalHitResponse.

Definition at line 197 of file EBHitResponse.cc.

References CaloVHitFilter::accepts(), apdParameters(), apdSignalAmplitude(), MixCollection< T >::begin(), EcalHitResponse::blankOutUsedSamples(), PCaloHit::depth(), EBDetId::detIdFromDenseIndex(), relativeConstraints::empty, MixCollection< T >::end(), EcalHitResponse::hitFilter(), mps_fire::i, PCaloHit::id(), EcalHitResponse::index(), edm::isNotFinite(), PCaloHit::kEcalDepthIdMask, EBDetId::kSizeForDenseIndexing, m_apdNpeVec, m_apdOnly, m_apdTimeVec, EcalHitResponse::maxBunch(), EcalHitResponse::minBunch(), EcalHitResponse::putAnalogSignal(), putAPDSignal(), and PCaloHit::time().

                                                                                   {
  if (!index().empty())
    blankOutUsedSamples();

  const unsigned int bSize(EBDetId::kSizeForDenseIndexing);

  if (m_apdNpeVec.empty()) {
    m_apdNpeVec = std::vector<double>(bSize, (double)0.0);
    m_apdTimeVec = std::vector<double>(bSize, (double)0.0);
  }

  for (MixCollection<PCaloHit>::MixItr hitItr(hits.begin()); hitItr != hits.end(); ++hitItr) {
    const PCaloHit& hit(*hitItr);
    const int bunch(hitItr.bunch());
    if (minBunch() <= bunch && maxBunch() >= bunch && !edm::isNotFinite(hit.time()) &&
        (nullptr == hitFilter() || hitFilter()->accepts(hit))) {
      int iddepth = (hit.depth() & PCaloHit::kEcalDepthIdMask);
      if (0 == iddepth)  // for now take only nonAPD hits
      {
        if (!m_apdOnly)
          putAnalogSignal(hit, engine);
      } else  // APD hits here
      {
        if (apdParameters()->addToBarrel() || m_apdOnly) {
          const unsigned int icell(EBDetId(hit.id()).denseIndex());
          m_apdNpeVec[icell] += apdSignalAmplitude(hit, engine);
          if (0 == m_apdTimeVec[icell])
            m_apdTimeVec[icell] = hit.time();
        }
      }
    }
  }

  if (apdParameters()->addToBarrel() || m_apdOnly) {
    for (unsigned int i(0); i != bSize; ++i) {
      if (0 < m_apdNpeVec[i]) {
        putAPDSignal(EBDetId::detIdFromDenseIndex(i), m_apdNpeVec[i], m_apdTimeVec[i]);

        // now zero out for next time
        m_apdNpeVec[i] = 0.;
        m_apdTimeVec[i] = 0.;
      }
    }
  }
}

unsigned int EBHitResponse::samplesSize ( ) const

overridevirtual

Implements EcalHitResponse.

Definition at line 243 of file EBHitResponse.cc.

References m_vSam.

{ return m_vSam.size(); }

unsigned int EBHitResponse::samplesSizeAll ( ) const

overrideprotectedvirtual

Implements EcalHitResponse.

Definition at line 245 of file EBHitResponse.cc.

References m_vSam.

{ return m_vSam.size(); }

void EBHitResponse::setIntercal

(

const EcalIntercalibConstantsMC *

ical

)

Definition at line 129 of file EBHitResponse.cc.

References m_intercal.

{ m_intercal = ical; }

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

overrideprotectedvirtual

Implements EcalHitResponse.

Definition at line 251 of file EBHitResponse.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

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

overrideprotectedvirtual

Implements EcalHitResponse.

Definition at line 253 of file EBHitResponse.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

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

overrideprotectedvirtual

Implements EcalHitResponse.

Definition at line 255 of file EBHitResponse.cc.

References mps_fire::i, and m_vSam.

{ return &m_vSam[i]; }

Member Data Documentation

std::vector<double> EBHitResponse::m_apdNpeVec

private

Definition at line 89 of file EBHitResponse.h.

Referenced by add(), finalizeHits(), initializeHits(), and run().

const bool EBHitResponse::m_apdOnly

private

Definition at line 82 of file EBHitResponse.h.

Referenced by add(), apdSignalAmplitude(), finalizeHits(), and run().

const APDSimParameters* EBHitResponse::m_apdPars

private

Definition at line 83 of file EBHitResponse.h.

Referenced by apdParameters().

const CaloVShape* EBHitResponse::m_apdShape

private

Definition at line 84 of file EBHitResponse.h.

Referenced by apdShape().

std::vector<double> EBHitResponse::m_apdTimeVec

private

Definition at line 90 of file EBHitResponse.h.

Referenced by add(), finalizeHits(), initializeHits(), and run().

const EcalIntercalibConstantsMC* EBHitResponse::m_intercal

private

Definition at line 85 of file EBHitResponse.h.

Referenced by apdSignalAmplitude(), findIntercalibConstant(), and setIntercal().

bool EBHitResponse::m_isInitialized

private

Definition at line 96 of file EBHitResponse.h.

Referenced by initialize(), and putAPDSignal().

std::vector<double> EBHitResponse::m_timeOffVec

private

Definition at line 87 of file EBHitResponse.h.

Referenced by initialize().

std::vector<EBSamples> EBHitResponse::m_vSam

private

Definition at line 94 of file EBHitResponse.h.

Referenced by EBHitResponse(), operator[](), samplesSize(), samplesSizeAll(), vSam(), and vSamAll().

const double EBHitResponse::pasy

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::pcon

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::pcub

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::pehi

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::pelo

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::pext

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::pfac

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::plin

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::poff

private

Definition at line 92 of file EBHitResponse.h.

const double EBHitResponse::pqua

private

Definition at line 92 of file EBHitResponse.h.