HcalSiPM Class Reference

A general implementation for the response of a SiPM. More...

#include <HcalSiPM.h>

Public Member Functions
double	getCrossTalk () const
int	getNCells () const
double	getTau () const
double	getTempDep () const
	HcalSiPM (int nCells=1, double tau=15.)
virtual int	hitCells (unsigned int photons, unsigned int integral=0) const
virtual double	hitCells (unsigned int pes, double tempDiff=0., double photonTime=0.)
void	initRandomEngine (CLHEP::HepRandomEngine &engine)
void	resetSiPM ()
void	setCrossTalk (double xtalk)
void	setNCells (int nCells)
void	setTau (double tau)
void	setTemperatureDependence (double tempDep)
virtual double	totalCharge () const
virtual double	totalCharge (double time) const
virtual	~HcalSiPM ()

Protected Member Functions
double	cellCharge (double deltaTime) const

Protected Attributes
unsigned int	theCellCount
double	theCrossTalk
double	theLastHitTime
CLHEP::RandFlat *	theRndFlat
CLHEP::RandGaussQ *	theRndGauss
CLHEP::RandPoissonQ *	theRndPoisson
std::vector< double >	theSiPM
double	theTauInv
double	theTempDep

Detailed Description

A general implementation for the response of a SiPM.

Definition at line 20 of file HcalSiPM.h.

Constructor & Destructor Documentation

HcalSiPM::HcalSiPM	(	int	nCells = 1,
		double	tau = 15.
	)

Definition at line 9 of file HcalSiPM.cc.

References resetSiPM(), and theCellCount.

                                         :
  theCellCount(nCells), theSiPM(nCells,1.), theTauInv(1.0/tau),
  theCrossTalk(0.), theTempDep(0.), theLastHitTime(-1.),
  theRndGauss(0), theRndPoisson(0), theRndFlat(0) {

  assert(theCellCount>0);
  resetSiPM();
}

HcalSiPM::~HcalSiPM ( )

virtual

Definition at line 18 of file HcalSiPM.cc.

References theRndFlat, theRndGauss, and theRndPoisson.

                    {
  delete theRndGauss;
  delete theRndPoisson;
  delete theRndFlat;
}

Member Function Documentation

double HcalSiPM::cellCharge ( double  deltaTime ) const

protected

Definition at line 180 of file HcalSiPM.cc.

References create_public_lumi_plots::exp, query::result, and theTauInv.

Referenced by hitCells(), and totalCharge().

                                                  {
  if (deltaTime <= 0.) return 0.;
  if (deltaTime > 10./theTauInv) return 1.;
  double result(1. - std::exp(-deltaTime*theTauInv));
  return (result > 0.99) ? 1.0 : result;
}

double HcalSiPM::getCrossTalk ( ) const

inline

Definition at line 38 of file HcalSiPM.h.

References theCrossTalk.

{ return theCrossTalk; }

int HcalSiPM::getNCells ( ) const

inline

Definition at line 36 of file HcalSiPM.h.

References theCellCount.

{ return theCellCount; }

double HcalSiPM::getTau ( ) const

inline

Definition at line 37 of file HcalSiPM.h.

References theTauInv.

{ return 1.0/theTauInv; }

double HcalSiPM::getTempDep ( ) const

inline

Definition at line 39 of file HcalSiPM.h.

References theTempDep.

{ return theTempDep; }

int HcalSiPM::hitCells ( unsigned int  photons, unsigned int  integral = 0  ) const

virtual

Definition at line 24 of file HcalSiPM.cc.

References edm::hlt::Exception, create_public_lumi_plots::exp, edm::RandomNumberGenerator::getEngine(), edm::Service< T >::isAvailable(), timingPdfMaker::mean, mathSSE::sqrt(), theCellCount, theCrossTalk, theRndFlat, theRndGauss, theRndPoisson, and x.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

                                                                        {
  //don't need to do zero or negative photons.
  if (photons < 1) return 0;
  if (integral >= theCellCount) return 0;

  if (theRndGauss == 0) {
    //random number generator setup
    edm::Service<edm::RandomNumberGenerator> rng;
    if ( ! rng.isAvailable()) {
      throw cms::Exception("Configuration")
    << "HcalSiPM 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.";
    }

    CLHEP::HepRandomEngine& engine = rng->getEngine();
    theRndGauss = new CLHEP::RandGaussQ(engine);
    theRndPoisson = new CLHEP::RandPoissonQ(engine);
    theRndFlat = new CLHEP::RandFlat(engine);
  }

  //normalize by theCellCount to remove dependency on SiPM size and pixel density.
  if ((theCrossTalk > 0.) && (theCrossTalk < 1.))
    photons += theRndPoisson->fire(photons/(1.-theCrossTalk)-photons);
  double x(photons/double(theCellCount));
  double prehit(integral/double(theCellCount));

  //calculate the width and mean of the distribution for a given x
  double mean(1. - std::exp(-x));
  double width2(std::exp(-x)*(1-(1+x)*std::exp(-x)));

  //you can't hit more than everything.
  if (mean > 1.) mean = 1.;

  //convert back to absolute pixels
  mean *= (1-prehit)*theCellCount;
  width2 *= (1-prehit)*theCellCount;

  double npe;
  while (true) {
    npe = theRndGauss->fire(mean, std::sqrt(width2 + (mean*prehit)));
    if ((npe > -0.5) && (npe <= theCellCount-integral))
      return int(npe + 0.5);
  }
}

double HcalSiPM::hitCells ( unsigned int  pes, double  tempDiff = 0., double  photonTime = 0.  )

virtual

Definition at line 71 of file HcalSiPM.cc.

References cellCharge(), edm::hlt::Exception, edm::RandomNumberGenerator::getEngine(), edm::Service< T >::isAvailable(), theCellCount, theCrossTalk, theLastHitTime, theRndFlat, theRndGauss, theRndPoisson, theSiPM, and theTempDep.

                                 {
  // response to light impulse with pes input photons.  The return is the number
  // of micro-pixels hit.  If a fraction other than 0. is supplied then the
  // micro-pixel doesn't fully discharge.  The tempDiff is the temperature 
  // difference from nominal and is used to modify the relative strength of a
  // hit pixel.  Pixels which are fractionally charged return a fractional
  // number of hit pixels.

  if (theRndGauss == 0) {
    //random number generator setup
    edm::Service<edm::RandomNumberGenerator> rng;
    if ( ! rng.isAvailable()) {
      throw cms::Exception("Configuration")
    << "HcalSiPM 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.";
    }

    CLHEP::HepRandomEngine& engine = rng->getEngine();
    theRndGauss = new CLHEP::RandGaussQ(engine);
    theRndPoisson = new CLHEP::RandPoissonQ(engine);
    theRndFlat = new CLHEP::RandFlat(engine);
  }

  if ((theCrossTalk > 0.) && (theCrossTalk < 1.))
    pes += theRndPoisson->fire(pes/(1. - theCrossTalk) - pes);

  unsigned int pixel;
  double sum(0.), hit(0.);
  for (unsigned int pe(0); pe < pes; ++pe) {
    pixel = theRndFlat->fireInt(theCellCount);
    hit = (theSiPM[pixel] < 0.) ? 1.0 :
      (cellCharge(photonTime - theSiPM[pixel]));
    sum += hit*(1 + (tempDiff*theTempDep));
    theSiPM[pixel] = photonTime;
  }

  theLastHitTime = photonTime;

  return sum;
}

void HcalSiPM::initRandomEngine

(

CLHEP::HepRandomEngine &

engine

)

Definition at line 159 of file HcalSiPM.cc.

References theRndFlat, theRndGauss, and theRndPoisson.

Referenced by HcalSiPMHitResponse::setRandomEngine().

                                                            {
  if(theRndGauss) delete theRndGauss;
  theRndGauss = new CLHEP::RandGaussQ(engine);
  if(theRndPoisson) delete theRndPoisson;
  theRndPoisson = new CLHEP::RandPoissonQ(engine);
  if(theRndFlat) delete theRndFlat;
  theRndFlat = new CLHEP::RandFlat(engine);
}

void HcalSiPM::resetSiPM ( )

inline

Definition at line 26 of file HcalSiPM.h.

References lumiContext::fill, and theSiPM.

Referenced by HcalSiPM(), and setNCells().

{ std::fill(theSiPM.begin(), theSiPM.end(), -999.); }

void HcalSiPM::setCrossTalk

(

double

xtalk

)

Definition at line 143 of file HcalSiPM.cc.

References theCrossTalk.

                                        {
  // set the cross-talk probability

  if((xTalk < 0) || (xTalk >= 1)) {
    theCrossTalk = 0.;
  } else {
    theCrossTalk = xTalk;
  }   

}

void HcalSiPM::setNCells

(

int

nCells

)

Definition at line 136 of file HcalSiPM.cc.

References resetSiPM(), theCellCount, and theSiPM.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

                                   {
  assert(nCells>0);
  theCellCount = nCells;
  theSiPM.resize(nCells);
  resetSiPM();
}

void HcalSiPM::setTau ( double  tau )

inline

Definition at line 42 of file HcalSiPM.h.

References metsig::tau, and theTauInv.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

{theTauInv=1.0/tau;}

void HcalSiPM::setTemperatureDependence

(

double

tempDep

)

Definition at line 154 of file HcalSiPM.cc.

References theTempDep.

                                                    {
  // set the temperature dependence
  theTempDep = dTemp;
}

virtual double HcalSiPM::totalCharge ( ) const

inlinevirtual

Definition at line 32 of file HcalSiPM.h.

References theLastHitTime, and totalCharge().

Referenced by totalCharge().

{ return totalCharge(theLastHitTime); }

double HcalSiPM::totalCharge ( double  time ) const

virtual

Definition at line 115 of file HcalSiPM.cc.

References cellCharge(), i, theCellCount, and theSiPM.

                                              {
  // sum of the micro-pixels.  NP is a fully charged device.
  // 0 is a fullly depleted device.
  double tot(0.), hit(0.);
  for(unsigned int i=0; i<theCellCount; ++i)  {
    hit = (theSiPM[i] < 0.) ? 1. : cellCharge(time - theSiPM[i]);
    tot += hit;
  }
  return tot;
}

Member Data Documentation

unsigned int HcalSiPM::theCellCount

protected

Definition at line 55 of file HcalSiPM.h.

Referenced by getNCells(), HcalSiPM(), hitCells(), setNCells(), and totalCharge().

double HcalSiPM::theCrossTalk

protected

Definition at line 58 of file HcalSiPM.h.

Referenced by getCrossTalk(), hitCells(), and setCrossTalk().

double HcalSiPM::theLastHitTime

protected

Definition at line 60 of file HcalSiPM.h.

Referenced by hitCells(), and totalCharge().

CLHEP::RandFlat* HcalSiPM::theRndFlat

mutableprotected

Definition at line 64 of file HcalSiPM.h.

Referenced by hitCells(), initRandomEngine(), and ~HcalSiPM().

CLHEP::RandGaussQ* HcalSiPM::theRndGauss

mutableprotected

Definition at line 62 of file HcalSiPM.h.

Referenced by hitCells(), initRandomEngine(), and ~HcalSiPM().

CLHEP::RandPoissonQ* HcalSiPM::theRndPoisson

mutableprotected

Definition at line 63 of file HcalSiPM.h.

Referenced by hitCells(), initRandomEngine(), and ~HcalSiPM().

std::vector< double > HcalSiPM::theSiPM

protected

Definition at line 56 of file HcalSiPM.h.

Referenced by hitCells(), resetSiPM(), setNCells(), and totalCharge().

double HcalSiPM::theTauInv

protected

Definition at line 57 of file HcalSiPM.h.

Referenced by cellCharge(), getTau(), and setTau().

double HcalSiPM::theTempDep

protected

Definition at line 59 of file HcalSiPM.h.

Referenced by getTempDep(), hitCells(), and setTemperatureDependence().