#include <SSDigitizerAlgorithm.h>

Inheritance diagram for SSDigitizerAlgorithm:

Public Member Functions
void	init (const edm::EventSetup &es) override

bool	isAboveThreshold (const digitizerUtility::SimHitInfo *hitInfo, float charge, float thr) const override

bool	select_hit (const PSimHit &hit, double tCorr, double &sigScale) const override

	SSDigitizerAlgorithm (const edm::ParameterSet &conf, edm::ConsumesCollector iC)

	~SSDigitizerAlgorithm () override

Public Member Functions inherited from Phase2TrackerDigitizerAlgorithm
virtual void	accumulateSimHits (const std::vector< PSimHit >::const_iterator inputBegin, const std::vector< PSimHit >::const_iterator inputEnd, const size_t inputBeginGlobalIndex, const uint32_t tofBin, const Phase2TrackerGeomDetUnit *pixdet, const GlobalVector &bfield)

virtual void	digitize (const Phase2TrackerGeomDetUnit pixdet, std::map< int, digitizerUtility::DigiSimInfo > &digi_map, const TrackerTopology tTopo)

virtual void	initializeEvent (CLHEP::HepRandomEngine &eng)

void	loadAccumulator (uint32_t detId, const std::map< int, float > &accumulator)

	Phase2TrackerDigitizerAlgorithm (const edm::ParameterSet &conf_common, const edm::ParameterSet &conf_specific, edm::ConsumesCollector iC)

virtual	~Phase2TrackerDigitizerAlgorithm ()

Private Types
enum	{ SquareWindow, SampledMode, LatchedMode, SampledOrLachedMode, HIPFindingMode }

Private Member Functions
double	cbc3PulsePolarExpansion (double x) const

double	getSignalScale (double xval) const

void	module_killing_DB (const Phase2TrackerGeomDetUnit *pixdet) override

bool	select_hit_latchedMode (const PSimHit &hit, double tCorr, double &sigScale) const

bool	select_hit_sampledMode (const PSimHit &hit, double tCorr, double &sigScale) const

double	signalShape (double x) const

void	storeSignalShape ()

Private Attributes
const SiStripBadStrip *	badChannelPayload_

edm::ESGetToken< SiStripBadStrip, SiPhase2OuterTrackerBadStripRcd >	badChannelToken_

float	deadTime_

const edm::ESGetToken< TrackerGeometry, TrackerDigiGeometryRecord >	geomToken_

int	hitDetectionMode_

std::vector< double >	pulseShapeParameters_

std::vector< double >	pulseShapeVec_

edm::ESGetToken< SiPhase2OuterTrackerLorentzAngle, SiPhase2OuterTrackerLorentzAngleSimRcd >	siPhase2OTLorentzAngleToken_

Static Private Attributes
static constexpr float	bx_time {25}

static constexpr size_t	interpolationPoints {1000}

static constexpr int	interpolationStep {10}

Additional Inherited Members
Protected Types inherited from Phase2TrackerDigitizerAlgorithm
using	Frame = GloballyPositioned< double >

using	Parameters = std::vector< edm::ParameterSet >

using	signal_map_type = std::map< int, digitizerUtility::Ph2Amplitude, std::less< int > >

using	signalMaps = std::map< uint32_t, signal_map_type >

Protected Member Functions inherited from Phase2TrackerDigitizerAlgorithm
virtual void	add_cross_talk (const Phase2TrackerGeomDetUnit *pixdet)

virtual void	add_noise (const Phase2TrackerGeomDetUnit *pixdet)

virtual void	add_noisy_cells (const Phase2TrackerGeomDetUnit *pixdet, float thePixelThreshold)

float	calcQ (float x)

int	convertSignalToAdc (uint32_t detID, float signal_in_elec, float threshold)

virtual std::vector< digitizerUtility::SignalPoint >	drift (const PSimHit &hit, const Phase2TrackerGeomDetUnit *pixdet, const GlobalVector &bfield, const std::vector< digitizerUtility::EnergyDepositUnit > &ionization_points) const

LocalVector	driftDirection (const Phase2TrackerGeomDetUnit *pixdet, const GlobalVector &bfield, const DetId &detId) const

virtual std::vector< float >	fluctuateEloss (int particleId, float momentum, float eloss, float length, int NumberOfSegments) const

virtual void	induce_signal (std::vector< PSimHit >::const_iterator inputBegin, const PSimHit &hit, const size_t hitIndex, const size_t firstHitIndex, const uint32_t tofBin, const Phase2TrackerGeomDetUnit *pixdet, const std::vector< digitizerUtility::SignalPoint > &collection_points)

virtual void	module_killing_conf (uint32_t detID)

virtual void	pixel_inefficiency (const SubdetEfficiencies &eff, const Phase2TrackerGeomDetUnit pixdet, const TrackerTopology tTopo)

virtual void	pixel_inefficiency_db (uint32_t detID)

virtual std::vector< digitizerUtility::EnergyDepositUnit >	primary_ionization (const PSimHit &hit) const

Protected Attributes inherited from Phase2TrackerDigitizerAlgorithm
signalMaps	_signal

const bool	addNoise_

const bool	addNoisyPixels_

const bool	addPixelInefficiency_

const bool	addThresholdSmearing_

const bool	addXtalk_

const bool	alpha2Order_

Parameters	badPixels_

const float	clusterWidth_

const Parameters	deadModules_

const std::unique_ptr< SiG4UniversalFluctuation >	fluctuate_

const bool	fluctuateCharge_

std::unique_ptr< CLHEP::RandGaussQ >	gaussDistribution_

const TrackerGeometry *	geom_

const float	GeVperElectron_

const float	interstripCoupling_

const bool	makeDigiSimLinks_

bool	pixelFlag_

const double	pseudoRadDamage_

const double	pseudoRadDamageRadius_

CLHEP::HepRandomEngine *	rengine_

const float	Sigma0_

const float	SigmaCoeff_

const SiPhase2OuterTrackerLorentzAngle *	siPhase2OTLorentzAngle_

const SiPixelQuality *	siPixelBadModule_

const SiPixelLorentzAngle *	siPixelLorentzAngle_

std::unique_ptr< CLHEP::RandGaussQ >	smearedThreshold_Barrel_

std::unique_ptr< CLHEP::RandGaussQ >	smearedThreshold_Endcap_

const SubdetEfficiencies	subdetEfficiencies_

const float	tanLorentzAnglePerTesla_Barrel_

const float	tanLorentzAnglePerTesla_Endcap_

const int	theAdcFullScale_

const float	theElectronPerADC_

const double	theHIPThresholdInE_Barrel_

const double	theHIPThresholdInE_Endcap_

const float	theNoiseInElectrons_

const std::unique_ptr< GaussianTailNoiseGenerator >	theNoiser_

const int	thePhase2ReadoutMode_

const float	theReadoutNoise_

const std::unique_ptr< SiPixelChargeReweightingAlgorithm >	theSiPixelChargeReweightingAlgorithm_

const std::unique_ptr< SiPixelGainCalibrationOfflineSimService >	theSiPixelGainCalibrationService_

const float	theThresholdInE_Barrel_

const float	theThresholdInE_Endcap_

const double	theThresholdSmearing_Barrel_

const double	theThresholdSmearing_Endcap_

const float	theTofLowerCut_

const float	theTofUpperCut_

const double	tMax_

const bool	use_deadmodule_DB_

const bool	use_ineff_from_db_

const bool	use_LorentzAngle_DB_

const bool	use_module_killing_

const bool	useChargeReweighting_

Detailed Description

Definition at line 10 of file SSDigitizerAlgorithm.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
SquareWindow
SampledMode
LatchedMode
SampledOrLachedMode
HIPFindingMode

Definition at line 22 of file SSDigitizerAlgorithm.h.

22 { SquareWindow, SampledMode, LatchedMode, SampledOrLachedMode, HIPFindingMode };

SSDigitizerAlgorithm::LatchedMode

Definition: SSDigitizerAlgorithm.h:22

SSDigitizerAlgorithm::SquareWindow

Definition: SSDigitizerAlgorithm.h:22

SSDigitizerAlgorithm::SampledMode

Definition: SSDigitizerAlgorithm.h:22

SSDigitizerAlgorithm::HIPFindingMode

Definition: SSDigitizerAlgorithm.h:22

SSDigitizerAlgorithm::SampledOrLachedMode

Definition: SSDigitizerAlgorithm.h:22

Constructor & Destructor Documentation

◆ SSDigitizerAlgorithm()

SSDigitizerAlgorithm::SSDigitizerAlgorithm	(	const edm::ParameterSet &	conf,
		edm::ConsumesCollector	iC
	)

Definition at line 40 of file SSDigitizerAlgorithm.cc.

     : Phase2TrackerDigitizerAlgorithm(conf.getParameter<ParameterSet>("AlgorithmCommon"),
                                       conf.getParameter<ParameterSet>("SSDigitizerAlgorithm"),
                                       iC),
       hitDetectionMode_(conf.getParameter<ParameterSet>("SSDigitizerAlgorithm").getParameter<int>("HitDetectionMode")),
       pulseShapeParameters_(conf.getParameter<ParameterSet>("SSDigitizerAlgorithm")
                                 .getParameter<std::vector<double> >("PulseShapeParameters")),
       deadTime_(conf.getParameter<ParameterSet>("SSDigitizerAlgorithm").getParameter<double>("CBCDeadTime")),
       geomToken_(iC.esConsumes()) {
   if (use_LorentzAngle_DB_)
     siPhase2OTLorentzAngleToken_ = iC.esConsumes();
 
   if (use_deadmodule_DB_) {
     std::string badChannelLabel_ = conf.getParameter<ParameterSet>("SSDigitizerAlgorithm")
                                        .getUntrackedParameter<std::string>("BadChannelLabel", "");
     badChannelToken_ = iC.esConsumes(edm::ESInputTag{"", badChannelLabel_});
   }
 
   pixelFlag_ = false;
   LogDebug("SSDigitizerAlgorithm ") << "SSDigitizerAlgorithm constructed "
                                     << "Configuration parameters:"
                                     << "Threshold/Gain = "
                                     << "threshold in electron Endcap = " << theThresholdInE_Endcap_
                                     << "threshold in electron Barrel = " << theThresholdInE_Barrel_ << " "
                                     << theElectronPerADC_ << " " << theAdcFullScale_ << " The delta cut-off is set to "
                                     << tMax_ << " pix-inefficiency " << addPixelInefficiency_;
   storeSignalShape();
 }

◆ ~SSDigitizerAlgorithm()

SSDigitizerAlgorithm::~SSDigitizerAlgorithm ( )

override

Definition at line 68 of file SSDigitizerAlgorithm.cc.

References LogDebug.

68 { LogDebug("SSDigitizerAlgorithm") << "SSDigitizerAlgorithm deleted"; }

LogDebug

#define LogDebug(id)

Definition: MessageLogger.h:241

Member Function Documentation

◆ cbc3PulsePolarExpansion()

double SSDigitizerAlgorithm::cbc3PulsePolarExpansion ( double x ) const

private

Definition at line 124 of file SSDigitizerAlgorithm.cc.

References funct::cos(), hcaldqm::quantity::fN, mps_fire::i, dqmiolumiharvest::j, conifer::pow(), pulseShapeParameters_, alignCSCRings::r, funct::sin(), theta(), x, and geometryCSVtoXML::xx.

Referenced by signalShape().

                                                                    {
   constexpr size_t max_par = 6;
   if (pulseShapeParameters_.size() < max_par)
     return -1;
   double xOffset = pulseShapeParameters_[0];
   double tau = pulseShapeParameters_[1];
   double r = pulseShapeParameters_[2];
   double theta = pulseShapeParameters_[3];
   int nTerms = static_cast<int>(pulseShapeParameters_[4]);
 
   double fN = 0;
   double xx = x - xOffset;
   if (xx < 0)
     return 0;
 
   for (int i = 0; i < nTerms; i++) {
     double angularTerm = 0;
     double temporalTerm = 0;
     double rTerm = std::pow(r, i) / (std::pow(tau, 2. * i) * ::nFactorial(i + 2));
     for (int j = 0; j <= i; j++) {
       angularTerm += std::pow(std::cos(theta), (double)(i - j)) * std::pow(std::sin(theta), (double)j);
       temporalTerm += ::aScalingConstant(i, j) * std::pow(xx, (double)(i - j)) * std::pow(tau, (double)j);
     }
     double fi = rTerm * angularTerm * temporalTerm;
 
     fN += fi;
   }
   return fN;
 }

◆ getSignalScale()

double SSDigitizerAlgorithm::getSignalScale ( double xval ) const

private

Definition at line 168 of file SSDigitizerAlgorithm.cc.

References reco::ceil(), mps_fire::i, interpolationStep, pulseShapeVec_, heppy_batch::val, and makeMEIFBenchmarkPlots::xval.

Referenced by select_hit_latchedMode(), and select_hit_sampledMode().

                                                              {
   double res = 0.0;
   int len = pulseShapeVec_.size();
 
   if (xval < 0.0 || xval * interpolationStep >= len)
     return res;
 
   unsigned int lower = std::floor(xval) * interpolationStep;
   unsigned int upper = std::ceil(xval) * interpolationStep;
   for (size_t i = lower + 1; i < upper * interpolationStep; i++) {
     float val = i * 0.1;
     if (val > xval) {
       res = pulseShapeVec_[i - 1];
       break;
     }
   }
   return res;
 }

◆ init()

void SSDigitizerAlgorithm::init ( const edm::EventSetup & es )

overridevirtual

Implements Phase2TrackerDigitizerAlgorithm.

Definition at line 30 of file SSDigitizerAlgorithm.cc.

References edm::EventSetup::getData().

                                                        {
   if (use_LorentzAngle_DB_)  // Get Lorentz angle from DB record
     siPhase2OTLorentzAngle_ = &es.getData(siPhase2OTLorentzAngleToken_);
 
   if (use_deadmodule_DB_)  // Get Bad Channel (SiStripBadStrip) from DB
     badChannelPayload_ = &es.getData(badChannelToken_);
 
   geom_ = &es.getData(geomToken_);
 }

◆ isAboveThreshold()

bool SSDigitizerAlgorithm::isAboveThreshold	(	const digitizerUtility::SimHitInfo *	hitInfo,
		float	charge,
		float	thr
	)		const

overridevirtual

Reimplemented from Phase2TrackerDigitizerAlgorithm.

Definition at line 189 of file SSDigitizerAlgorithm.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge.

                                                              {
   return (charge >= thr);
 }

◆ module_killing_DB()

void SSDigitizerAlgorithm::module_killing_DB ( const Phase2TrackerGeomDetUnit * pixdet )

overrideprivatevirtual

Implements Phase2TrackerDigitizerAlgorithm.

Definition at line 197 of file SSDigitizerAlgorithm.cc.

References Phase2TrackerDigitizerAlgorithm::_signal, badChannelPayload_, SiStripBadStrip::decodePhase2(), hcalRecHitTable_cff::detId, SiStripBadStrip::data::firstStrip, cms::cuda::for(), GeomDet::geographicalId(), SiStripBadStrip::getRange(), FastTimerService_cff::range, SiStripBadStrip::data::range, DetId::rawId(), and alignCSCRings::s.

                                                                                    {
   uint32_t detId = pixdet->geographicalId().rawId();
 
   signal_map_type& theSignal = _signal[detId];
   signal_map_type signalNew;
 
   SiStripBadStrip::Range range = badChannelPayload_->getRange(detId);
   for (std::vector<unsigned int>::const_iterator badChannel = range.first; badChannel != range.second; ++badChannel) {
     const auto& firstStrip = badChannelPayload_->decodePhase2(*badChannel).firstStrip;
     const auto& channelRange = badChannelPayload_->decodePhase2(*badChannel).range;
 
     for (int index = 0; index < channelRange; index++) {
       for (auto& s : theSignal) {
         auto& channel = s.first;
         if (channel == firstStrip + index)
           s.second.set(0.);
       }
     }
   }
 }

◆ select_hit()

bool SSDigitizerAlgorithm::select_hit	(	const PSimHit &	hit,
		double	tCorr,
		double &	sigScale
	)		const

overridevirtual

Reimplemented from Phase2TrackerDigitizerAlgorithm.

Definition at line 72 of file SSDigitizerAlgorithm.cc.

References hitDetectionMode_, LatchedMode, mps_fire::result, SampledMode, select_hit_latchedMode(), select_hit_sampledMode(), Phase2TrackerDigitizerAlgorithm::theTofLowerCut_, and Phase2TrackerDigitizerAlgorithm::theTofUpperCut_.

                                                                                               {
   bool result = false;
   if (hitDetectionMode_ == SSDigitizerAlgorithm::SampledMode)
     result = select_hit_sampledMode(hit, tCorr, sigScale);
   else if (hitDetectionMode_ == SSDigitizerAlgorithm::LatchedMode)
     result = select_hit_latchedMode(hit, tCorr, sigScale);
   else {
     double toa = hit.tof() - tCorr;
     result = (toa > theTofLowerCut_ && toa < theTofUpperCut_);
   }
   return result;
 }

◆ select_hit_latchedMode()

bool SSDigitizerAlgorithm::select_hit_latchedMode	(	const PSimHit &	hit,
		double	tCorr,
		double &	sigScale
	)		const

private

Definition at line 101 of file SSDigitizerAlgorithm.cc.

References bx_time, deadTime_, getSignalScale(), Phase2TrackerDigitizerAlgorithm::GeVperElectron_, mps_fire::i, DetId::subdetId(), Phase2TrackerDigitizerAlgorithm::theThresholdInE_Barrel_, Phase2TrackerDigitizerAlgorithm::theThresholdInE_Endcap_, and StripSubdetector::TOB.

Referenced by select_hit().

                                                                                                           {
   float toa = hit.tof() - tCorr;
   toa -= hit.eventId().bunchCrossing() * bx_time;
 
   float sampling_time = (-1) * (hit.eventId().bunchCrossing() + 1) * bx_time;
 
   DetId det_id = DetId(hit.detUnitId());
   float theThresholdInE =
       (det_id.subdetId() == StripSubdetector::TOB) ? theThresholdInE_Barrel_ : theThresholdInE_Endcap_;
 
   bool lastPulse = true;
   bool aboveThr = false;
   for (float i = deadTime_; i <= bx_time; i++) {
     sigScale = getSignalScale(sampling_time - toa + i);
 
     aboveThr = (sigScale * hit.energyLoss() / GeVperElectron_ > theThresholdInE);
     if (!lastPulse && aboveThr)
       return true;
 
     lastPulse = aboveThr;
   }
   return false;
 }

◆ select_hit_sampledMode()

bool SSDigitizerAlgorithm::select_hit_sampledMode	(	const PSimHit &	hit,
		double	tCorr,
		double &	sigScale
	)		const

private

Definition at line 87 of file SSDigitizerAlgorithm.cc.

References bx_time, getSignalScale(), Phase2TrackerDigitizerAlgorithm::GeVperElectron_, DetId::subdetId(), Phase2TrackerDigitizerAlgorithm::theThresholdInE_Barrel_, Phase2TrackerDigitizerAlgorithm::theThresholdInE_Endcap_, and StripSubdetector::TOB.

Referenced by select_hit().

                                                                                                           {
   double toa = hit.tof() - tCorr;
   double sampling_time = bx_time;
 
   DetId det_id = DetId(hit.detUnitId());
   float theThresholdInE =
       (det_id.subdetId() == StripSubdetector::TOB) ? theThresholdInE_Barrel_ : theThresholdInE_Endcap_;
 
   sigScale = getSignalScale(sampling_time - toa);
   return (sigScale * hit.energyLoss() / GeVperElectron_ > theThresholdInE);
 }

◆ signalShape()

double SSDigitizerAlgorithm::signalShape ( double x ) const

private

Definition at line 153 of file SSDigitizerAlgorithm.cc.

References cbc3PulsePolarExpansion(), JetChargeProducer_cfi::exp, conifer::pow(), pulseShapeParameters_, x, and geometryCSVtoXML::xx.

Referenced by storeSignalShape().

                                                        {
   double xOffset = pulseShapeParameters_[0];
   double tau = pulseShapeParameters_[1];
   double maxCharge = pulseShapeParameters_[5];
 
   double xx = x - xOffset;
   return maxCharge * (std::exp(-xx / tau) * std::pow(xx / tau, 2.) * cbc3PulsePolarExpansion(x));
 }

◆ storeSignalShape()

void SSDigitizerAlgorithm::storeSignalShape ( )

private

Definition at line 161 of file SSDigitizerAlgorithm.cc.

References mps_fire::i, interpolationPoints, interpolationStep, pulseShapeVec_, signalShape(), and heppy_batch::val.

Referenced by SSDigitizerAlgorithm().

                                             {
   for (size_t i = 0; i < interpolationPoints; i++) {
     float val = i / interpolationStep;
 
     pulseShapeVec_.push_back(signalShape(val));
   }
 }

Member Data Documentation

◆ badChannelPayload_

const SiStripBadStrip* SSDigitizerAlgorithm::badChannelPayload_

private

Definition at line 41 of file SSDigitizerAlgorithm.h.

Referenced by module_killing_DB().

◆ badChannelToken_

edm::ESGetToken<SiStripBadStrip, SiPhase2OuterTrackerBadStripRcd> SSDigitizerAlgorithm::badChannelToken_

private

Definition at line 40 of file SSDigitizerAlgorithm.h.

Referenced by SSDigitizerAlgorithm().

◆ bx_time

constexpr float SSDigitizerAlgorithm::bx_time {25}

staticprivate

Definition at line 37 of file SSDigitizerAlgorithm.h.

Referenced by select_hit_latchedMode(), and select_hit_sampledMode().

◆ deadTime_

float SSDigitizerAlgorithm::deadTime_

private

Definition at line 34 of file SSDigitizerAlgorithm.h.

Referenced by select_hit_latchedMode().

◆ geomToken_

const edm::ESGetToken<TrackerGeometry, TrackerDigiGeometryRecord> SSDigitizerAlgorithm::geomToken_

private

Definition at line 36 of file SSDigitizerAlgorithm.h.

◆ hitDetectionMode_

int SSDigitizerAlgorithm::hitDetectionMode_

private

Definition at line 31 of file SSDigitizerAlgorithm.h.

Referenced by select_hit().

◆ interpolationPoints

constexpr size_t SSDigitizerAlgorithm::interpolationPoints {1000}

staticprivate

Definition at line 38 of file SSDigitizerAlgorithm.h.

Referenced by storeSignalShape().

◆ interpolationStep

constexpr int SSDigitizerAlgorithm::interpolationStep {10}

staticprivate

Definition at line 39 of file SSDigitizerAlgorithm.h.

Referenced by getSignalScale(), and storeSignalShape().

◆ pulseShapeParameters_

std::vector<double> SSDigitizerAlgorithm::pulseShapeParameters_

private

Definition at line 33 of file SSDigitizerAlgorithm.h.

Referenced by cbc3PulsePolarExpansion(), and signalShape().

◆ pulseShapeVec_

std::vector<double> SSDigitizerAlgorithm::pulseShapeVec_

private

Definition at line 32 of file SSDigitizerAlgorithm.h.

Referenced by getSignalScale(), and storeSignalShape().

◆ siPhase2OTLorentzAngleToken_

edm::ESGetToken<SiPhase2OuterTrackerLorentzAngle, SiPhase2OuterTrackerLorentzAngleSimRcd> SSDigitizerAlgorithm::siPhase2OTLorentzAngleToken_

private

Definition at line 35 of file SSDigitizerAlgorithm.h.

Referenced by SSDigitizerAlgorithm().

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SSDigitizerAlgorithm()

◆ ~SSDigitizerAlgorithm()

Member Function Documentation

◆ cbc3PulsePolarExpansion()

◆ getSignalScale()

◆ init()

◆ isAboveThreshold()

◆ module_killing_DB()

◆ select_hit()

◆ select_hit_latchedMode()

◆ select_hit_sampledMode()

◆ signalShape()

◆ storeSignalShape()

Member Data Documentation

◆ badChannelPayload_

◆ badChannelToken_

◆ bx_time

◆ deadTime_

◆ geomToken_

◆ hitDetectionMode_

◆ interpolationPoints

◆ interpolationStep

◆ pulseShapeParameters_

◆ pulseShapeVec_

◆ siPhase2OTLorentzAngleToken_