#include <SSDigitizerAlgorithm.h>

Inheritance diagram for SSDigitizerAlgorithm:

Public Member Functions
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) override

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

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

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

	SSDigitizerAlgorithm (const edm::ParameterSet &conf)

	~SSDigitizerAlgorithm () override

Public Member Functions inherited from Phase2TrackerDigitizerAlgorithm
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)

virtual	~Phase2TrackerDigitizerAlgorithm ()

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

Private Member Functions
double	aScalingConstant (int N, int i)

double	cbc3PulsePolarExpansion (double x)

double	getSignalScale (double xval)

double	nFactorial (int n)

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

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

double	signalShape (double x)

void	storeSignalShape ()

Private Attributes
float	deadTime_

int	hitDetectionMode_

std::vector< double >	pulseShapeParameters_

std::vector< double >	pulseShapeVec_

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::Amplitude, 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)

double	calcQ (float x) const

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

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

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

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

void	induce_signal (const PSimHit &hit, const size_t hitIndex, const uint32_t tofBin, const Phase2TrackerGeomDetUnit *pixdet, const std::vector< DigitizerUtility::SignalPoint > &collection_points)

virtual void	module_killing_conf (uint32_t detID)

virtual void	module_killing_DB (const Phase2TrackerGeomDetUnit *pixdet)

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

virtual void	pixel_inefficiency_db (uint32_t detID)

void	primary_ionization (const PSimHit &hit, std::vector< DigitizerUtility::EnergyDepositUnit > &ionization_points) 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_

edm::ESHandle< SiPixelFedCablingMap >	fedCablingMap_

const std::unique_ptr< SiG4UniversalFluctuation >	fluctuate_

const bool	fluctuateCharge_

std::unique_ptr< CLHEP::RandGaussQ >	gaussDistribution_

edm::ESHandle< 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_

edm::ESHandle< SiPixelQuality >	SiPixelBadModule_

edm::ESHandle< 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< 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_

Detailed Description

Definition at line 6 of file SSDigitizerAlgorithm.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
SquareWindow
SampledMode
LatchedMode
SampledOrLachedMode
HIPFindingMode

Definition at line 25 of file SSDigitizerAlgorithm.h.

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

Constructor & Destructor Documentation

◆ SSDigitizerAlgorithm()

SSDigitizerAlgorithm::SSDigitizerAlgorithm ( const edm::ParameterSet & conf )

Definition at line 18 of file SSDigitizerAlgorithm.cc.

     : Phase2TrackerDigitizerAlgorithm(conf.getParameter<ParameterSet>("AlgorithmCommon"),
                                       conf.getParameter<ParameterSet>("SSDigitizerAlgorithm")),
       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")) {
   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();
 }

References Phase2TrackerDigitizerAlgorithm::addPixelInefficiency_, LogDebug, Phase2TrackerDigitizerAlgorithm::pixelFlag_, storeSignalShape(), Phase2TrackerDigitizerAlgorithm::theAdcFullScale_, Phase2TrackerDigitizerAlgorithm::theElectronPerADC_, Phase2TrackerDigitizerAlgorithm::theThresholdInE_Barrel_, Phase2TrackerDigitizerAlgorithm::theThresholdInE_Endcap_, and Phase2TrackerDigitizerAlgorithm::tMax_.

◆ ~SSDigitizerAlgorithm()

SSDigitizerAlgorithm::~SSDigitizerAlgorithm ( )

override

Definition at line 35 of file SSDigitizerAlgorithm.cc.

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

References LogDebug.

Member Function Documentation

◆ accumulateSimHits()

void SSDigitizerAlgorithm::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
	)

overridevirtual

Implements Phase2TrackerDigitizerAlgorithm.

Definition at line 36 of file SSDigitizerAlgorithm.cc.

                                                                          {
   // produce SignalPoint's for all SimHit's in detector
   // Loop over hits
   uint32_t detId = pixdet->geographicalId().rawId();
   size_t simHitGlobalIndex = inputBeginGlobalIndex;  // This needs to be stored to create the digi-sim link later
  
   // find the relevant hits
   std::vector<PSimHit> matchedSimHits;
   std::copy_if(inputBegin, inputEnd, std::back_inserter(matchedSimHits), [detId](auto const& hit) -> bool {
     return hit.detUnitId() == detId;
   });
   // loop over a much reduced set of SimHits
   for (auto const& hit : matchedSimHits) {
     LogDebug("SSDigitizerAlgorithm") << hit.particleType() << " " << hit.pabs() << " " << hit.energyLoss() << " "
                                      << hit.tof() << " " << hit.trackId() << " " << hit.processType() << " "
                                      << hit.detUnitId() << hit.entryPoint() << " " << hit.exitPoint();
  
     std::vector<DigitizerUtility::EnergyDepositUnit> ionization_points;
     std::vector<DigitizerUtility::SignalPoint> collection_points;
  
     double signalScale = 1.0;
     // fill collection_points for this SimHit, indpendent of topology
     if (select_hit(hit, (pixdet->surface().toGlobal(hit.localPosition()).mag() * c_inv), signalScale)) {
       primary_ionization(hit, ionization_points);  // fills ionization_points
  
       // transforms ionization_points -> collection_points
       drift(hit, pixdet, bfield, ionization_points, collection_points);
  
       // compute induced signal on readout elements and add to _signal
       // hit needed only for SimHit<-->Digi link
       induce_signal(hit, simHitGlobalIndex, tofBin, pixdet, collection_points);
     }
     ++simHitGlobalIndex;
   }
 }

References c_inv, Phase2TrackerDigitizerAlgorithm::drift(), GeomDet::geographicalId(), Phase2TrackerDigitizerAlgorithm::induce_signal(), LogDebug, mag(), Phase2TrackerDigitizerAlgorithm::primary_ionization(), DetId::rawId(), select_hit(), GeomDet::surface(), and Surface::toGlobal().

◆ aScalingConstant()

double SSDigitizerAlgorithm::aScalingConstant	(	int	N,
		int	i
	)

private

Definition at line 133 of file SSDigitizerAlgorithm.cc.

                                                           {
   return std::pow(-1, (double)i) * nFactorial(N) * nFactorial(N + 2) /
          (nFactorial(N - i) * nFactorial(N + 2 - i) * nFactorial(i));
 }

References mps_fire::i, N, nFactorial(), and funct::pow().

Referenced by cbc3PulsePolarExpansion().

◆ cbc3PulsePolarExpansion()

double SSDigitizerAlgorithm::cbc3PulsePolarExpansion ( double x )

private

Definition at line 137 of file SSDigitizerAlgorithm.cc.

                                                              {
   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;
 }

References aScalingConstant(), funct::cos(), hcaldqm::quantity::fN, mps_fire::i, dqmiolumiharvest::j, nFactorial(), funct::pow(), pulseShapeParameters_, alignCSCRings::r, funct::sin(), metsig::tau, theta(), x, phase1PixelTopology::xOffset, and geometryCSVtoXML::xx.

Referenced by signalShape().

◆ getSignalScale()

double SSDigitizerAlgorithm::getSignalScale ( double xval )

private

Definition at line 181 of file SSDigitizerAlgorithm.cc.

                                                        {
   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;
 }

References reco::ceil(), mps_fire::i, interpolationStep, pulseShapeVec_, pileupCalc::upper, and heppy_batch::val.

Referenced by select_hit_latchedMode(), and select_hit_sampledMode().

◆ init()

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

overridevirtual

Implements Phase2TrackerDigitizerAlgorithm.

Definition at line 17 of file SSDigitizerAlgorithm.cc.

17 { es.get<TrackerDigiGeometryRecord>().get(geom_); }

References edm::EventSetup::get(), and edm::get().

◆ isAboveThreshold()

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

overridevirtual

Reimplemented from Phase2TrackerDigitizerAlgorithm.

Definition at line 202 of file SSDigitizerAlgorithm.cc.

                                                        {
   return (charge >= thr);
 }

References ALCARECOTkAlJpsiMuMu_cff::charge.

◆ nFactorial()

double SSDigitizerAlgorithm::nFactorial ( int n )

private

Definition at line 132 of file SSDigitizerAlgorithm.cc.

132 { return std::tgamma(n + 1); }

References dqmiodumpmetadata::n.

Referenced by aScalingConstant(), and cbc3PulsePolarExpansion().

◆ select_hit()

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

overridevirtual

Reimplemented from Phase2TrackerDigitizerAlgorithm.

Definition at line 79 of file SSDigitizerAlgorithm.cc.

                                                                                         {
   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;
 }

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

Referenced by accumulateSimHits().

◆ select_hit_latchedMode()

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

private

Definition at line 108 of file SSDigitizerAlgorithm.cc.

                                                                                                     {
   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;
 }

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().

◆ select_hit_sampledMode()

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

private

Definition at line 94 of file SSDigitizerAlgorithm.cc.

                                                                                                     {
   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);
 }

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

Referenced by select_hit().

◆ signalShape()

double SSDigitizerAlgorithm::signalShape ( double x )

private

Definition at line 166 of file SSDigitizerAlgorithm.cc.

                                                  {
   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));
 }

References cbc3PulsePolarExpansion(), JetChargeProducer_cfi::exp, funct::pow(), pulseShapeParameters_, metsig::tau, x, phase1PixelTopology::xOffset, and geometryCSVtoXML::xx.

Referenced by storeSignalShape().

◆ storeSignalShape()

void SSDigitizerAlgorithm::storeSignalShape ( )

private

Definition at line 174 of file SSDigitizerAlgorithm.cc.

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

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

Referenced by SSDigitizerAlgorithm().

Member Data Documentation

◆ bx_time

constexpr float SSDigitizerAlgorithm::bx_time {25}

staticconstexprprivate

Definition at line 39 of file SSDigitizerAlgorithm.h.

Referenced by select_hit_latchedMode(), and select_hit_sampledMode().

◆ deadTime_

float SSDigitizerAlgorithm::deadTime_

private

Definition at line 38 of file SSDigitizerAlgorithm.h.

Referenced by select_hit_latchedMode().

◆ hitDetectionMode_

int SSDigitizerAlgorithm::hitDetectionMode_

private

Definition at line 35 of file SSDigitizerAlgorithm.h.

Referenced by select_hit().

◆ interpolationPoints

constexpr size_t SSDigitizerAlgorithm::interpolationPoints {1000}

staticconstexprprivate

Definition at line 40 of file SSDigitizerAlgorithm.h.

Referenced by storeSignalShape().

◆ interpolationStep

constexpr int SSDigitizerAlgorithm::interpolationStep {10}

staticconstexprprivate

Definition at line 41 of file SSDigitizerAlgorithm.h.

Referenced by getSignalScale(), and storeSignalShape().

◆ pulseShapeParameters_

std::vector<double> SSDigitizerAlgorithm::pulseShapeParameters_

private

Definition at line 37 of file SSDigitizerAlgorithm.h.

Referenced by cbc3PulsePolarExpansion(), and signalShape().

◆ pulseShapeVec_

std::vector<double> SSDigitizerAlgorithm::pulseShapeVec_

private

Definition at line 36 of file SSDigitizerAlgorithm.h.

Referenced by getSignalScale(), and storeSignalShape().

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

◆ accumulateSimHits()

◆ aScalingConstant()

◆ cbc3PulsePolarExpansion()

◆ getSignalScale()

◆ init()

◆ isAboveThreshold()

◆ nFactorial()

◆ select_hit()

◆ select_hit_latchedMode()

◆ select_hit_sampledMode()

◆ signalShape()

◆ storeSignalShape()

Member Data Documentation

◆ bx_time

◆ deadTime_

◆ hitDetectionMode_

◆ interpolationPoints

◆ interpolationStep

◆ pulseShapeParameters_

◆ pulseShapeVec_