ECalSD Class Reference

#include <ECalSD.h>

Inheritance diagram for ECalSD:

Public Member Functions
	ECalSD (const std::string &, const EcalSimulationParameters *, const SensitiveDetectorCatalog &, edm::ParameterSet const &p, const SimTrackManager *)
uint32_t	setDetUnitId (const G4Step *) override
void	setNumberingScheme (EcalNumberingScheme *)
	~ECalSD () override
Public Member Functions inherited from CaloSD
	CaloSD (const std::string &aSDname, const SensitiveDetectorCatalog &clg, edm::ParameterSet const &p, const SimTrackManager *, float timeSlice=1., bool ignoreTkID=false)
void	clear () override
void	clearHits () override
void	DrawAll () override
void	EndOfEvent (G4HCofThisEvent *eventHC) override
void	fillHits (edm::PCaloHitContainer &, const std::string &) override
void	Initialize (G4HCofThisEvent *HCE) override
bool	isItFineCalo (const G4VTouchable *touch)
void	PrintAll () override
bool	ProcessHits (G4GFlashSpot *aSpot, G4TouchableHistory *) override
G4bool	ProcessHits (G4Step *step, G4TouchableHistory *) override
void	reset () override
	~CaloSD () override
Public Member Functions inherited from SensitiveCaloDetector
	SensitiveCaloDetector (const std::string &iname, const SensitiveDetectorCatalog &clg)
Public Member Functions inherited from SensitiveDetector
void	EndOfEvent (G4HCofThisEvent *eventHC) override
const std::vector< std::string > &	getNames () const
void	Initialize (G4HCofThisEvent *eventHC) override
bool	isCaloSD () const
	SensitiveDetector (const std::string &iname, const SensitiveDetectorCatalog &, bool calo)
	~SensitiveDetector () override
Public Member Functions inherited from Observer< const BeginOfRun * >
	Observer ()
void	slotForUpdate (const BeginOfRun * iT)
virtual	~Observer ()
Public Member Functions inherited from Observer< const BeginOfEvent * >
	Observer ()
void	slotForUpdate (const BeginOfEvent * iT)
virtual	~Observer ()
Public Member Functions inherited from Observer< const BeginOfTrack * >
	Observer ()
void	slotForUpdate (const BeginOfTrack * iT)
virtual	~Observer ()
Public Member Functions inherited from Observer< const EndOfTrack * >
	Observer ()
void	slotForUpdate (const EndOfTrack * iT)
virtual	~Observer ()
Public Member Functions inherited from Observer< const EndOfEvent * >
	Observer ()
void	slotForUpdate (const EndOfEvent * iT)
virtual	~Observer ()

Protected Member Functions
double	EnergyCorrected (const G4Step &, const G4Track *) override
uint16_t	getDepth (const G4Step *) override
double	getEnergyDeposit (const G4Step *) override
int	getTrackID (const G4Track *) override
Protected Member Functions inherited from CaloSD
bool	checkHit ()
CaloG4Hit *	createNewHit (const G4Step *, const G4Track *)
virtual void	endEvent ()
virtual bool	filterHit (CaloG4Hit *, double)
double	getAttenuation (const G4Step *aStep, double birk1, double birk2, double birk3) const
virtual bool	getFromLibrary (const G4Step *step)
int	getNumberOfHits ()
double	getResponseWt (const G4Track *)
void	hitBookkeepingFineCalo (const G4Step *step, const G4Track *currentTrack, CaloG4Hit *hit)
bool	hitExists (const G4Step *)
void	ignoreRejection ()
virtual void	initEvent (const BeginOfEvent *)
virtual void	initRun ()
void	printDetectorLevels (const G4VTouchable *) const
void	processHit (const G4Step *step)
void	resetForNewPrimary (const G4Step *)
void	setNumberCheckedHits (int val)
void	setParameterized (bool val)
G4ThreeVector	setToGlobal (const G4ThreeVector &, const G4VTouchable *) const
G4ThreeVector	setToLocal (const G4ThreeVector &, const G4VTouchable *) const
virtual int	setTrackID (const G4Step *)
void	setUseMap (bool val)
void	update (const ::EndOfEvent *) override
void	update (const BeginOfEvent *) override
	This routine will be called when the appropriate signal arrives. More...
void	update (const BeginOfRun *) override
	This routine will be called when the appropriate signal arrives. More...
void	update (const BeginOfTrack *trk) override
	This routine will be called when the appropriate signal arrives. More...
void	update (const EndOfTrack *trk) override
	This routine will be called when the appropriate signal arrives. More...
void	updateHit (CaloG4Hit *)
Protected Member Functions inherited from SensitiveDetector
TrackInformation *	cmsTrackInformation (const G4Track *aTrack)
Local3DPoint	ConvertToLocal3DPoint (const G4ThreeVector &point) const
Local3DPoint	FinalStepPosition (const G4Step *step, coordinates) const
Local3DPoint	InitialStepPosition (const G4Step *step, coordinates) const
Local3DPoint	LocalPostStepPosition (const G4Step *step) const
Local3DPoint	LocalPreStepPosition (const G4Step *step) const
void	NaNTrap (const G4Step *step) const
void	setNames (const std::vector< std::string > &)
Protected Member Functions inherited from Observer< const EndOfEvent * >
virtual void	update (const EndOfEvent *)=0
	This routine will be called when the appropriate signal arrives. More...

Private Member Functions
double	curve_LY (const G4LogicalVolume *)
void	getBaseNumber (const G4Step *)
double	getBirkL3 (const G4Step *)
uint16_t	getLayerIDForTimeSim ()
uint16_t	getRadiationLength (const G4StepPoint *hitPoint, const G4LogicalVolume *lv)
void	initMap ()
bool	isXtal (const G4LogicalVolume *)

Private Attributes
EnergyResolutionVsLumi	ageing
bool	ageingWithSlopeLY
double	birk1
double	birk2
double	birk3
double	birkCut
double	birkSlope
double	crystalDepth
double	crystalLength
std::string	crystalMat
G4ThreeVector	currentLocalPoint
uint16_t	depth
std::string	depth1Name
std::string	depth2Name
const EcalSimulationParameters *	ecalSimParameters_
std::vector< const G4LogicalVolume * >	noWeight
EcalNumberingScheme *	numberingScheme_
double	scaleRL
double	slopeLY
bool	storeLayerTimeSim
bool	storeRL
bool	storeTrack
EcalBaseNumber	theBaseNumber
bool	useBirk
bool	useBirkL3
std::vector< const G4LogicalVolume * >	useDepth1
std::vector< const G4LogicalVolume * >	useDepth2
bool	useWeight
std::map< const G4LogicalVolume *, double >	xtalLMap

Additional Inherited Members
Protected Types inherited from SensitiveDetector
enum	coordinates { WorldCoordinates, LocalCoordinates }
Static Protected Member Functions inherited from CaloSD
static std::string	printableDecayChain (const std::vector< unsigned int > &decayChain)
Protected Attributes inherited from CaloSD
CaloG4Hit *	currentHit
CaloHitID	currentID
float	edepositEM
float	edepositHAD
double	eminHit
double	energyCut
G4ThreeVector	entranceLocal
G4ThreeVector	entrancePoint
bool	forceSave
float	incidentEnergy
double	kmaxIon
double	kmaxNeutron
double	kmaxProton
G4ThreeVector	posGlobal
CaloHitID	previousID
bool	suppressHeavy
double	tmaxHit

Detailed Description

Definition at line 31 of file ECalSD.h.

Constructor & Destructor Documentation

ECalSD()

ECalSD::ECalSD	(	const std::string &	name,
		const EcalSimulationParameters *	ecpar,
		const SensitiveDetectorCatalog &	clg,
		edm::ParameterSet const &	p,
		const SimTrackManager *	manager
	)

Definition at line 41 of file ECalSD.cc.

    : CaloSD(name,
             clg,
             p,
             manager,
             (float)(p.getParameter<edm::ParameterSet>("ECalSD").getParameter<double>("TimeSliceUnit")),
             p.getParameter<edm::ParameterSet>("ECalSD").getParameter<bool>("IgnoreTrackID")),
      ecalSimParameters_(ecpar),
      numberingScheme_(nullptr) {
  //   static SimpleConfigurable<bool>   on1(false,  "ECalSD:UseBirkLaw");
  //   static SimpleConfigurable<double> bk1(0.00463,"ECalSD:BirkC1");
  //   static SimpleConfigurable<double> bk2(-0.03,  "ECalSD:BirkC2");
  //   static SimpleConfigurable<double> bk3(1.0,    "ECalSD:BirkC3");
  // Values from NIM A484 (2002) 239-244: as implemented in Geant3
  //   useBirk          = on1.value();
  //   birk1            = bk1.value()*(g/(MeV*cm2));
  //   birk2            = bk2.value()*(g/(MeV*cm2))*(g/(MeV*cm2));
  edm::ParameterSet m_EC = p.getParameter<edm::ParameterSet>("ECalSD");
  useBirk = m_EC.getParameter<bool>("UseBirkLaw");
  useBirkL3 = m_EC.getParameter<bool>("BirkL3Parametrization");
  double bunit = (CLHEP::g / (CLHEP::MeV * CLHEP::cm2));
  birk1 = m_EC.getParameter<double>("BirkC1") * bunit;
  birk2 = m_EC.getParameter<double>("BirkC2");
  birk3 = m_EC.getParameter<double>("BirkC3");
  birkSlope = m_EC.getParameter<double>("BirkSlope");
  birkCut = m_EC.getParameter<double>("BirkCut");
  slopeLY = m_EC.getParameter<double>("SlopeLightYield");
  storeTrack = m_EC.getParameter<bool>("StoreSecondary");
  crystalMat = m_EC.getUntrackedParameter<std::string>("XtalMat", "E_PbWO4");
  bool isItTB = m_EC.getUntrackedParameter<bool>("TestBeam", false);
  bool nullNS = m_EC.getUntrackedParameter<bool>("NullNumbering", false);
  storeRL = m_EC.getUntrackedParameter<bool>("StoreRadLength", false);
  scaleRL = m_EC.getUntrackedParameter<double>("ScaleRadLength", 1.0);
  int dumpGeom = m_EC.getUntrackedParameter<int>("DumpGeometry", 0);
 
  //Changes for improved timing simulation
  storeLayerTimeSim = m_EC.getUntrackedParameter<bool>("StoreLayerTimeSim", false);
 
  ageingWithSlopeLY = m_EC.getUntrackedParameter<bool>("AgeingWithSlopeLY", false);
  if (ageingWithSlopeLY)
    ageing.setLumies(p.getParameter<edm::ParameterSet>("ECalSD").getParameter<double>("DelivLuminosity"),
                     p.getParameter<edm::ParameterSet>("ECalSD").getParameter<double>("InstLuminosity"));
 
  if (ecalSimParameters_ == nullptr) {
    edm::LogError("EcalSim") << "ECalSD : Cannot find EcalSimulationParameters for " << name;
    throw cms::Exception("Unknown", "ECalSD") << "Cannot find EcalSimulationParameters for " << name << "\n";
  }
 
  // Use of Weight
  useWeight = ecalSimParameters_->useWeight_;
#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("EcalSim") << "ECalSD:: useWeight " << useWeight;
#endif
  depth1Name = ecalSimParameters_->depth1Name_;
  depth2Name = ecalSimParameters_->depth2Name_;
#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("EcalSim") << "Names (Depth 1):" << depth1Name << " (Depth 2):" << depth2Name << std::endl;
#endif
  int type(-1);
  bool dump(false);
  EcalNumberingScheme* scheme = nullptr;
  if (nullNS) {
    scheme = nullptr;
  } else if (name == "EcalHitsEB") {
    scheme = dynamic_cast<EcalNumberingScheme*>(new EcalBarrelNumberingScheme());
    type = 0;
    dump = ((dumpGeom % 10) > 0);
  } else if (name == "EcalHitsEE") {
    scheme = dynamic_cast<EcalNumberingScheme*>(new EcalEndcapNumberingScheme());
    type = 1;
    dump = (((dumpGeom / 10) % 10) > 0);
  } else if (name == "EcalHitsES") {
    if (isItTB)
      scheme = dynamic_cast<EcalNumberingScheme*>(new ESTBNumberingScheme());
    else
      scheme = dynamic_cast<EcalNumberingScheme*>(new EcalPreshowerNumberingScheme());
    useWeight = false;
    type = 2;
    dump = (((dumpGeom / 100) % 10) > 0);
  } else {
    edm::LogWarning("EcalSim") << "ECalSD: ReadoutName not supported";
  }
  int type0 = dumpGeom / 1000;
  type += (10 * type0);
 
  if (scheme)
    setNumberingScheme(scheme);
#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("EcalSim") << "Constructing a ECalSD  with name " << GetName();
#endif
  if (useWeight) {
    edm::LogVerbatim("EcalSim") << "ECalSD:: Use of Birks law is set to " << useBirk
                                << " with three constants kB = " << birk1 / bunit << ", C1 = " << birk2
                                << ", C2 = " << birk3 << "\n         Use of L3 parametrization " << useBirkL3
                                << " with slope " << birkSlope << " and cut off " << birkCut << "\n"
                                << "         Slope for Light yield is set to " << slopeLY;
  } else {
    edm::LogVerbatim("EcalSim") << "ECalSD:: energy deposit is not corrected "
                                << " by Birk or light yield curve";
  }
 
  edm::LogVerbatim("EcalSim") << "ECalSD:: Suppression Flag " << suppressHeavy << "\tprotons below "
                              << kmaxProton / CLHEP::MeV << " MeV,\tneutrons below " << kmaxNeutron / CLHEP::MeV
                              << " MeV,\tions below " << kmaxIon / CLHEP::MeV << " MeV \n\tDepth1 Name = " << depth1Name
                              << "\tDepth2 Name = " << depth2Name << "\n\tstoreRL " << storeRL << ":" << scaleRL
                              << "\tstoreLayerTimeSim " << storeLayerTimeSim << "\n\ttime Granularity "
                              << p.getParameter<edm::ParameterSet>("ECalSD").getParameter<double>("TimeSliceUnit")
                              << " ns";
  if (useWeight)
    initMap();
#ifdef plotDebug
  edm::Service<TFileService> tfile;
  if (tfile.isAvailable()) {
    TFileDirectory ecDir = tfile->mkdir("ProfileFromECalSD");
    static const std::string ctype[4] = {"EB", "EBref", "EE", "EERef"};
    for (int k = 0; k < 4; ++k) {
      std::string name = "ECLL_" + ctype[k];
      std::string title = "Local vs Global for " + ctype[k];
      double xmin = (k > 1) ? 3000.0 : 1000.0;
      g2L_[k] = ecDir.make<TH2F>(name.c_str(), title.c_str(), 100, xmin, xmin + 1000., 100, 0.0, 3000.);
    }
  } else {
    for (int k = 0; k < 4; ++k)
      g2L_[k] = 0;
  }
#endif
  if (dump) {
    const auto& lvNames = clg.logicalNames(name);
    EcalDumpGeometry geom(lvNames, depth1Name, depth2Name, type);
    geom.update();
  }
}

References ageing, ageingWithSlopeLY, birk1, birk2, birk3, birkCut, birkSlope, crystalMat, depth1Name, EcalSimulationParameters::depth1Name_, depth2Name, EcalSimulationParameters::depth2Name_, submitPVValidationJobs::dump, ecalSimParameters_, Exception, g, relativeConstraints::geom, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), initMap(), dqmdumpme::k, CaloSD::kmaxIon, CaloSD::kmaxNeutron, CaloSD::kmaxProton, SensitiveDetectorCatalog::logicalNames(), materialBudgetVolume_cfi::lvNames, TFileDirectory::make(), MeV, Skims_PA_cff::name, AlCaHLTBitMon_ParallelJobs::p, scaleRL, generator_cfi::scheme, EnergyResolutionVsLumi::setLumies(), setNumberingScheme(), slopeLY, storeLayerTimeSim, storeRL, storeTrack, AlCaHLTBitMon_QueryRunRegistry::string, CaloSD::suppressHeavy, compare::tfile, runGCPTkAlMap::title, useBirk, useBirkL3, useWeight, EcalSimulationParameters::useWeight_, and TrackerOfflineValidation_Dqm_cff::xmin.

~ECalSD()

ECalSD::~ECalSD ( )

override

Definition at line 178 of file ECalSD.cc.

{ delete numberingScheme_; }

References numberingScheme_.

Member Function Documentation

curve_LY()

double ECalSD::curve_LY ( const G4LogicalVolume *  lv )

private

Definition at line 429 of file ECalSD.cc.

                                                 {
  double weight = 1.;
  if (ageingWithSlopeLY) {
    //position along the crystal in mm from 0 to 230 (in EB)
    if (crystalDepth >= -0.1 || crystalDepth <= crystalLength + 0.1)
      weight = ageing.calcLightCollectionEfficiencyWeighted(currentID.unitID(), crystalDepth / crystalLength);
  } else {
    double dapd = crystalLength - crystalDepth;
    if (dapd >= -0.1 || dapd <= crystalLength + 0.1) {
      if (dapd <= 100.)
        weight = 1.0 + slopeLY - dapd * 0.01 * slopeLY;
    } else {
      edm::LogWarning("EcalSim") << "ECalSD: light coll curve : wrong distance "
                                 << "to APD " << dapd << " crlength = " << crystalLength << ":" << crystalDepth
                                 << " crystal name = " << lv->GetName() << " " << dd4hep::dd::noNamespace(lv->GetName())
                                 << " z of localPoint = " << currentLocalPoint.z() << " take weight = " << weight;
    }
  }
#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("EcalSim") << "ECalSD: light coll curve : crlength = " << crystalLength << " Depth " << crystalDepth
                              << " crystal name = " << lv->GetName() << " " << dd4hep::dd::noNamespace(lv->GetName())
                              << " z of localPoint = " << currentLocalPoint.z() << " take weight = " << weight;
#endif
  return weight;
}

References ageing, ageingWithSlopeLY, EnergyResolutionVsLumi::calcLightCollectionEfficiencyWeighted(), crystalDepth, crystalLength, CaloSD::currentID, currentLocalPoint, slopeLY, CaloHitID::unitID(), and mps_merge::weight.

Referenced by EnergyCorrected(), and getEnergyDeposit().

EnergyCorrected()

double ECalSD::EnergyCorrected ( const G4Step &  step, const G4Track *  track  )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 229 of file ECalSD.cc.

                                                                       {
  double edep = step.GetTotalEnergyDeposit();
  const G4StepPoint* hitPoint = step.GetPreStepPoint();
  const G4LogicalVolume* lv = hitPoint->GetTouchable()->GetVolume(0)->GetLogicalVolume();
 
  if (useWeight && !any(noWeight, lv)) {
    currentLocalPoint = setToLocal(hitPoint->GetPosition(), hitPoint->GetTouchable());
    auto ite = xtalLMap.find(lv);
    crystalLength = (ite == xtalLMap.end()) ? 230._mm : std::abs(ite->second);
    crystalDepth = (ite == xtalLMap.end()) ? 0.0 : (std::abs(0.5 * (ite->second) + currentLocalPoint.z()));
    edep *= curve_LY(lv) * getResponseWt(track);
  }
  return edep;
}

References funct::abs(), any(), crystalDepth, crystalLength, currentLocalPoint, curve_LY(), CaloSD::getResponseWt(), noWeight, CaloSD::setToLocal(), HLT_FULL_cff::track, useWeight, and xtalLMap.

getBaseNumber()

void ECalSD::getBaseNumber ( const G4Step *  aStep )

private

Definition at line 455 of file ECalSD.cc.

                                              {
  theBaseNumber.reset();
  const G4VTouchable* touch = aStep->GetPreStepPoint()->GetTouchable();
  int theSize = touch->GetHistoryDepth() + 1;
  if (theBaseNumber.getCapacity() < theSize)
    theBaseNumber.setSize(theSize);
  //Get name and copy numbers
  if (theSize > 1) {
    for (int ii = 0; ii < theSize; ii++) {
      std::string_view name = dd4hep::dd::noNamespace(touch->GetVolume(ii)->GetName());
      theBaseNumber.addLevel(std::string(name), touch->GetReplicaNumber(ii));
#ifdef EDM_ML_DEBUG
      edm::LogVerbatim("EcalSim") << "ECalSD::getBaseNumber(): Adding level " << ii << ": " << name << "["
                                  << touch->GetReplicaNumber(ii) << "]";
#endif
    }
  }
}

References EcalBaseNumber::addLevel(), EcalBaseNumber::getCapacity(), cuy::ii, Skims_PA_cff::name, EcalBaseNumber::reset(), EcalBaseNumber::setSize(), AlCaHLTBitMon_QueryRunRegistry::string, and theBaseNumber.

Referenced by setDetUnitId().

getBirkL3()

double ECalSD::getBirkL3 ( const G4Step *  aStep )

private

Definition at line 474 of file ECalSD.cc.

                                            {
  double weight = 1.;
  const G4StepPoint* preStepPoint = aStep->GetPreStepPoint();
  double charge = preStepPoint->GetCharge();
 
  if (charge != 0. && aStep->GetStepLength() > 0.) {
    const G4Material* mat = preStepPoint->GetMaterial();
    double density = mat->GetDensity();
    double dedx = aStep->GetTotalEnergyDeposit() / aStep->GetStepLength();
    double rkb = birk1 / density;
    if (dedx > 0) {
      weight = 1. - birkSlope * log(rkb * dedx);
      if (weight < birkCut)
        weight = birkCut;
      else if (weight > 1.)
        weight = 1.;
    }
#ifdef EDM_ML_DEBUG
    edm::LogVerbatim("EcalSim") << "ECalSD::getBirkL3 in " << dd4hep::dd::noNamespace(mat->GetName()) << " Charge "
                                << charge << " dE/dx " << dedx << " Birk Const " << rkb << " Weight = " << weight
                                << " dE " << aStep->GetTotalEnergyDeposit();
#endif
  }
  return weight;
}

References birk1, birkCut, birkSlope, ALCARECOTkAlJpsiMuMu_cff::charge, fastSimProducer_cff::density, dqm-mbProfile::log, and mps_merge::weight.

Referenced by getEnergyDeposit().

getDepth()

uint16_t ECalSD::getDepth ( const G4Step *  aStep )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 255 of file ECalSD.cc.

                                             {
  // this method should be called first at a step
  const G4StepPoint* hitPoint = aStep->GetPreStepPoint();
  currentLocalPoint = setToLocal(hitPoint->GetPosition(), hitPoint->GetTouchable());
  const G4LogicalVolume* lv = hitPoint->GetTouchable()->GetVolume(0)->GetLogicalVolume();
 
  auto ite = xtalLMap.find(lv);
  crystalLength = (ite == xtalLMap.end()) ? 230._mm : std::abs(ite->second);
  crystalDepth = (ite == xtalLMap.end()) ? 0.0 : (std::abs(0.5 * (ite->second) + currentLocalPoint.z()));
  depth = any(useDepth1, lv) ? 1 : (any(useDepth2, lv) ? 2 : 0);
  uint16_t depth1(0), depth2(0);
  if (storeRL) {
    depth1 = (ite == xtalLMap.end()) ? 0 : (((ite->second) >= 0) ? 0 : PCaloHit::kEcalDepthRefz);
    depth2 = getRadiationLength(hitPoint, lv);
    depth |= (((depth2 & PCaloHit::kEcalDepthMask) << PCaloHit::kEcalDepthOffset) | depth1);
  } else if (storeLayerTimeSim) {
    depth2 = getLayerIDForTimeSim();
    depth |= ((depth2 & PCaloHit::kEcalDepthMask) << PCaloHit::kEcalDepthOffset);
  }
#ifdef EDM_ML_DEBUG
  if (isXtal(lv))
    edm::LogVerbatim("EcalSimX") << "ECalSD::Volume " << lv->GetName() << " DetId " << std::hex << setDetUnitId(aStep)
                                 << std::dec << " Global " << (hitPoint->GetPosition()).rho() << ":"
                                 << (hitPoint->GetPosition()).z() << " Local Z " << currentLocalPoint.z() << " Depth "
                                 << crystalDepth;
  edm::LogVerbatim("EcalSim") << "ECalSD::Depth " << std::hex << depth1 << ":" << depth2 << ":" << depth << std::dec
                              << " L " << (ite == xtalLMap.end()) << ":" << ite->second << " local "
                              << currentLocalPoint << " Crystal length " << crystalLength << ":" << crystalDepth;
#endif
  return depth;
}

References funct::abs(), any(), crystalDepth, crystalLength, currentLocalPoint, TauDecayModes::dec, depth, getLayerIDForTimeSim(), getRadiationLength(), isXtal(), PCaloHit::kEcalDepthMask, PCaloHit::kEcalDepthOffset, PCaloHit::kEcalDepthRefz, rho, setDetUnitId(), CaloSD::setToLocal(), storeLayerTimeSim, storeRL, useDepth1, useDepth2, xtalLMap, and z.

getEnergyDeposit()

double ECalSD::getEnergyDeposit ( const G4Step *  aStep )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 180 of file ECalSD.cc.

                                                   {
  const G4StepPoint* preStepPoint = aStep->GetPreStepPoint();
  const G4Track* theTrack = aStep->GetTrack();
  double edep = aStep->GetTotalEnergyDeposit();
 
  // take into account light collection curve for crystals
  double weight = 1.;
  if (suppressHeavy) {
    TrackInformation* trkInfo = (TrackInformation*)(theTrack->GetUserInformation());
    if (trkInfo) {
      int pdg = theTrack->GetDefinition()->GetPDGEncoding();
      if (!(trkInfo->isPrimary())) {  // Only secondary particles
        double ke = theTrack->GetKineticEnergy();
        if (((pdg / 1000000000 == 1 && ((pdg / 10000) % 100) > 0 && ((pdg / 10) % 100) > 0)) && (ke < kmaxIon))
          weight = 0;
        if ((pdg == 2212) && (ke < kmaxProton))
          weight = 0;
        if ((pdg == 2112) && (ke < kmaxNeutron))
          weight = 0;
      }
    }
  }
  const G4LogicalVolume* lv = preStepPoint->GetTouchable()->GetVolume(0)->GetLogicalVolume();
  double wt1 = 1.0;
  if (useWeight && !any(noWeight, lv)) {
    weight *= curve_LY(lv);
    if (useBirk) {
      if (useBirkL3)
        weight *= getBirkL3(aStep);
      else
        weight *= getAttenuation(aStep, birk1, birk2, birk3);
    }
    wt1 = getResponseWt(theTrack);
  }
  edep *= weight * wt1;
  // Russian Roulette
  double wt2 = theTrack->GetWeight();
  if (wt2 > 0.0) {
    edep *= wt2;
  }
#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("EcalSim") << lv->GetName() << " " << dd4hep::dd::noNamespace(lv->GetName())
                              << " Light Collection Efficiency " << weight << ":" << wt1 << " wt2= " << wt2
                              << " Weighted Energy Deposit " << edep / CLHEP::MeV << " MeV at "
                              << preStepPoint->GetPosition();
#endif
  return edep;
}

References any(), birk1, birk2, birk3, curve_LY(), CaloSD::getAttenuation(), getBirkL3(), CaloSD::getResponseWt(), TrackInformation::isPrimary(), ke, CaloSD::kmaxIon, CaloSD::kmaxNeutron, CaloSD::kmaxProton, MeV, noWeight, CaloSD::suppressHeavy, useBirk, useBirkL3, and useWeight.

getLayerIDForTimeSim()

uint16_t ECalSD::getLayerIDForTimeSim ( )

private

Definition at line 313 of file ECalSD.cc.

                                      {
  const double invLayerSize = 0.1;  //layer size in 1/mm
  return (int)crystalDepth * invLayerSize;
}

References crystalDepth.

Referenced by getDepth(), and getRadiationLength().

getRadiationLength()

uint16_t ECalSD::getRadiationLength ( const G4StepPoint *  hitPoint, const G4LogicalVolume *  lv  )

private

Definition at line 287 of file ECalSD.cc.

                                                                                          {
  uint16_t thisX0 = 0;
  if (useWeight) {
    double radl = hitPoint->GetMaterial()->GetRadlen();
    thisX0 = (uint16_t)floor(scaleRL * crystalDepth / radl);
#ifdef plotDebug
    const std::string& lvname = dd4hep::dd::noNamespace(lv->GetName());
    int k1 = (lvname.find("EFRY") != std::string::npos) ? 2 : 0;
    int k2 = (lvname.find("refl") != std::string::npos) ? 1 : 0;
    int kk = k1 + k2;
    double rz = (k1 == 0) ? (hitPoint->GetPosition()).rho() : std::abs((hitPoint->GetPosition()).z());
    edm::LogVerbatim("EcalSim") << lvname << " # " << k1 << ":" << k2 << ":" << kk << " rz " << rz << " D " << thisX0;
    g2L_[kk]->Fill(rz, thisX0);
#endif
#ifdef EDM_ML_DEBUG
    G4ThreeVector localPoint = setToLocal(hitPoint->GetPosition(), hitPoint->GetTouchable());
    edm::LogVerbatim("EcalSim") << lv->GetName() << " " << dd4hep::dd::noNamespace(lv->GetName()) << " Global "
                                << hitPoint->GetPosition() << ":" << (hitPoint->GetPosition()).rho() << " Local "
                                << localPoint << " Crystal Length " << crystalLength << " Radl " << radl
                                << " crystalDepth " << crystalDepth << " Index " << thisX0 << " : "
                                << getLayerIDForTimeSim();
#endif
  }
  return thisX0;
}

References funct::abs(), crystalDepth, crystalLength, getLayerIDForTimeSim(), GetRecoTauVFromDQM_MC_cff::kk, rho, scaleRL, CaloSD::setToLocal(), AlCaHLTBitMon_QueryRunRegistry::string, useWeight, and z.

Referenced by getDepth().

getTrackID()

int ECalSD::getTrackID ( const G4Track *  aTrack )

overrideprotectedvirtual

Reimplemented from CaloSD.

Definition at line 244 of file ECalSD.cc.

                                            {
  int primaryID(0);
  if (storeTrack && depth > 0) {
    forceSave = true;
    primaryID = aTrack->GetTrackID();
  } else {
    primaryID = CaloSD::getTrackID(aTrack);
  }
  return primaryID;
}

References depth, CaloSD::forceSave, CaloSD::getTrackID(), and storeTrack.

initMap()

void ECalSD::initMap ( )

private

Definition at line 336 of file ECalSD.cc.

                     {
  std::vector<const G4LogicalVolume*> lvused;
  const G4LogicalVolumeStore* lvs = G4LogicalVolumeStore::GetInstance();
  std::map<const std::string, const G4LogicalVolume*> nameMap;
  for (auto lvi = lvs->begin(), lve = lvs->end(); lvi != lve; ++lvi)
    nameMap.emplace(dd4hep::dd::noNamespace((*lvi)->GetName()), *lvi);
 
  for (unsigned int it = 0; it < ecalSimParameters_->lvNames_.size(); ++it) {
    const std::string& matname = ecalSimParameters_->matNames_[it];
    const std::string& lvname = ecalSimParameters_->lvNames_[it];
    const G4LogicalVolume* lv = nameMap[lvname];
    int ibec = (lvname.find("EFRY") == std::string::npos) ? 0 : 1;
    int iref = (lvname.find("refl") == std::string::npos) ? 0 : 1;
    int type = (ibec + iref == 1) ? 1 : -1;
    if (depth1Name != " ") {
      if (strncmp(lvname.c_str(), depth1Name.c_str(), 4) == 0) {
        if (!any(useDepth1, lv)) {
          useDepth1.push_back(lv);
#ifdef EDM_ML_DEBUG
          edm::LogVerbatim("EcalSim") << "ECalSD::initMap Logical Volume " << lvname << " in Depth 1 volume list";
#endif
        }
        const G4LogicalVolume* lvr = nameMap[lvname + "_refl"];
        if (lvr != nullptr && !any(useDepth1, lvr)) {
          useDepth1.push_back(lvr);
#ifdef EDM_ML_DEBUG
          edm::LogVerbatim("EcalSim") << "ECalSD::initMap Logical Volume " << lvname << "_refl"
                                      << " in Depth 1 volume list";
#endif
        }
      }
    }
    if (depth2Name != " ") {
      if (strncmp(lvname.c_str(), depth2Name.c_str(), 4) == 0) {
        if (!any(useDepth2, lv)) {
          useDepth2.push_back(lv);
#ifdef EDM_ML_DEBUG
          edm::LogVerbatim("EcalSim") << "ECalSD::initMap Logical Volume " << lvname << " in Depth 2 volume list";
#endif
        }
        const G4LogicalVolume* lvr = nameMap[lvname + "_refl"];
        if (lvr != nullptr && !any(useDepth2, lvr)) {
          useDepth2.push_back(lvr);
#ifdef EDM_ML_DEBUG
          edm::LogVerbatim("EcalSim") << "ECalSD::initMap Logical Volume " << lvname << "_refl"
                                      << " in Depth 2 volume list";
#endif
        }
      }
    }
    if (lv != nullptr) {
      if (crystalMat.size() == matname.size() && !strcmp(crystalMat.c_str(), matname.c_str())) {
        if (!any(lvused, lv)) {
          lvused.push_back(lv);
          double dz = ecalSimParameters_->dzs_[it];
          xtalLMap.insert(std::pair<const G4LogicalVolume*, double>(lv, dz * type));
          lv = nameMap[lvname + "_refl"];
          if (lv != nullptr) {
            xtalLMap.insert(std::pair<const G4LogicalVolume*, double>(lv, -dz * type));
          }
        }
      } else {
        if (!any(noWeight, lv)) {
          noWeight.push_back(lv);
#ifdef EDM_ML_DEBUG
          edm::LogVerbatim("EcalSim") << "ECalSD::initMap Logical Volume " << lvname << " Material " << matname
                                      << " in noWeight list";
#endif
        }
        lv = nameMap[lvname];
        if (lv != nullptr && !any(noWeight, lv)) {
          noWeight.push_back(lv);
#ifdef EDM_ML_DEBUG
          edm::LogVerbatim("EcalSim") << "ECalSD::initMap Logical Volume " << lvname << " Material " << matname
                                      << " in noWeight list";
#endif
        }
      }
    }
  }
#ifdef EDM_ML_DEBUG
  edm::LogVerbatim("EcalSim") << "ECalSD: Length Table:";
  int i = 0;
  for (auto ite : xtalLMap) {
    std::string name("Unknown");
    if (ite.first != nullptr)
      name = dd4hep::dd::noNamespace((ite.first)->GetName());
    edm::LogVerbatim("EcalSim") << " " << i << " " << ite.first << " " << name << " L = " << ite.second;
    ++i;
  }
#endif
}

References any(), crystalMat, depth1Name, depth2Name, PVValHelper::dz, EcalSimulationParameters::dzs_, ecalSimParameters_, mps_fire::i, EcalSimulationParameters::lvNames_, EcalSimulationParameters::matNames_, Skims_PA_cff::name, noWeight, AlCaHLTBitMon_QueryRunRegistry::string, useDepth1, useDepth2, and xtalLMap.

Referenced by ECalSD().

isXtal()

bool ECalSD::isXtal ( const G4LogicalVolume *  lv )

private

Definition at line 500 of file ECalSD.cc.

{ return (xtalLMap.find(lv) != xtalLMap.end()); }

References xtalLMap.

Referenced by getDepth().

setDetUnitId()

uint32_t ECalSD::setDetUnitId ( const G4Step *  aStep )

overridevirtual

Implements CaloSD.

Definition at line 318 of file ECalSD.cc.

                                                 {
  if (numberingScheme_ == nullptr) {
    return EBDetId(1, 1)();
  } else {
    getBaseNumber(aStep);
    return numberingScheme_->getUnitID(theBaseNumber);
  }
}

References getBaseNumber(), EcalNumberingScheme::getUnitID(), numberingScheme_, and theBaseNumber.

Referenced by getDepth().

setNumberingScheme()

void ECalSD::setNumberingScheme

(

EcalNumberingScheme *

scheme

)

Definition at line 327 of file ECalSD.cc.

                                                           {
  if (scheme != nullptr) {
    edm::LogVerbatim("EcalSim") << "EcalSD: updates numbering scheme for " << GetName();
    if (numberingScheme_)
      delete numberingScheme_;
    numberingScheme_ = scheme;
  }
}

References numberingScheme_, and generator_cfi::scheme.

Referenced by ECalSD(), and HcalTB04Analysis::update().

Member Data Documentation

ageing

EnergyResolutionVsLumi ECalSD::ageing

private

Definition at line 69 of file ECalSD.h.

Referenced by curve_LY(), and ECalSD().

ageingWithSlopeLY

bool ECalSD::ageingWithSlopeLY

private

Definition at line 70 of file ECalSD.h.

Referenced by curve_LY(), and ECalSD().

birk1

double ECalSD::birk1

private

Definition at line 63 of file ECalSD.h.

Referenced by ECalSD(), getBirkL3(), and getEnergyDeposit().

birk2

double ECalSD::birk2

private

Definition at line 63 of file ECalSD.h.

Referenced by ECalSD(), and getEnergyDeposit().

birk3

double ECalSD::birk3

private

Definition at line 63 of file ECalSD.h.

Referenced by ECalSD(), and getEnergyDeposit().

birkCut

double ECalSD::birkCut

private

Definition at line 63 of file ECalSD.h.

Referenced by ECalSD(), and getBirkL3().

birkSlope

double ECalSD::birkSlope

private

Definition at line 63 of file ECalSD.h.

Referenced by ECalSD(), and getBirkL3().

crystalDepth

double ECalSD::crystalDepth

private

Definition at line 75 of file ECalSD.h.

Referenced by curve_LY(), EnergyCorrected(), getDepth(), getLayerIDForTimeSim(), and getRadiationLength().

crystalLength

double ECalSD::crystalLength

private

Definition at line 74 of file ECalSD.h.

Referenced by curve_LY(), EnergyCorrected(), getDepth(), and getRadiationLength().

crystalMat

std::string ECalSD::crystalMat

private

Definition at line 65 of file ECalSD.h.

Referenced by ECalSD(), and initMap().

currentLocalPoint

G4ThreeVector ECalSD::currentLocalPoint

private

Definition at line 73 of file ECalSD.h.

Referenced by curve_LY(), EnergyCorrected(), and getDepth().

depth

uint16_t ECalSD::depth

private

Definition at line 76 of file ECalSD.h.

Referenced by dqm_interfaces.DirID::__eq__(), dqm_interfaces.DirID::__repr__(), getDepth(), getTrackID(), and dqm_interfaces.DirWalkerDB::run().

depth1Name

std::string ECalSD::depth1Name

private

Definition at line 65 of file ECalSD.h.

Referenced by ECalSD(), and initMap().

depth2Name

std::string ECalSD::depth2Name

private

Definition at line 65 of file ECalSD.h.

Referenced by ECalSD(), and initMap().

ecalSimParameters_

const EcalSimulationParameters* ECalSD::ecalSimParameters_

private

Definition at line 59 of file ECalSD.h.

Referenced by ECalSD(), and initMap().

noWeight

std::vector<const G4LogicalVolume *> ECalSD::noWeight

private

Definition at line 67 of file ECalSD.h.

Referenced by EnergyCorrected(), getEnergyDeposit(), and initMap().

numberingScheme_

EcalNumberingScheme* ECalSD::numberingScheme_

private

Definition at line 60 of file ECalSD.h.

Referenced by setDetUnitId(), setNumberingScheme(), and ~ECalSD().

scaleRL

double ECalSD::scaleRL

private

Definition at line 64 of file ECalSD.h.

Referenced by ECalSD(), and getRadiationLength().

slopeLY

double ECalSD::slopeLY

private

Definition at line 64 of file ECalSD.h.

Referenced by curve_LY(), and ECalSD().

storeLayerTimeSim

bool ECalSD::storeLayerTimeSim

private

Definition at line 61 of file ECalSD.h.

Referenced by ECalSD(), and getDepth().

storeRL

bool ECalSD::storeRL

private

Definition at line 61 of file ECalSD.h.

Referenced by ECalSD(), and getDepth().

storeTrack

bool ECalSD::storeTrack

private

Definition at line 61 of file ECalSD.h.

Referenced by ECalSD(), and getTrackID().

theBaseNumber

EcalBaseNumber ECalSD::theBaseNumber

private

Definition at line 68 of file ECalSD.h.

Referenced by getBaseNumber(), and setDetUnitId().

useBirk

bool ECalSD::useBirk

private

Definition at line 62 of file ECalSD.h.

Referenced by ECalSD(), and getEnergyDeposit().

useBirkL3

bool ECalSD::useBirkL3

private

Definition at line 62 of file ECalSD.h.

Referenced by ECalSD(), and getEnergyDeposit().

useDepth1

std::vector<const G4LogicalVolume *> ECalSD::useDepth1

private

Definition at line 67 of file ECalSD.h.

Referenced by getDepth(), and initMap().

useDepth2

std::vector<const G4LogicalVolume *> ECalSD::useDepth2

private

Definition at line 67 of file ECalSD.h.

Referenced by getDepth(), and initMap().

useWeight

bool ECalSD::useWeight

private

Definition at line 61 of file ECalSD.h.

Referenced by ECalSD(), EnergyCorrected(), getEnergyDeposit(), and getRadiationLength().

xtalLMap

std::map<const G4LogicalVolume *, double> ECalSD::xtalLMap

private

Definition at line 66 of file ECalSD.h.

Referenced by EnergyCorrected(), getDepth(), initMap(), and isXtal().