#include <HGCDigitizerBase.h>

Inheritance diagram for HGCDigitizerBase:

Public Types
typedef edm::SortedCollection< DFr >	DColl

typedef HGCalDataFrame	DFr

Public Member Functions
DetId::Detector	det () const

void	GenerateGaussianNoise (CLHEP::HepRandomEngine *engine, const double NoiseMean, const double NoiseStd)
	Gaussian Noise Generation Member Function. More...

	HGCDigitizerBase (const edm::ParameterSet &ps)
	CTOR. More...

float	keV2fC () const
	getters More...

void	run (std::unique_ptr< DColl > &digiColl, hgc::HGCSimHitDataAccumulator &simData, const CaloSubdetectorGeometry theGeom, const std::unordered_set< DetId > &validIds, uint32_t digitizationType, CLHEP::HepRandomEngine engine)
	steer digitization mode More...

virtual void	runDigitizer (std::unique_ptr< DColl > &coll, hgc::HGCSimHitDataAccumulator &simData, const CaloSubdetectorGeometry theGeom, const std::unordered_set< DetId > &validIds, CLHEP::HepRandomEngine engine)=0
	to be specialized by top class More...

void	runSimple (std::unique_ptr< DColl > &coll, hgc::HGCSimHitDataAccumulator &simData, const CaloSubdetectorGeometry theGeom, const std::unordered_set< DetId > &validIds, CLHEP::HepRandomEngine engine)
	a trivial digitization: sum energies and digitize More...

ForwardSubdetector	subdet () const

std::array< float, 3 >	tdcForToAOnset () const

float	tdcOnset () const

bool	toaModeByEnergy () const

void	updateOutput (std::unique_ptr< DColl > &coll, const DFr &rawDataFrame)
	prepares the output according to the number of time samples to produce More...

virtual	~HGCDigitizerBase ()
	DTOR. More...

Protected Attributes
double	bxTime_

std::vector< double >	cce_

DetId::Detector	det_

std::string	doseMapFile_

bool	doTimeSamples_

std::array< std::array< double, samplesize_ >, NoiseArrayLength_ >	GaussianNoiseArray_

float	keV2fC_

edm::ParameterSet	myCfg_

std::unique_ptr< HGCFEElectronics< DFr > >	myFEelectronics_

std::vector< float >	noise_fC_

bool	NoiseGeneration_Method_

const double	NoiseMean_

const double	NoiseStd_

bool	RandNoiseGenerationFlag_

HGCalSiNoiseMap< HGCSiliconDetId >	scal_

bool	scaleByDose_

double	scaleByDoseFactor_

HGCalSiNoiseMap< HFNoseDetId >	scalHFNose_

ForwardSubdetector	subdet_

bool	thresholdFollowsMIP_

Static Protected Attributes
static const size_t	NoiseArrayLength_ = 200000

static const size_t	samplesize_ = 15

Detailed Description

Definition at line 54 of file HGCDigitizerBase.h.

Member Typedef Documentation

◆ DColl

typedef edm::SortedCollection<DFr> HGCDigitizerBase::DColl

Definition at line 57 of file HGCDigitizerBase.h.

◆ DFr

typedef HGCalDataFrame HGCDigitizerBase::DFr

Definition at line 56 of file HGCDigitizerBase.h.

Constructor & Destructor Documentation

◆ HGCDigitizerBase()

HGCDigitizerBase::HGCDigitizerBase ( const edm::ParameterSet & ps )

CTOR.

Definition at line 9 of file HGCDigitizerBase.cc.

     : scaleByDose_(false),
       det_(DetId::Forward),
       subdet_(ForwardSubdetector::ForwardEmpty),
       NoiseMean_(0.0),
       NoiseStd_(1.0) {
   bxTime_ = ps.getParameter<double>("bxTime");
   myCfg_ = ps.getParameter<edm::ParameterSet>("digiCfg");
   NoiseGeneration_Method_ = ps.getParameter<bool>("NoiseGeneration_Method");
   doTimeSamples_ = myCfg_.getParameter<bool>("doTimeSamples");
   thresholdFollowsMIP_ = myCfg_.getParameter<bool>("thresholdFollowsMIP");
   if (myCfg_.exists("keV2fC"))
     keV2fC_ = myCfg_.getParameter<double>("keV2fC");
   else
     keV2fC_ = 1.0;
  
   if (myCfg_.existsAs<edm::ParameterSet>("chargeCollectionEfficiencies")) {
     cce_ = myCfg_.getParameter<edm::ParameterSet>("chargeCollectionEfficiencies")
                .template getParameter<std::vector<double>>("values");
   }
  
   if (myCfg_.existsAs<double>("noise_fC")) {
     noise_fC_.reserve(1);
     noise_fC_.push_back(myCfg_.getParameter<double>("noise_fC"));
   } else if (myCfg_.existsAs<std::vector<double>>("noise_fC")) {
     const auto& noises = myCfg_.getParameter<std::vector<double>>("noise_fC");
     noise_fC_ = std::vector<float>(noises.begin(), noises.end());
   } else if (myCfg_.existsAs<edm::ParameterSet>("noise_fC")) {
     const auto& noises =
         myCfg_.getParameter<edm::ParameterSet>("noise_fC").template getParameter<std::vector<double>>("values");
     noise_fC_ = std::vector<float>(noises.begin(), noises.end());
     scaleByDose_ = myCfg_.getParameter<edm::ParameterSet>("noise_fC").template getParameter<bool>("scaleByDose");
     int scaleByDoseAlgo =
         myCfg_.getParameter<edm::ParameterSet>("noise_fC").template getParameter<uint32_t>("scaleByDoseAlgo");
     scaleByDoseFactor_ = myCfg_.getParameter<edm::ParameterSet>("noise_fC").getParameter<double>("scaleByDoseFactor");
     doseMapFile_ = myCfg_.getParameter<edm::ParameterSet>("noise_fC").template getParameter<std::string>("doseMap");
     scal_.setDoseMap(doseMapFile_, scaleByDoseAlgo);
     scal_.setFluenceScaleFactor(scaleByDoseFactor_);
     scalHFNose_.setDoseMap(doseMapFile_, scaleByDoseAlgo);
     scalHFNose_.setFluenceScaleFactor(scaleByDoseFactor_);
   } else {
     noise_fC_.resize(1, 1.f);
   }
   if (myCfg_.existsAs<edm::ParameterSet>("ileakParam")) {
     scal_.setIleakParam(
         myCfg_.getParameter<edm::ParameterSet>("ileakParam").template getParameter<std::vector<double>>("ileakParam"));
     scalHFNose_.setIleakParam(
         myCfg_.getParameter<edm::ParameterSet>("ileakParam").template getParameter<std::vector<double>>("ileakParam"));
   }
   if (myCfg_.existsAs<edm::ParameterSet>("cceParams")) {
     scal_.setCceParam(
         myCfg_.getParameter<edm::ParameterSet>("cceParams").template getParameter<std::vector<double>>("cceParamFine"),
         myCfg_.getParameter<edm::ParameterSet>("cceParams").template getParameter<std::vector<double>>("cceParamThin"),
         myCfg_.getParameter<edm::ParameterSet>("cceParams").template getParameter<std::vector<double>>("cceParamThick"));
     scalHFNose_.setCceParam(
         myCfg_.getParameter<edm::ParameterSet>("cceParams").template getParameter<std::vector<double>>("cceParamFine"),
         myCfg_.getParameter<edm::ParameterSet>("cceParams").template getParameter<std::vector<double>>("cceParamThin"),
         myCfg_.getParameter<edm::ParameterSet>("cceParams").template getParameter<std::vector<double>>("cceParamThick"));
   }
  
   edm::ParameterSet feCfg = myCfg_.getParameter<edm::ParameterSet>("feCfg");
   myFEelectronics_ = std::make_unique<HGCFEElectronics<DFr>>(feCfg);
   myFEelectronics_->SetNoiseValues(noise_fC_);
  
   //override the "default ADC pulse" with the one with which was configured the FE electronics class
   scal_.setDefaultADCPulseShape(myFEelectronics_->getDefaultADCPulse());
   scalHFNose_.setDefaultADCPulseShape(myFEelectronics_->getDefaultADCPulse());
  
   RandNoiseGenerationFlag_ = false;
 }

References bxTime_, cce_, doseMapFile_, doTimeSamples_, edm::ParameterSet::exists(), edm::ParameterSet::existsAs(), f, hgcalDigitizer_cfi::feCfg, edm::ParameterSet::getParameter(), keV2fC_, myCfg_, myFEelectronics_, noise_fC_, NoiseGeneration_Method_, HLTEgPhaseIITestSequence_cff::noises, RandNoiseGenerationFlag_, scal_, scaleByDose_, hgcalDigitizer_cfi::scaleByDoseAlgo, scaleByDoseFactor_, scalHFNose_, HGCalSiNoiseMap< T >::setCceParam(), HGCalSiNoiseMap< T >::setDefaultADCPulseShape(), HGCalSiNoiseMap< T >::setDoseMap(), HGCalRadiationMap::setFluenceScaleFactor(), HGCalSiNoiseMap< T >::setIleakParam(), and thresholdFollowsMIP_.

◆ ~HGCDigitizerBase()

virtual HGCDigitizerBase::~HGCDigitizerBase ( )

inlinevirtual

DTOR.

Definition at line 112 of file HGCDigitizerBase.h.

112 {};

Member Function Documentation

◆ det()

DetId::Detector HGCDigitizerBase::det ( ) const

inline

Definition at line 84 of file HGCDigitizerBase.h.

84 { return det_; }

References det_.

Referenced by HGCHEbackDigitizer::runRealisticDigitizer(), and runSimple().

◆ GenerateGaussianNoise()

void HGCDigitizerBase::GenerateGaussianNoise	(	CLHEP::HepRandomEngine *	engine,
		const double	NoiseMean,
		const double	NoiseStd
	)

Gaussian Noise Generation Member Function.

Definition at line 80 of file HGCDigitizerBase.cc.

                                                                     {
   for (size_t i = 0; i < NoiseArrayLength_; i++) {
     for (size_t j = 0; j < samplesize_; j++) {
       GaussianNoiseArray_[i][j] = CLHEP::RandGaussQ::shoot(engine, NoiseMean, NoiseStd);
     }
   }
 }

References GaussianNoiseArray_, mps_fire::i, dqmiolumiharvest::j, NoiseArrayLength_, and samplesize_.

Referenced by run().

◆ keV2fC()

float HGCDigitizerBase::keV2fC ( ) const

inline

getters

Definition at line 80 of file HGCDigitizerBase.h.

80 { return keV2fC_; }

References keV2fC_.

◆ run()

void HGCDigitizerBase::run	(	std::unique_ptr< DColl > &	digiColl,
		hgc::HGCSimHitDataAccumulator &	simData,
		const CaloSubdetectorGeometry *	theGeom,
		const std::unordered_set< DetId > &	validIds,
		uint32_t	digitizationType,
		CLHEP::HepRandomEngine *	engine
	)

steer digitization mode

Definition at line 90 of file HGCDigitizerBase.cc.

                                                          {
   if (scaleByDose_) {
     scal_.setGeometry(theGeom, HGCalSiNoiseMap<HGCSiliconDetId>::AUTO, myFEelectronics_->getTargetMipValue());
     scalHFNose_.setGeometry(theGeom, HGCalSiNoiseMap<HFNoseDetId>::AUTO, myFEelectronics_->getTargetMipValue());
   }
   if (NoiseGeneration_Method_ == true) {
     if (RandNoiseGenerationFlag_ == false) {
       GenerateGaussianNoise(engine, NoiseMean_, NoiseStd_);
       RandNoiseGenerationFlag_ = true;
     }
   }
   if (digitizationType == 0)
     runSimple(digiColl, simData, theGeom, validIds, engine);
   else
     runDigitizer(digiColl, simData, theGeom, validIds, engine);
 }

References DigiToRawDM_cff::digiColl, hgcalDigitizer_cfi::digitizationType, GenerateGaussianNoise(), myFEelectronics_, NoiseGeneration_Method_, NoiseMean_, NoiseStd_, RandNoiseGenerationFlag_, runDigitizer(), runSimple(), scal_, scaleByDose_, scalHFNose_, and HGCalSiNoiseMap< T >::setGeometry().

◆ runDigitizer()

virtual void HGCDigitizerBase::runDigitizer	(	std::unique_ptr< DColl > &	coll,
		hgc::HGCSimHitDataAccumulator &	simData,
		const CaloSubdetectorGeometry *	theGeom,
		const std::unordered_set< DetId > &	validIds,
		CLHEP::HepRandomEngine *	engine
	)

pure virtual

to be specialized by top class

Referenced by run().

◆ runSimple()

void HGCDigitizerBase::runSimple	(	std::unique_ptr< DColl > &	coll,
		hgc::HGCSimHitDataAccumulator &	simData,
		const CaloSubdetectorGeometry *	theGeom,
		const std::unordered_set< DetId > &	validIds,
		CLHEP::HepRandomEngine *	engine
	)

a trivial digitization: sum energies and digitize

Definition at line 112 of file HGCDigitizerBase.cc.

                                                                {
   HGCSimHitData chargeColl, toa;
  
   // this represents a cell with no signal charge
   HGCCellInfo zeroData;
   zeroData.hit_info[0].fill(0.f);  //accumulated energy
   zeroData.hit_info[1].fill(0.f);  //time-of-flight
  
   std::array<double, samplesize_> cellNoiseArray;
   for (size_t i = 0; i < samplesize_; i++)
     cellNoiseArray[i] = 0.0;
  
   for (const auto& id : validIds) {
     chargeColl.fill(0.f);
     toa.fill(0.f);
     HGCSimHitDataAccumulator::iterator it = simData.find(id);
     HGCCellInfo& cell = (simData.end() == it ? zeroData : it->second);
     addCellMetadata(cell, theGeom, id);
     if (NoiseGeneration_Method_ == true) {
       size_t hash_index = (CLHEP::RandFlat::shootInt(engine, (NoiseArrayLength_ - 1)) + id) % NoiseArrayLength_;
  
       cellNoiseArray = GaussianNoiseArray_[hash_index];
     }
  
     //set the noise,cce, LSB, threshold, and ADC pulse shape to be used
     float cce(1.f), noiseWidth(0.f), lsbADC(-1.f), maxADC(-1.f);
     // half the target mip value is the specification for ZS threshold
     uint32_t thrADC(std::floor(myFEelectronics_->getTargetMipValue() / 2));
     uint32_t gainIdx = 0;
     std::array<float, 6>& adcPulse = myFEelectronics_->getDefaultADCPulse();
  
     double tdcOnsetAuto = -1;
     if (scaleByDose_) {
       if (id.det() == DetId::Forward && id.subdetId() == ForwardSubdetector::HFNose) {
         HGCalSiNoiseMap<HFNoseDetId>::SiCellOpCharacteristicsCore siop = scalHFNose_.getSiCellOpCharacteristicsCore(id);
         cce = siop.cce;
         noiseWidth = siop.noise;
         HGCalSiNoiseMap<HFNoseDetId>::GainRange_t gain((HGCalSiNoiseMap<HFNoseDetId>::GainRange_t)siop.gain);
         lsbADC = scalHFNose_.getLSBPerGain()[gain];
         maxADC = scalHFNose_.getMaxADCPerGain()[gain];
         adcPulse = scalHFNose_.adcPulseForGain(gain);
         gainIdx = siop.gain;
         tdcOnsetAuto = scal_.getTDCOnsetAuto(gainIdx);
         if (thresholdFollowsMIP_)
           thrADC = siop.thrADC;
       } else {
         HGCalSiNoiseMap<HGCSiliconDetId>::SiCellOpCharacteristicsCore siop = scal_.getSiCellOpCharacteristicsCore(id);
         cce = siop.cce;
         noiseWidth = siop.noise;
         HGCalSiNoiseMap<HGCSiliconDetId>::GainRange_t gain((HGCalSiNoiseMap<HGCSiliconDetId>::GainRange_t)siop.gain);
         lsbADC = scal_.getLSBPerGain()[gain];
         maxADC = scal_.getMaxADCPerGain()[gain];
         adcPulse = scal_.adcPulseForGain(gain);
         gainIdx = siop.gain;
         tdcOnsetAuto = scal_.getTDCOnsetAuto(gainIdx);
         if (thresholdFollowsMIP_)
           thrADC = siop.thrADC;
       }
     } else if (noise_fC_[cell.thickness - 1] != 0) {
       //this is kept for legacy compatibility with the TDR simulation
       //probably should simply be removed in a future iteration
       //note that in this legacy case, gainIdx is kept at 0, fixed
       cce = (cce_.empty() ? 1.f : cce_[cell.thickness - 1]);
       noiseWidth = cell.size * noise_fC_[cell.thickness - 1];
       thrADC =
           thresholdFollowsMIP_
               ? std::floor(cell.thickness * cce * myFEelectronics_->getADCThreshold() / myFEelectronics_->getADClsb())
               : std::floor(cell.thickness * myFEelectronics_->getADCThreshold() / myFEelectronics_->getADClsb());
     }
  
     //loop over time samples and add noise
     for (size_t i = 0; i < cell.hit_info[0].size(); i++) {
       double rawCharge(cell.hit_info[0][i]);
  
       //time of arrival
       toa[i] = cell.hit_info[1][i];
       if (myFEelectronics_->toaMode() == HGCFEElectronics<DFr>::WEIGHTEDBYE && rawCharge > 0)
         toa[i] = cell.hit_info[1][i] / rawCharge;
  
       //final charge estimation
       float noise;
       if (NoiseGeneration_Method_ == true)
         noise = (float)cellNoiseArray[i] * noiseWidth;
       else
         noise = CLHEP::RandGaussQ::shoot(engine, cellNoiseArray[i], noiseWidth);
       float totalCharge(rawCharge * cce + noise);
       if (totalCharge < 0.f)
         totalCharge = 0.f;
       chargeColl[i] = totalCharge;
     }
  
     //run the shaper to create a new data frame
     DFr rawDataFrame(id);
     int thickness = cell.thickness > 0 ? cell.thickness : 1;
     myFEelectronics_->runShaper(
         rawDataFrame, chargeColl, toa, adcPulse, engine, thrADC, lsbADC, gainIdx, maxADC, thickness, tdcOnsetAuto);
  
     //update the output according to the final shape
     updateOutput(coll, rawDataFrame);
   }
 }

References hgcROCParameters_cfi::adcPulse, HGCalSiNoiseMap< T >::adcPulseForGain(), hgc_digi_utils::addCellMetadata(), cce_, det(), f, dqmMemoryStats::float, DetId::Forward, PedestalClient_cfi::gain, GaussianNoiseArray_, HGCalSiNoiseMap< T >::getLSBPerGain(), HGCalSiNoiseMap< T >::getMaxADCPerGain(), HGCalSiNoiseMap< T >::getSiCellOpCharacteristicsCore(), HGCalSiNoiseMap< T >::getTDCOnsetAuto(), HFNose, hgc_digi::HGCCellInfo::hit_info, mps_fire::i, triggerObjects_cff::id, if(), myFEelectronics_, gpuVertexFinder::noise, noise_fC_, NoiseArrayLength_, NoiseGeneration_Method_, samplesize_, scal_, scaleByDose_, scalHFNose_, hgc_digi::HGCCellInfo::size, hgc_digi::HGCCellInfo::thickness, Calorimetry_cff::thickness, thresholdFollowsMIP_, and updateOutput().

Referenced by run().

◆ subdet()

ForwardSubdetector HGCDigitizerBase::subdet ( ) const

inline

Definition at line 85 of file HGCDigitizerBase.h.

85 { return subdet_; }

References subdet_.

◆ tdcForToAOnset()

std::array<float, 3> HGCDigitizerBase::tdcForToAOnset ( ) const

inline

Definition at line 83 of file HGCDigitizerBase.h.

83 { return myFEelectronics_->getTDCForToAOnset(); }

References myFEelectronics_.

◆ tdcOnset()

float HGCDigitizerBase::tdcOnset ( ) const

inline

Definition at line 82 of file HGCDigitizerBase.h.

82 { return myFEelectronics_->getTDCOnset(); }

References myFEelectronics_.

◆ toaModeByEnergy()

bool HGCDigitizerBase::toaModeByEnergy ( ) const

inline

Definition at line 81 of file HGCDigitizerBase.h.

81 { return (myFEelectronics_->toaMode() == HGCFEElectronics<DFr>::WEIGHTEDBYE); }

References myFEelectronics_.

◆ updateOutput()

void HGCDigitizerBase::updateOutput	(	std::unique_ptr< DColl > &	coll,
		const DFr &	rawDataFrame
	)

prepares the output according to the number of time samples to produce

Definition at line 218 of file HGCDigitizerBase.cc.

                                                                                                        {
   // 9th is the sample of hte intime amplitudes
   int itIdx(9);
   if (rawDataFrame.size() <= itIdx + 2)
     return;
  
   DFr dataFrame(rawDataFrame.id());
   dataFrame.resize(5);
  
   // if in time amplitude is above threshold
   // , then don't push back the dataframe
   if ((!rawDataFrame[itIdx].threshold())) {
     return;
   }
  
   for (int it = 0; it < 5; it++) {
     dataFrame.setSample(it, rawDataFrame[itIdx - 2 + it]);
   }
  
   coll->push_back(dataFrame);
 }