HcalSimParameters Class Reference

#include <HcalSimParameters.h>

Inheritance diagram for HcalSimParameters:

Public Member Functions
int	delayQIE () const
bool	doSiPMSmearing () const
bool	doTimeSmear () const
double	fCtoGeV (const DetId &detId) const
	HcalSimParameters (double simHitToPhotoelectrons, double samplingFactor, double timePhase, int readoutFrameSize, int binOfMaximum, bool doPhotostatistics, bool syncPhase, int firstRing, const std::vector< double > &samplingFactors, double sipmTau)
	HcalSimParameters (const edm::ParameterSet &p)
double	photoelectronsToAnalog (const DetId &detId) const override
int	pixels (const DetId &detId) const
virtual double	samplingFactor (const DetId &detId) const
void	setDbService (const HcalDbService *service)
unsigned int	signalShape (const DetId &detId) const
double	simHitToPhotoelectrons (const DetId &detId) const override
double	sipmCrossTalk (const DetId &detId) const
double	sipmDarkCurrentuA (const DetId &detId) const
std::vector< float >	sipmNonlinearity (const DetId &detId) const
double	sipmTau () const
double	threshold_currentTDC () const
double	timeSmearRMS (double ampl) const
	~HcalSimParameters () override
Public Member Functions inherited from CaloSimParameters
int	binOfMaximum () const
	CaloSimParameters (double simHitToPhotoelectrons, double photoelectronsToAnalog, double samplingFactor, double timePhase, int readoutFrameSize, int binOfMaximum, bool doPhotostatistics, bool syncPhase=true)
	CaloSimParameters (const edm::ParameterSet &p, bool skipPe2Fc=false)
bool	doPhotostatistics () const
	whether or not to apply Poisson statistics to photoelectrons More...
double	photoelectronsToAnalog () const
	the factor which goes from photoelectrons to whatever gets read by ADCs More...
int	readoutFrameSize () const
	for now, the LinearFrames and trhe digis will be one-to-one. More...
void	setBinOfMaximum (int binOfMax)
void	setReadoutFrameSize (int frameSize)
	some datamixing apps need this to be set dynamically More...
double	simHitToPhotoelectrons () const
bool	syncPhase () const
double	timePhase () const
	the adjustment you need to apply to get the signal where you want it More...
virtual	~CaloSimParameters ()

Private Member Functions
void	defaultTimeSmearing ()

Private Attributes
int	delayQIE_
bool	doTimeSmear_
const HcalDbService *	theDbService
int	theFirstRing
std::vector< double >	theSamplingFactors
const HcalSiPMCharacteristics *	theSiPMcharacteristics
bool	theSiPMSmearing
double	theSiPMTau
HcalTimeSmearSettings	theSmearSettings
double	threshold_currentTDC_

Friends
class	HcalSimParameterMap

Detailed Description

Definition at line 10 of file HcalSimParameters.h.

Constructor & Destructor Documentation

HcalSimParameters::HcalSimParameters	(	double	simHitToPhotoelectrons,
		double	samplingFactor,
		double	timePhase,
		int	readoutFrameSize,
		int	binOfMaximum,
		bool	doPhotostatistics,
		bool	syncPhase,
		int	firstRing,
		const std::vector< double > &	samplingFactors,
		double	sipmTau
	)

Definition at line 12 of file HcalSimParameters.cc.

References defaultTimeSmearing(), and theSiPMSmearing.

    : CaloSimParameters(simHitToPhotoelectrons,
                        0.0,
                        samplingFactor,
                        timePhase,
                        readoutFrameSize,
                        binOfMaximum,
                        doPhotostatistics,
                        syncPhase),
      theDbService(nullptr),
      theSiPMcharacteristics(nullptr),
      theFirstRing(firstRing),
      theSamplingFactors(samplingFactors),
      theSiPMSmearing(false),
      doTimeSmear_(true),
      theSiPMTau(sipmTau) {
  defaultTimeSmearing();

  edm::LogInfo("HcalSimParameters:") << " doSiPMsmearing    = " << theSiPMSmearing;
}

HcalSimParameters::HcalSimParameters

(

const edm::ParameterSet &

p

)

Definition at line 42 of file HcalSimParameters.cc.

References defaultTimeSmearing(), and theSiPMSmearing.

    : CaloSimParameters(p, true),
      theDbService(nullptr),
      theFirstRing(p.getParameter<int>("firstRing")),
      theSamplingFactors(p.getParameter<std::vector<double> >("samplingFactors")),
      theSiPMSmearing(p.getParameter<bool>("doSiPMSmearing")),
      doTimeSmear_(p.getParameter<bool>("timeSmearing")),
      theSiPMTau(p.getParameter<double>("sipmTau")),
      threshold_currentTDC_(p.getParameter<double>("threshold_currentTDC")),
      delayQIE_(p.getParameter<int>("delayQIE")) {
  defaultTimeSmearing();

  edm::LogInfo("HcalSimParameters:") << " doSiPMsmearing    = " << theSiPMSmearing;
}

HcalSimParameters::~HcalSimParameters ( )

inlineoverride

Definition at line 24 of file HcalSimParameters.h.

{}

Member Function Documentation

void HcalSimParameters::defaultTimeSmearing ( )

private

Definition at line 108 of file HcalSimParameters.cc.

References GeV2fC, and theSmearSettings.

Referenced by HcalSimParameters().

                                            {
  // GeV->ampl (fC), time (ns)
  theSmearSettings.emplace_back(4.00 * GeV2fC, 4.050);
  theSmearSettings.emplace_back(20.00 * GeV2fC, 3.300);
  theSmearSettings.emplace_back(25.00 * GeV2fC, 2.925);
  theSmearSettings.emplace_back(30.00 * GeV2fC, 2.714);
  theSmearSettings.emplace_back(37.00 * GeV2fC, 2.496);
  theSmearSettings.emplace_back(44.50 * GeV2fC, 2.278);
  theSmearSettings.emplace_back(56.00 * GeV2fC, 2.138);
  theSmearSettings.emplace_back(63.50 * GeV2fC, 2.022);
  theSmearSettings.emplace_back(81.00 * GeV2fC, 1.788);
  theSmearSettings.emplace_back(88.50 * GeV2fC, 1.695);
  theSmearSettings.emplace_back(114.50 * GeV2fC, 1.716);
  theSmearSettings.emplace_back(175.50 * GeV2fC, 1.070);
  theSmearSettings.emplace_back(350.00 * GeV2fC, 1.564);
  theSmearSettings.emplace_back(99999.00 * GeV2fC, 1.564);
}

int HcalSimParameters::delayQIE ( ) const

inline

Definition at line 43 of file HcalSimParameters.h.

References delayQIE_.

Referenced by HcalAmplifier::amplify().

{ return delayQIE_; }

bool HcalSimParameters::doSiPMSmearing ( ) const

inline

Definition at line 42 of file HcalSimParameters.h.

References theSiPMSmearing.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

{ return theSiPMSmearing; }

bool HcalSimParameters::doTimeSmear ( ) const

inline

Definition at line 37 of file HcalSimParameters.h.

References doTimeSmear_.

Referenced by HcalTimeSlewSim::delay().

{ return doTimeSmear_; }

double HcalSimParameters::fCtoGeV

(

const DetId &

detId

)

const

{

Definition at line 75 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalDbService::getGain(), HcalDbService::getGainWidth(), HcalGain::getValue(), mps_fire::result, and theDbService.

Referenced by simHitToPhotoelectrons().

                                                          {
  assert(theDbService != nullptr);
  HcalGenericDetId hcalGenDetId(detId);
  const HcalGain* gains = theDbService->getGain(hcalGenDetId);
  const HcalGainWidth* gwidths = theDbService->getGainWidth(hcalGenDetId);
  double result = 0.0;
  if (!gains || !gwidths) {
    edm::LogError("HcalAmplifier") << "Could not fetch HCAL conditions for channel " << hcalGenDetId;
  } else {
    // only one gain will be recorded per channel, so just use capID 0 for now
    result = gains->getValue(0);
    //  if(doNoise_)
    //    result += CLHEP::RandGaussQ::shoot(0.,  gwidths->getValue(0));
    //  }
  }
  return result;
}

double HcalSimParameters::photoelectronsToAnalog ( const DetId &  detId ) const

overridevirtual

Reimplemented from CaloSimParameters.

Definition at line 99 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalSiPMParameter::getFCByPE(), HcalDbService::getHcalSiPMParameter(), and theDbService.

Referenced by HcalSiPMHitResponse::addPEnoise().

                                                                         {
  //now always taken from database for HPDs or SiPMs (HB, HE, HO)
  assert(theDbService);
  return theDbService->getHcalSiPMParameter(detId)->getFCByPE();
}

int HcalSimParameters::pixels

(

const DetId &

detId

)

const

Definition at line 150 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalDbService::getHcalSiPMParameter(), HcalSiPMCharacteristics::getPixels(), HcalSiPMParameter::getType(), theDbService, and theSiPMcharacteristics.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

                                                      {
  assert(theDbService);
  int type = theDbService->getHcalSiPMParameter(detId)->getType();
  return theSiPMcharacteristics->getPixels(type);
}

double HcalSimParameters::samplingFactor ( const DetId &  detId ) const

virtual

the ratio of actual incident energy to deposited energy in the SimHit

Definition at line 94 of file HcalSimParameters.cc.

References HcalDetId::ietaAbs(), theFirstRing, and theSamplingFactors.

Referenced by simHitToPhotoelectrons().

                                                                 {
  HcalDetId hcalDetId(detId);
  return theSamplingFactors.at(hcalDetId.ietaAbs() - theFirstRing);
}

void HcalSimParameters::setDbService

(

const HcalDbService *

service

)

Definition at line 57 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalDbService::getHcalSiPMCharacteristics(), theDbService, and theSiPMcharacteristics.

Referenced by HcalSimParameterMap::setDbService().

                                                                 {
  assert(service);
  theDbService = service;
  theSiPMcharacteristics = service->getHcalSiPMCharacteristics();
  assert(theSiPMcharacteristics);
}

unsigned int HcalSimParameters::signalShape

(

const DetId &

detId

)

const

Definition at line 172 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalDbService::getHcalMCParam(), HcalMCParam::signalShape(), and theDbService.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

                                                                    {
  assert(theDbService);
  return theDbService->getHcalMCParam(detId)->signalShape();
}

double HcalSimParameters::simHitToPhotoelectrons ( const DetId &  detId ) const

overridevirtual

Reimplemented from CaloSimParameters.

Definition at line 64 of file HcalSimParameters.cc.

References fCtoGeV(), HcalGenericDetId::HcalGenForward, HcalGenericDetId::HcalGenZDC, CaloSimParameters::photoelectronsToAnalog(), mps_fire::result, samplingFactor(), and CaloSimParameters::simHitToPhotoelectrons().

                                                                         {
  // the gain is in units of GeV/fC.  We want a constant with pe/dGeV
  // pe/dGeV = (GeV/dGeV) / (GeV/fC) / (fC/pe)
  double result = CaloSimParameters::simHitToPhotoelectrons(detId);
  if (HcalGenericDetId(detId).genericSubdet() != HcalGenericDetId::HcalGenForward ||
      HcalGenericDetId(detId).genericSubdet() != HcalGenericDetId::HcalGenZDC) {
    result = samplingFactor(detId) / fCtoGeV(detId) / photoelectronsToAnalog(detId);
  }
  return result;
}

double HcalSimParameters::sipmCrossTalk

(

const DetId &

detId

)

const

Definition at line 161 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalSiPMCharacteristics::getCrossTalk(), HcalDbService::getHcalSiPMParameter(), HcalSiPMParameter::getType(), theDbService, and theSiPMcharacteristics.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

                                                                {
  assert(theDbService);
  int type = theDbService->getHcalSiPMParameter(detId)->getType();
  return theSiPMcharacteristics->getCrossTalk(type);
}

double HcalSimParameters::sipmDarkCurrentuA

(

const DetId &

detId

)

const

Definition at line 156 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalSiPMParameter::getDarkCurrent(), HcalDbService::getHcalSiPMParameter(), and theDbService.

Referenced by HcalSiPMHitResponse::addPEnoise().

                                                                    {
  assert(theDbService);
  return theDbService->getHcalSiPMParameter(detId)->getDarkCurrent();
}

std::vector< float > HcalSimParameters::sipmNonlinearity

(

const DetId &

detId

)

const

Definition at line 166 of file HcalSimParameters.cc.

References cms::cuda::assert(), HcalDbService::getHcalSiPMParameter(), HcalSiPMCharacteristics::getNonLinearities(), HcalSiPMParameter::getType(), theDbService, and theSiPMcharacteristics.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

                                                                             {
  assert(theDbService);
  int type = theDbService->getHcalSiPMParameter(detId)->getType();
  return theSiPMcharacteristics->getNonLinearities(type);
}

double HcalSimParameters::sipmTau ( ) const

inline

Definition at line 45 of file HcalSimParameters.h.

References theSiPMTau.

Referenced by HcalSiPMHitResponse::makeSiPMSignal().

{ return theSiPMTau; }

double HcalSimParameters::threshold_currentTDC ( ) const

inline

Definition at line 44 of file HcalSimParameters.h.

References threshold_currentTDC_.

Referenced by HcalElectronicsSim::analogToDigital().

{ return threshold_currentTDC_; }

double HcalSimParameters::timeSmearRMS

(

double

ampl

)

const

Definition at line 126 of file HcalSimParameters.cc.

References first, mps_fire::i, and theSmearSettings.

Referenced by HcalTimeSlewSim::delay().

                                                        {
  HcalTimeSmearSettings::size_type i;
  double smearsigma = 0;

  for (i = 0; i < theSmearSettings.size(); i++)
    if (theSmearSettings[i].first > ampl)
      break;

  // Smearing occurs only within the envelope definitions.
  if (i != 0 && (i < theSmearSettings.size())) {
    double energy1 = theSmearSettings[i - 1].first;
    double sigma1 = theSmearSettings[i - 1].second;
    double energy2 = theSmearSettings[i].first;
    double sigma2 = theSmearSettings[i].second;

    if (energy2 != energy1)
      smearsigma = sigma1 + ((sigma2 - sigma1) * (ampl - energy1) / (energy2 - energy1));
    else
      smearsigma = (sigma2 + sigma1) / 2.;
  }

  return smearsigma;
}

Friends And Related Function Documentation

friend class HcalSimParameterMap

friend

Definition at line 51 of file HcalSimParameters.h.

Member Data Documentation

int HcalSimParameters::delayQIE_

private

Definition at line 64 of file HcalSimParameters.h.

Referenced by delayQIE().

bool HcalSimParameters::doTimeSmear_

private

Definition at line 60 of file HcalSimParameters.h.

Referenced by doTimeSmear().

const HcalDbService* HcalSimParameters::theDbService

private

Definition at line 55 of file HcalSimParameters.h.

Referenced by fCtoGeV(), photoelectronsToAnalog(), pixels(), setDbService(), signalShape(), sipmCrossTalk(), sipmDarkCurrentuA(), and sipmNonlinearity().

int HcalSimParameters::theFirstRing

private

Definition at line 57 of file HcalSimParameters.h.

Referenced by samplingFactor().

std::vector<double> HcalSimParameters::theSamplingFactors

private

Definition at line 58 of file HcalSimParameters.h.

Referenced by samplingFactor().

const HcalSiPMCharacteristics* HcalSimParameters::theSiPMcharacteristics

private

Definition at line 56 of file HcalSimParameters.h.

Referenced by pixels(), setDbService(), sipmCrossTalk(), and sipmNonlinearity().

bool HcalSimParameters::theSiPMSmearing

private

Definition at line 59 of file HcalSimParameters.h.

Referenced by doSiPMSmearing(), and HcalSimParameters().

double HcalSimParameters::theSiPMTau

private

Definition at line 62 of file HcalSimParameters.h.

Referenced by sipmTau().

HcalTimeSmearSettings HcalSimParameters::theSmearSettings

private

Definition at line 61 of file HcalSimParameters.h.

Referenced by defaultTimeSmearing(), and timeSmearRMS().

double HcalSimParameters::threshold_currentTDC_

private

Definition at line 63 of file HcalSimParameters.h.

Referenced by threshold_currentTDC().