#include <CaloSD.h>

Inheritance diagram for CaloSD:

Classes
struct	Detector

Public Member Functions
	CaloSD (const std::string &aSDname, const edm::EventSetup &es, 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

uint32_t	setDetUnitId (const G4Step *step) override=0

	~CaloSD () override

Public Member Functions inherited from SensitiveCaloDetector
	SensitiveCaloDetector (const std::string &iname, const edm::EventSetup &es, const SensitiveDetectorCatalog &clg, edm::ParameterSet const &p)

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 edm::EventSetup &es, const SensitiveDetectorCatalog &, edm::ParameterSet const &p, 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
bool	checkHit ()

CaloG4Hit *	createNewHit (const G4Step , const G4Track )

virtual void	endEvent ()

virtual double	EnergyCorrected (const G4Step &step, const G4Track *)

virtual bool	filterHit (CaloG4Hit *, double)

double	getAttenuation (const G4Step *aStep, double birk1, double birk2, double birk3) const

virtual uint16_t	getDepth (const G4Step *)

virtual double	getEnergyDeposit (const G4Step *step)

virtual bool	getFromLibrary (const G4Step *step)

int	getNumberOfHits ()

double	getResponseWt (const G4Track *)

virtual int	getTrackID (const G4Track *)

bool	hitExists (const G4Step *)

void	ignoreRejection ()

virtual void	initEvent (const BeginOfEvent *)

virtual void	initRun ()

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

Protected Attributes
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

Private Member Functions
void	cleanHitCollection ()

bool	saveHit (CaloG4Hit *)

void	storeHit (CaloG4Hit *)

Private Attributes
int	cleanIndex

double	correctT

bool	corrTOFBeam

double	eminHitD

std::vector< Detector >	fineDetectors_

int	hcID

std::map< CaloHitID, CaloG4Hit * >	hitMap

bool	ignoreReject

bool	ignoreTrackID

bool	isParameterized

const SimTrackManager *	m_trackManager

std::unique_ptr< CaloMeanResponse >	meanResponse

int	nCheckedHits

int	primAncestor

int	primIDSaved

std::vector< std::unique_ptr< CaloG4Hit > >	reusehit

std::unique_ptr< CaloSlaveSD >	slave

CaloG4HitCollection *	theHC

float	timeSlice

std::map< int, TrackWithHistory * >	tkMap

int	totalHits

bool	useFineCaloID_

bool	useMap

Additional Inherited Members
Protected Types inherited from SensitiveDetector
enum	coordinates { WorldCoordinates, LocalCoordinates }

Detailed Description

Definition at line 38 of file CaloSD.h.

Constructor & Destructor Documentation

◆ CaloSD()

CaloSD::CaloSD	(	const std::string &	aSDname,
		const edm::EventSetup &	es,
		const SensitiveDetectorCatalog &	clg,
		edm::ParameterSet const &	p,
		const SimTrackManager *	manager,
		float	timeSlice = `1.`,
		bool	ignoreTkID = `false`
	)

Definition at line 33 of file CaloSD.cc.

     : SensitiveCaloDetector(name, es, clg, p),
       G4VGFlashSensitiveDetector(),
       eminHit(0.),
       currentHit(nullptr),
       m_trackManager(manager),
       theHC(nullptr),
       ignoreTrackID(ignoreTkID),
       hcID(-1),
       timeSlice(timeSliceUnit),
       eminHitD(0.) {
   //Parameters
   edm::ParameterSet m_CaloSD = p.getParameter<edm::ParameterSet>("CaloSD");
   energyCut = m_CaloSD.getParameter<double>("EminTrack") * CLHEP::GeV;
   tmaxHit = m_CaloSD.getParameter<double>("TmaxHit") * CLHEP::ns;
   std::vector<double> eminHits = m_CaloSD.getParameter<std::vector<double>>("EminHits");
   std::vector<double> tmaxHits = m_CaloSD.getParameter<std::vector<double>>("TmaxHits");
   std::vector<std::string> hcn = m_CaloSD.getParameter<std::vector<std::string>>("HCNames");
   std::vector<int> useResMap = m_CaloSD.getParameter<std::vector<int>>("UseResponseTables");
   std::vector<double> eminHitX = m_CaloSD.getParameter<std::vector<double>>("EminHitsDepth");
   suppressHeavy = m_CaloSD.getParameter<bool>("SuppressHeavy");
   kmaxIon = m_CaloSD.getParameter<double>("IonThreshold") * CLHEP::MeV;
   kmaxProton = m_CaloSD.getParameter<double>("ProtonThreshold") * CLHEP::MeV;
   kmaxNeutron = m_CaloSD.getParameter<double>("NeutronThreshold") * CLHEP::MeV;
   nCheckedHits = m_CaloSD.getUntrackedParameter<int>("CheckHits", 25);
   useMap = m_CaloSD.getUntrackedParameter<bool>("UseMap", true);
   int verbn = m_CaloSD.getUntrackedParameter<int>("Verbosity", 0);
   corrTOFBeam = m_CaloSD.getParameter<bool>("CorrectTOFBeam");
   double beamZ = m_CaloSD.getParameter<double>("BeamPosition") * CLHEP::cm;
   correctT = beamZ / CLHEP::c_light / CLHEP::nanosecond;
   useFineCaloID_ = m_CaloSD.getParameter<bool>("UseFineCaloID");
  
   SetVerboseLevel(verbn);
   meanResponse.reset(nullptr);
   for (unsigned int k = 0; k < hcn.size(); ++k) {
     if (name == hcn[k]) {
       if (k < eminHits.size())
         eminHit = eminHits[k] * CLHEP::MeV;
       if (k < eminHitX.size())
         eminHitD = eminHitX[k] * CLHEP::MeV;
       if (k < tmaxHits.size())
         tmaxHit = tmaxHits[k] * CLHEP::ns;
       if (k < useResMap.size() && useResMap[k] > 0) {
         meanResponse = std::make_unique<CaloMeanResponse>(p);
         break;
       }
     }
   }
   slave = std::make_unique<CaloSlaveSD>(name);
  
   currentID = CaloHitID(timeSlice, ignoreTrackID);
   previousID = CaloHitID(timeSlice, ignoreTrackID);
   isParameterized = false;
  
   entrancePoint.set(0., 0., 0.);
   entranceLocal.set(0., 0., 0.);
   posGlobal.set(0., 0., 0.);
   incidentEnergy = edepositEM = edepositHAD = 0.f;
  
   primAncestor = cleanIndex = totalHits = primIDSaved = 0;
   forceSave = false;
  
   edm::LogVerbatim("CaloSim") << "CaloSD: Minimum energy of track for saving it " << energyCut / CLHEP::GeV
                               << " GeV\n        Use of HitID Map " << useMap << "\n        Check last " << nCheckedHits
                               << " before saving the hit\n        Correct TOF globally by " << correctT
                               << " ns (Flag =" << corrTOFBeam << ")\n        Save hits recorded before " << tmaxHit
                               << " ns and if energy is above " << eminHit / CLHEP::MeV << " MeV (for depth 0) or "
                               << eminHitD / CLHEP::MeV << " MeV (for nonzero depths);\n        Time Slice Unit "
                               << timeSlice << "\nIgnore TrackID Flag " << ignoreTrackID << " UseFineCaloID flag "
                               << useFineCaloID_;
  
   // Get pointer to CaloSimulationParameters
   edm::ESHandle<CaloSimulationParameters> csps;
   es.get<HcalParametersRcd>().get(csps);
   if (csps.isValid()) {
     const CaloSimulationParameters* csp = csps.product();
     edm::LogVerbatim("CaloSim") << "CaloSD: " << csp->fCaloNames_.size() << " entries for fineCalorimeters:";
     for (unsigned int i = 0; i < csp->fCaloNames_.size(); i++)
       edm::LogVerbatim("CaloSim") << " [" << i << "] " << csp->fCaloNames_[i] << ":" << csp->fLevels_[i];
  
     const G4LogicalVolumeStore* lvs = G4LogicalVolumeStore::GetInstance();
     std::vector<G4LogicalVolume*>::const_iterator lvcite;
     for (unsigned int i = 0; i < csp->fCaloNames_.size(); i++) {
       G4LogicalVolume* lv = nullptr;
       G4String name = static_cast<G4String>(csp->fCaloNames_[i]);
       for (lvcite = lvs->begin(); lvcite != lvs->end(); lvcite++) {
         if ((*lvcite)->GetName() == name) {
           lv = (*lvcite);
           break;
         }
       }
       if (lv != nullptr) {
         CaloSD::Detector detector;
         detector.name = name;
         detector.lv = lv;
         detector.level = csp->fLevels_[i];
         fineDetectors_.emplace_back(detector);
       }
     }
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD::Loads information for " << fineDetectors_.size() << " fine detectors";
     unsigned int k(0);
     for (const auto& detector : fineDetectors_) {
       edm::LogVerbatim("CaloSim") << "Detector[" << k << "] " << detector.name << " at level " << detector.level
                                   << " pointer to LV: " << detector.lv;
     }
 #endif
   } else {
     edm::LogError("CaloSim") << "CaloSD: Cannot find CaloSimulationParameters";
     throw cms::Exception("Unknown", "CaloSD") << "Cannot find CaloSimulationParameters\n";
   }
 }

References cleanIndex, correctT, corrTOFBeam, currentID, hgcalTestNeighbor_cfi::detector, edepositEM, edepositHAD, eminHit, eminHitD, energyCut, entranceLocal, entrancePoint, Exception, CaloSimulationParameters::fCaloNames_, fineDetectors_, CaloSimulationParameters::fLevels_, forceSave, edm::EventSetup::get(), get, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), GeV, mps_fire::i, ignoreTrackID, incidentEnergy, isParameterized, edm::ESHandleBase::isValid(), dqmdumpme::k, kmaxIon, kmaxNeutron, kmaxProton, meanResponse, MeV, Skims_PA_cff::name, nCheckedHits, AlCaHLTBitMon_ParallelJobs::p, posGlobal, previousID, primAncestor, primIDSaved, edm::ESHandle< T >::product(), slave, suppressHeavy, timeSlice, tmaxHit, totalHits, useFineCaloID_, and useMap.

◆ ~CaloSD()

CaloSD::~CaloSD ( )

override

Definition at line 152 of file CaloSD.cc.

152 {}

Member Function Documentation

◆ checkHit()

bool CaloSD::checkHit ( )

protected

Definition at line 396 of file CaloSD.cc.

                       {
   //look in the HitContainer whether a hit with the same ID already exists:
   bool found = false;
   if (useMap) {
     std::map<CaloHitID, CaloG4Hit*>::const_iterator it = hitMap.find(currentID);
     if (it != hitMap.end()) {
       currentHit = it->second;
       found = true;
     }
   } else if (nCheckedHits > 0) {
     int nhits = theHC->entries();
     int minhit = std::max(nhits - nCheckedHits, 0);
     int maxhit = nhits - 1;
  
     for (int j = maxhit; j > minhit; --j) {
       if ((*theHC)[j]->getID() == currentID) {
         currentHit = (*theHC)[j];
         found = true;
         break;
       }
     }
   }
  
   if (found) {
     updateHit(currentHit);
   }
   return found;
 }

References currentHit, currentID, newFWLiteAna::found, hitMap, dqmiolumiharvest::j, SiStripPI::max, nCheckedHits, nhits, theHC, updateHit(), and useMap.

Referenced by hitExists(), processHit(), and ProcessHits().

◆ cleanHitCollection()

void CaloSD::cleanHitCollection ( )

private

Definition at line 789 of file CaloSD.cc.

                                 {
   std::vector<CaloG4Hit*>* theCollection = theHC->GetVector();
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: collection before merging, size = " << theHC->entries();
 #endif
   if (reusehit.empty())
     reusehit.reserve(theHC->entries() - cleanIndex);
  
   // if no map used, merge before hits to have the save situation as a map
   if (!useMap) {
     std::vector<CaloG4Hit*> hitvec;
  
     hitvec.swap(*theCollection);
     sort((hitvec.begin() + cleanIndex), hitvec.end(), CaloG4HitLess());
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD::cleanHitCollection: sort hits in buffer starting from "
                                 << "element = " << cleanIndex;
     for (unsigned int i = 0; i < hitvec.size(); ++i)
       edm::LogVerbatim("CaloSim") << i << " " << *hitvec[i];
 #endif
     CaloG4HitEqual equal;
     for (unsigned int i = cleanIndex; i < hitvec.size(); ++i) {
       int jump = 0;
       for (unsigned int j = i + 1; j < hitvec.size() && equal(hitvec[i], hitvec[j]); ++j) {
         ++jump;
         // merge j to i
         (*hitvec[i]).addEnergyDeposit(*hitvec[j]);
         (*hitvec[j]).setEM(0.);
         (*hitvec[j]).setHadr(0.);
         reusehit.emplace_back(hitvec[j]);
         hitvec[j] = nullptr;
       }
       i += jump;
     }
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD: cleanHitCollection merge the hits in buffer ";
     for (unsigned int i = 0; i < hitvec.size(); ++i)
       edm::LogVerbatim("CaloSim") << i << " " << *hitvec[i];
 #endif
     //move all nullptr to end of list and then remove them
     hitvec.erase(
         std::stable_partition(hitvec.begin() + cleanIndex, hitvec.end(), [](CaloG4Hit* p) { return p != nullptr; }),
         hitvec.end());
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD::cleanHitCollection: remove the merged hits in buffer,"
                                 << " new size = " << hitvec.size();
     for (unsigned int i = 0; i < hitvec.size(); ++i)
       edm::LogVerbatim("CaloSim") << i << " " << *hitvec[i];
 #endif
     hitvec.swap(*theCollection);
     totalHits = theHC->entries();
   }
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: collection after merging, size= " << theHC->entries()
                               << " Size of reusehit= " << reusehit.size()
                               << "\n      starting hit selection from index = " << cleanIndex;
 #endif
  
   int addhit = 0;
   for (unsigned int i = cleanIndex; i < theCollection->size(); ++i) {
     CaloG4Hit* aHit((*theCollection)[i]);
  
     // selection
  
     double time = aHit->getTimeSlice();
     if (corrTOFBeam)
       time += correctT;
     if (!filterHit(aHit, time)) {
 #ifdef EDM_ML_DEBUG
       edm::LogVerbatim("CaloSim") << "CaloSD: dropped CaloG4Hit "
                                   << " " << *aHit;
 #endif
  
       // create the list of hits to be reused
  
       reusehit.emplace_back((*theCollection)[i]);
       (*theCollection)[i] = nullptr;
       ++addhit;
     }
   }
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: Size of reusehit after selection = " << reusehit.size()
                               << " Number of added hit = " << addhit;
 #endif
   if (useMap) {
     if (addhit > 0) {
       int offset = reusehit.size() - addhit;
       for (int ii = addhit - 1; ii >= 0; --ii) {
         CaloHitID theID = reusehit[offset + ii]->getID();
         hitMap.erase(theID);
       }
     }
   }
  
   //move all nullptr to end of list and then remove them
   theCollection->erase(
       std::stable_partition(
           theCollection->begin() + cleanIndex, theCollection->end(), [](CaloG4Hit* p) { return p != nullptr; }),
       theCollection->end());
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: hit collection after selection, size = " << theHC->entries();
   theHC->PrintAllHits();
 #endif
  
   cleanIndex = theHC->entries();
 }

References cleanIndex, correctT, corrTOFBeam, cond::serialization::equal(), filterHit(), CaloG4Hit::getTimeSlice(), hitMap, mps_fire::i, cuy::ii, dqmiolumiharvest::j, hltrates_dqm_sourceclient-live_cfg::offset, AlCaHLTBitMon_ParallelJobs::p, reusehit, theHC, ntuplemaker::time, totalHits, and useMap.

Referenced by EndOfEvent(), and update().

◆ clear()

void CaloSD::clear ( void )

override

Definition at line 351 of file CaloSD.cc.

351 {}

◆ clearHits()

void CaloSD::clearHits ( )

overridevirtual

Implements SensitiveDetector.

Definition at line 632 of file CaloSD.cc.

                        {
   cleanIndex = 0;
   previousID.reset();
   primIDSaved = -99;
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: Clears hit vector for " << GetName()
                               << " and initialise slave: " << slave.get()->name();
 #endif
   slave.get()->Initialize();
 }

References cleanIndex, previousID, primIDSaved, CaloHitID::reset(), and slave.

Referenced by update().

◆ createNewHit()

CaloG4Hit * CaloSD::createNewHit	(	const G4Step *	aStep,
		const G4Track *	theTrack
	)

protected

Definition at line 427 of file CaloSD.cc.

                                                                             {
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD::CreateNewHit " << getNumberOfHits() << " for " << GetName()
                               << " Unit:" << currentID.unitID() << " " << currentID.depth() << " Edep= " << edepositEM
                               << " " << edepositHAD << " primaryID= " << currentID.trackID()
                               << " timeSlice= " << currentID.timeSliceID() << " ID= " << theTrack->GetTrackID() << " "
                               << theTrack->GetDefinition()->GetParticleName()
                               << " E(GeV)= " << theTrack->GetKineticEnergy() / CLHEP::GeV
                               << " parentID= " << theTrack->GetParentID() << "\n Ein= " << incidentEnergy
                               << " entranceGlobal: " << entrancePoint << " entranceLocal: " << entranceLocal
                               << " posGlobal: " << posGlobal;
 #endif
  
   CaloG4Hit* aHit;
   if (!reusehit.empty()) {
     aHit = reusehit.back().release();
     aHit->setEM(0.f);
     aHit->setHadr(0.f);
     reusehit.pop_back();
   } else {
     aHit = new CaloG4Hit;
   }
  
   aHit->setID(currentID);
   aHit->setEntry(entrancePoint.x(), entrancePoint.y(), entrancePoint.z());
   aHit->setEntryLocal(entranceLocal.x(), entranceLocal.y(), entranceLocal.z());
   aHit->setPosition(posGlobal.x(), posGlobal.y(), posGlobal.z());
   aHit->setIncidentEnergy(incidentEnergy);
   updateHit(aHit);
  
   storeHit(aHit);
   double etrack = 0;
   if (currentID.trackID() == primIDSaved) {  // The track is saved; nothing to be done
   } else if (currentID.trackID() == theTrack->GetTrackID()) {
     etrack = theTrack->GetKineticEnergy();
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD: set save the track " << currentID.trackID() << " etrack " << etrack
                                 << " eCut " << energyCut << " force: " << forceSave
                                 << " save: " << (etrack >= energyCut || forceSave);
 #endif
     if (etrack >= energyCut || forceSave) {
       TrackInformation* trkInfo = cmsTrackInformation(theTrack);
       trkInfo->storeTrack(true);
       trkInfo->putInHistory();
     }
   } else {
     TrackWithHistory* trkh = tkMap[currentID.trackID()];
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD : TrackwithHistory pointer for " << currentID.trackID() << " is " << trkh;
 #endif
     if (trkh != nullptr) {
       etrack = sqrt(trkh->momentum().Mag2());
       if (etrack >= energyCut) {
         trkh->save();
 #ifdef EDM_ML_DEBUG
         edm::LogVerbatim("CaloSim") << "CaloSD: set save the track " << currentID.trackID() << " with Hit";
 #endif
       }
     }
   }
   primIDSaved = currentID.trackID();
   if (useMap)
     ++totalHits;
   return aHit;
 }

References SensitiveDetector::cmsTrackInformation(), currentID, CaloHitID::depth(), edepositEM, edepositHAD, energyCut, entranceLocal, entrancePoint, f, forceSave, getNumberOfHits(), GeV, incidentEnergy, TrackWithHistory::momentum(), posGlobal, primIDSaved, TrackInformation::putInHistory(), reusehit, TrackWithHistory::save(), CaloG4Hit::setEM(), CaloG4Hit::setEntry(), CaloG4Hit::setEntryLocal(), CaloG4Hit::setHadr(), CaloG4Hit::setID(), CaloG4Hit::setIncidentEnergy(), CaloG4Hit::setPosition(), mathSSE::sqrt(), storeHit(), TrackInformation::storeTrack(), CaloHitID::timeSliceID(), tkMap, totalHits, CaloHitID::trackID(), CaloHitID::unitID(), updateHit(), and useMap.

Referenced by processHit(), and ProcessHits().

◆ DrawAll()

void CaloSD::DrawAll ( )

override

Definition at line 353 of file CaloSD.cc.

353 {}

◆ endEvent()

void CaloSD::endEvent ( )

protectedvirtual

Reimplemented in HGCSD.

Definition at line 653 of file CaloSD.cc.

653 {}

Referenced by update().

◆ EndOfEvent()

void CaloSD::EndOfEvent ( G4HCofThisEvent * eventHC )

override

Definition at line 341 of file CaloSD.cc.

                                         {
   // clean the hits for the last tracks
  
   cleanHitCollection();
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: EndofEvent entered with " << theHC->entries() << " entries";
 #endif
 }

References cleanHitCollection(), and theHC.

◆ EnergyCorrected()

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

protectedvirtual

Reimplemented in ECalSD.

Definition at line 299 of file CaloSD.cc.

299 { return aStep.GetTotalEnergyDeposit(); }

Referenced by ProcessHits().

◆ fillHits()

void CaloSD::fillHits	(	edm::PCaloHitContainer &	cc,
		const std::string &	hname
	)

overridevirtual

Implements SensitiveCaloDetector.

Definition at line 362 of file CaloSD.cc.

                                                                       {
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: Tries to transfer " << slave.get()->hits().size() << " hits for "
                               << slave.get()->name() << "   " << hname;
 #endif
   if (slave.get()->name() == hname) {
     cc = slave.get()->hits();
   }
   slave.get()->Clean();
 }

References slave.

◆ filterHit()

bool CaloSD::filterHit	(	CaloG4Hit *	hit,
		double	time
	)

protectedvirtual

Reimplemented in HCalSD, HGCSD, AHCalSD, HFNoseSD, HGCalSD, and HGCScintSD.

Definition at line 698 of file CaloSD.cc.

                                                   {
   double emin(eminHit);
   if (hit->getDepth() > 0)
     emin = eminHitD;
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD::filterHit(..) Depth " << hit->getDepth() << " Emin = " << emin << " ("
                               << eminHit << ", " << eminHitD << ")";
 #endif
   return ((time <= tmaxHit) && (hit->getEnergyDeposit() > emin));
 }

References eminHit, eminHitD, ntuplemaker::time, and tmaxHit.

Referenced by cleanHitCollection().

◆ getAttenuation()

double CaloSD::getAttenuation	(	const G4Step *	aStep,
		double	birk1,
		double	birk2,
		double	birk3
	)		const

protected

Definition at line 517 of file CaloSD.cc.

                                                                                                  {
   double weight = 1.;
   double charge = aStep->GetPreStepPoint()->GetCharge();
   double length = aStep->GetStepLength();
  
   if (charge != 0. && length > 0.) {
     double density = aStep->GetPreStepPoint()->GetMaterial()->GetDensity();
     double dedx = aStep->GetTotalEnergyDeposit() / length;
     double rkb = birk1 / density;
     double c = birk2 * rkb * rkb;
     if (std::abs(charge) >= 2.)
       rkb /= birk3;  // based on alpha particle data
     weight = 1. / (1. + rkb * dedx + c * dedx * dedx);
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD::getAttenuation in " << aStep->GetPreStepPoint()->GetMaterial()->GetName()
                                 << " Charge " << charge << " dE/dx " << dedx << " Birk Const " << rkb << ", " << c
                                 << " Weight = " << weight << " dE " << aStep->GetTotalEnergyDeposit();
 #endif
   }
   return weight;
 }

References funct::abs(), HltBtagPostValidation_cff::c, ALCARECOTkAlJpsiMuMu_cff::charge, fastSimProducer_cff::density, and mps_merge::weight.

Referenced by TotemT2ScintSD::getEnergyDeposit(), DreamSD::getEnergyDeposit(), HGCalTB16SD01::getEnergyDeposit(), HcalTB06BeamSD::getEnergyDeposit(), HGCScintSD::getEnergyDeposit(), EcalTBH4BeamSD::getEnergyDeposit(), AHCalSD::getEnergyDeposit(), HcalTB02SD::getEnergyDeposit(), ECalSD::getEnergyDeposit(), and HCalSD::getEnergyDeposit().

◆ getDepth()

uint16_t CaloSD::getDepth ( const G4Step * )

protectedvirtual

Reimplemented in ECalSD.

Definition at line 696 of file CaloSD.cc.

696 { return 0; }

Referenced by ProcessHits().

◆ getEnergyDeposit()

double CaloSD::getEnergyDeposit ( const G4Step * step )

protectedvirtual

Reimplemented in HCalSD, CastorSD, ECalSD, HcalTB02SD, AHCalSD, HGCSD, HFNoseSD, HGCalSD, EcalTBH4BeamSD, HGCScintSD, HcalTB06BeamSD, ZdcSD, HGCalTB16SD01, DreamSD, and TotemT2ScintSD.

Definition at line 297 of file CaloSD.cc.

297 { return aStep->GetTotalEnergyDeposit(); }

Referenced by ProcessHits().

◆ getFromLibrary()

bool CaloSD::getFromLibrary ( const G4Step * step )

protectedvirtual

Reimplemented in HCalSD, CastorSD, and ZdcSD.

Definition at line 301 of file CaloSD.cc.

301 { return false; }

Referenced by ProcessHits().

◆ getNumberOfHits()

int CaloSD::getNumberOfHits ( )

protected

Definition at line 425 of file CaloSD.cc.

425 { return theHC->entries(); }

References theHC.

Referenced by createNewHit(), and HCalSD::getFromLibrary().

◆ getResponseWt()

double CaloSD::getResponseWt ( const G4Track * aTrack )

protected

Definition at line 709 of file CaloSD.cc.

                                                   {
   double wt = 1.0;
   if (meanResponse.get()) {
     TrackInformation* trkInfo = cmsTrackInformation(aTrack);
     wt = meanResponse.get()->getWeight(trkInfo->genParticlePID(), trkInfo->genParticleP());
   }
   return wt;
 }

References SensitiveDetector::cmsTrackInformation(), TrackInformation::genParticleP(), TrackInformation::genParticlePID(), and meanResponse.

Referenced by ECalSD::EnergyCorrected(), HGCScintSD::getEnergyDeposit(), HFNoseSD::getEnergyDeposit(), HGCalSD::getEnergyDeposit(), HGCSD::getEnergyDeposit(), ECalSD::getEnergyDeposit(), and HCalSD::getEnergyDeposit().

◆ getTrackID()

int CaloSD::getTrackID ( const G4Track * aTrack )

protectedvirtual

Reimplemented in ECalSD.

Definition at line 655 of file CaloSD.cc.

                                             {
   int primaryID = 0;
   forceSave = false;
   TrackInformation* trkInfo = cmsTrackInformation(aTrack);
   if (trkInfo) {
     primaryID = (useFineCaloID_) ? trkInfo->getIDfineCalo() : trkInfo->getIDonCaloSurface();
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "Track ID: " << trkInfo->getIDfineCalo() << ":" << trkInfo->getIDonCaloSurface()
                                 << ":" << aTrack->GetTrackID() << ":" << primaryID;
 #endif
   } else {
     primaryID = aTrack->GetTrackID();
 #ifdef EDM_ML_DEBUG
     edm::LogWarning("CaloSim") << "CaloSD: Problem with primaryID **** set by force to TkID **** " << primaryID;
 #endif
   }
   return primaryID;
 }

References SensitiveDetector::cmsTrackInformation(), forceSave, TrackInformation::getIDfineCalo(), TrackInformation::getIDonCaloSurface(), and useFineCaloID_.

Referenced by ECalSD::getTrackID(), and ProcessHits().

◆ hitExists()

bool CaloSD::hitExists ( const G4Step * aStep )

protected

Definition at line 381 of file CaloSD.cc.

                                           {
   // Update if in the same detector, time-slice and for same track
   if (currentID == previousID) {
     updateHit(currentHit);
     return true;
   }
  
   // Reset entry point for new primary
   posGlobal = aStep->GetPreStepPoint()->GetPosition();
   if (currentID.trackID() != previousID.trackID()) {
     resetForNewPrimary(aStep);
   }
   return checkHit();
 }

References checkHit(), currentHit, currentID, posGlobal, previousID, resetForNewPrimary(), CaloHitID::trackID(), and updateHit().

Referenced by ProcessHits().

◆ ignoreRejection()

void CaloSD::ignoreRejection ( )

inlineprotected

Definition at line 102 of file CaloSD.h.

102 { ignoreReject = true; }

References ignoreReject.

Referenced by HGCalSD::setDetUnitId().

◆ initEvent()

void CaloSD::initEvent ( const BeginOfEvent * )

protectedvirtual

Reimplemented in HGCSD.

Definition at line 651 of file CaloSD.cc.

651 {}

Referenced by update().

◆ Initialize()

void CaloSD::Initialize ( G4HCofThisEvent * HCE )

override

Definition at line 323 of file CaloSD.cc.

                                             {
   totalHits = 0;
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD : Initialize called for " << GetName();
 #endif
  
   //This initialization is performed at the beginning of an event
   //------------------------------------------------------------
   theHC = new CaloG4HitCollection(GetName(), collectionName[0]);
  
   if (hcID < 0) {
     hcID = G4SDManager::GetSDMpointer()->GetCollectionID(collectionName[0]);
   }
   //theHC ownership is transfered here to HCE
   HCE->AddHitsCollection(hcID, theHC);
 }

References bysipixelclustmulteventfilter_cfi::collectionName, hcID, theHC, and totalHits.

◆ initRun()

void CaloSD::initRun ( )

protectedvirtual

Reimplemented in HCalSD, HGCSD, HFNoseSD, HGCalSD, HGCScintSD, ZdcSD, and DreamSD.

Definition at line 649 of file CaloSD.cc.

649 {}

Referenced by update().

◆ isItFineCalo()

bool CaloSD::isItFineCalo ( const G4VTouchable * touch )

Definition at line 303 of file CaloSD.cc.

                                                    {
   bool ok(false);
   int level = ((touch->GetHistoryDepth()) + 1);
   for (const auto& detector : fineDetectors_) {
     if (level > 0 && level >= detector.level) {
       int ii = level - detector.level;
       G4LogicalVolume* lv = touch->GetVolume(ii)->GetLogicalVolume();
       ok = (lv == detector.lv);
 #ifdef EDM_ML_DEBUG
       std::string name1 = (lv == 0) ? "Unknown" : lv->GetName();
       edm::LogVerbatim("CaloSim") << "CaloSD: volume " << name1 << ":" << detector.name << " at Level "
                                   << detector.level << " Flag " << ok;
 #endif
       if (ok)
         break;
     }
   }
   return ok;
 }

References hgcalTestNeighbor_cfi::detector, fineDetectors_, cuy::ii, personalPlayback::level, convertSQLiteXML::ok, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ PrintAll()

void CaloSD::PrintAll ( )

override

Definition at line 355 of file CaloSD.cc.

                       {
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: Collection " << theHC->GetName();
 #endif
   theHC->PrintAllHits();
 }

References theHC.

◆ processHit()

void CaloSD::processHit ( const G4Step * step )

inlineprotected

Definition at line 107 of file CaloSD.h.

                                              {
     // check if it is in the same unit and timeslice as the previous one
     if (currentID == previousID) {
       updateHit(currentHit);
     } else if (!checkHit()) {
       currentHit = createNewHit(step, step->GetTrack());
     }
   }

References checkHit(), createNewHit(), currentHit, currentID, previousID, and updateHit().

Referenced by HCalSD::getFromHFLibrary(), ZdcSD::getFromLibrary(), CastorSD::getFromLibrary(), HCalSD::getFromParam(), HCalSD::getHitFibreBundle(), HCalSD::getHitPMT(), and HCalSD::hitForFibre().

◆ ProcessHits() [1/2]

bool CaloSD::ProcessHits	(	G4GFlashSpot *	aSpot,
		G4TouchableHistory *
	)

override

Definition at line 232 of file CaloSD.cc.

                                                                  {
   edepositEM = edepositHAD = 0.f;
   const G4Track* track = aSpot->GetOriginatorTrack()->GetPrimaryTrack();
  
   double edep = aSpot->GetEnergySpot()->GetEnergy();
   if (edep <= 0.0) {
     return false;
   }
  
   G4Step fFakeStep;
   G4StepPoint* fFakePreStepPoint = fFakeStep.GetPreStepPoint();
   G4StepPoint* fFakePostStepPoint = fFakeStep.GetPostStepPoint();
   fFakePreStepPoint->SetPosition(aSpot->GetPosition());
   fFakePostStepPoint->SetPosition(aSpot->GetPosition());
  
   G4TouchableHandle fTouchableHandle = aSpot->GetTouchableHandle();
   fFakePreStepPoint->SetTouchableHandle(fTouchableHandle);
   fFakeStep.SetTotalEnergyDeposit(edep);
   edep = EnergyCorrected(fFakeStep, track);
   if (edep <= 0.0) {
     return false;
   }
  
   if (G4TrackToParticleID::isGammaElectronPositron(track)) {
     edepositEM = edep;
   } else {
     edepositHAD = edep;
   }
  
   unsigned int unitID = setDetUnitId(&fFakeStep);
  
   if (unitID > 0) {
     double time = 0;
     int primaryID = getTrackID(track);
     uint16_t depth = getDepth(&fFakeStep);
     currentID.setID(unitID, time, primaryID, depth);
 #ifdef EDM_ML_DEBUG
     edm::LogVerbatim("CaloSim") << "CaloSD:: GetSpotInfo for Unit 0x" << std::hex << currentID.unitID() << std::dec
                                 << " Edeposit = " << edepositEM << " " << edepositHAD;
 #endif
     // Update if in the same detector, time-slice and for same track
     if (currentID == previousID) {
       updateHit(currentHit);
     } else {
       posGlobal = aSpot->GetEnergySpot()->GetPosition();
       // Reset entry point for new primary
       if (currentID.trackID() != previousID.trackID()) {
         entrancePoint = aSpot->GetPosition();
         entranceLocal = aSpot->GetTouchableHandle()->GetHistory()->GetTopTransform().TransformPoint(entrancePoint);
         incidentEnergy = track->GetKineticEnergy();
 #ifdef EDM_ML_DEBUG
         edm::LogVerbatim("CaloSim") << "CaloSD: Incident energy " << incidentEnergy / CLHEP::GeV << " GeV and"
                                     << " entrance point " << entrancePoint << " (Global) " << entranceLocal
                                     << " (Local)";
 #endif
       }
       if (!checkHit()) {
         currentHit = createNewHit(&fFakeStep, track);
       }
     }
     return true;
   }
   return false;
 }

References checkHit(), createNewHit(), currentHit, currentID, TauDecayModes::dec, LEDCalibrationChannels::depth, edepositEM, edepositHAD, EnergyCorrected(), entranceLocal, entrancePoint, getDepth(), getTrackID(), GeV, incidentEnergy, G4TrackToParticleID::isGammaElectronPositron(), posGlobal, previousID, setDetUnitId(), CaloHitID::setID(), ntuplemaker::time, HLT_FULL_cff::track, CaloHitID::trackID(), CaloHitID::unitID(), and updateHit().

◆ ProcessHits() [2/2]

G4bool CaloSD::ProcessHits	(	G4Step *	step,
		G4TouchableHistory *
	)

overridevirtual

Implements SensitiveDetector.

Definition at line 154 of file CaloSD.cc.

                                                              {
   NaNTrap(aStep);
   ignoreReject = false;
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD::" << GetName() << " ID= " << aStep->GetTrack()->GetTrackID()
                               << " prID= " << aStep->GetTrack()->GetParentID()
                               << " Eprestep= " << aStep->GetPreStepPoint()->GetKineticEnergy()
                               << " step= " << aStep->GetStepLength() << " Edep= " << aStep->GetTotalEnergyDeposit();
 #endif
   // apply shower library or parameterisation
   if (isParameterized) {
     if (getFromLibrary(aStep)) {
       // for parameterized showers the primary track should be killed
       aStep->GetTrack()->SetTrackStatus(fStopAndKill);
       auto tv = aStep->GetSecondary();
       auto vol = aStep->GetPreStepPoint()->GetPhysicalVolume();
       for (auto& tk : *tv) {
         if (tk->GetVolume() == vol) {
           tk->SetTrackStatus(fStopAndKill);
         }
       }
       return true;
     }
   }
  
   // ignore steps without energy deposit
   edepositEM = edepositHAD = 0.f;
   unsigned int unitID = setDetUnitId(aStep);
   auto const theTrack = aStep->GetTrack();
   uint16_t depth = getDepth(aStep);
  
   double time = theTrack->GetGlobalTime() / nanosecond;
   int primaryID = getTrackID(theTrack);
   if (unitID > 0) {
     currentID.setID(unitID, time, primaryID, depth);
   } else {
     if (aStep->GetTotalEnergyDeposit() > 0.0 && (!ignoreReject)) {
       const G4TouchableHistory* touch = static_cast<const G4TouchableHistory*>(theTrack->GetTouchable());
       edm::LogVerbatim("CaloSim") << "CaloSD::ProcessHits: unitID= " << unitID << " currUnit=   " << currentID.unitID()
                                   << " Detector: " << GetName() << " trackID= " << theTrack->GetTrackID() << " "
                                   << theTrack->GetDefinition()->GetParticleName()
                                   << "\n Edep= " << aStep->GetTotalEnergyDeposit()
                                   << " PV: " << touch->GetVolume(0)->GetName()
                                   << " PVid= " << touch->GetReplicaNumber(0) << " MVid= " << touch->GetReplicaNumber(1);
     }
     return false;
   }
  
   if (aStep->GetTotalEnergyDeposit() == 0.0) {
     return false;
   }
  
   double energy = getEnergyDeposit(aStep);
   if (energy > 0.0) {
     if (G4TrackToParticleID::isGammaElectronPositron(theTrack)) {
       edepositEM = energy;
     } else {
       edepositHAD = energy;
     }
 #ifdef EDM_ML_DEBUG
     G4TouchableHistory* touch = (G4TouchableHistory*)(theTrack->GetTouchable());
     edm::LogVerbatim("CaloSim") << "CaloSD::" << GetName() << " PV:" << touch->GetVolume(0)->GetName()
                                 << " PVid=" << touch->GetReplicaNumber(0) << " MVid=" << touch->GetReplicaNumber(1)
                                 << " Unit:" << std::hex << unitID << std::dec << " Edep=" << edepositEM << " "
                                 << edepositHAD << " ID=" << theTrack->GetTrackID() << " pID=" << theTrack->GetParentID()
                                 << " E=" << theTrack->GetKineticEnergy() << " S=" << aStep->GetStepLength() << "\n "
                                 << theTrack->GetDefinition()->GetParticleName() << " primaryID= " << primaryID
                                 << " currentID= (" << currentID << ") previousID= (" << previousID << ")";
 #endif
     if (!hitExists(aStep)) {
       currentHit = createNewHit(aStep, aStep->GetTrack());
     }
     return true;
   }
   return false;
 }

References createNewHit(), currentHit, currentID, TauDecayModes::dec, LEDCalibrationChannels::depth, edepositEM, edepositHAD, HCALHighEnergyHPDFilter_cfi::energy, getDepth(), getEnergyDeposit(), getFromLibrary(), getTrackID(), hitExists(), ignoreReject, G4TrackToParticleID::isGammaElectronPositron(), isParameterized, SensitiveDetector::NaNTrap(), previousID, setDetUnitId(), CaloHitID::setID(), ntuplemaker::time, and CaloHitID::unitID().

◆ reset()

void CaloSD::reset ( void )

overridevirtual

Reimplemented from SensitiveCaloDetector.

Definition at line 643 of file CaloSD.cc.

                    {
   if (fpCaloG4HitAllocator) {
     fpCaloG4HitAllocator->ResetStorage();
   }
 }

References fpCaloG4HitAllocator.

◆ resetForNewPrimary()

void CaloSD::resetForNewPrimary ( const G4Step * aStep )

protected

Definition at line 504 of file CaloSD.cc.

                                                    {
   auto const preStepPoint = aStep->GetPreStepPoint();
   entrancePoint = preStepPoint->GetPosition();
   entranceLocal = setToLocal(entrancePoint, preStepPoint->GetTouchable());
   incidentEnergy = preStepPoint->GetKineticEnergy();
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD::resetForNewPrimary for " << GetName()
                               << " ID= " << aStep->GetTrack()->GetTrackID() << " Ein= " << incidentEnergy / CLHEP::GeV
                               << " GeV and"
                               << " entrance point global: " << entrancePoint << " local: " << entranceLocal;
 #endif
 }

References entranceLocal, entrancePoint, GeV, incidentEnergy, and setToLocal().

Referenced by HCalSD::getFromHFLibrary(), ZdcSD::getFromLibrary(), CastorSD::getFromLibrary(), HCalSD::getHitFibreBundle(), HCalSD::getHitPMT(), hitExists(), and setTrackID().

◆ saveHit()

bool CaloSD::saveHit ( CaloG4Hit * aHit )

private

Definition at line 730 of file CaloSD.cc.

                                     {
   int tkID;
   bool ok = true;
   if (m_trackManager) {
     tkID = m_trackManager->giveMotherNeeded(aHit->getTrackID());
     if (tkID == 0) {
       if (m_trackManager->trackExists(aHit->getTrackID()))
         tkID = (aHit->getTrackID());
       else {
         ok = false;
       }
     }
   } else {
     tkID = aHit->getTrackID();
     ok = false;
   }
 #ifdef EDM_ML_DEBUG
   if (!ok)
     edm::LogWarning("CaloSim") << "CaloSD:Cannot find track ID for " << aHit->getTrackID();
   edm::LogVerbatim("CaloSim") << "CalosD: Track ID " << aHit->getTrackID() << " changed to " << tkID
                               << " by SimTrackManager Status " << ok;
 #endif
   double time = aHit->getTimeSlice();
   if (corrTOFBeam)
     time += correctT;
   slave.get()->processHits(
       aHit->getUnitID(), aHit->getEM() / CLHEP::GeV, aHit->getHadr() / CLHEP::GeV, time, tkID, aHit->getDepth());
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: Store Hit at " << std::hex << aHit->getUnitID() << std::dec << " "
                               << aHit->getDepth() << " due to " << tkID << " in time " << time << " of energy "
                               << aHit->getEM() / CLHEP::GeV << " GeV (EM) and " << aHit->getHadr() / CLHEP::GeV
                               << " GeV (Hadr)";
 #endif
   return ok;
 }

References correctT, corrTOFBeam, TauDecayModes::dec, CaloG4Hit::getDepth(), CaloG4Hit::getEM(), CaloG4Hit::getHadr(), CaloG4Hit::getTimeSlice(), CaloG4Hit::getTrackID(), CaloG4Hit::getUnitID(), GeV, SimTrackManager::giveMotherNeeded(), m_trackManager, convertSQLiteXML::ok, slave, ntuplemaker::time, and SimTrackManager::trackExists().

Referenced by update().

◆ setDetUnitId()

uint32_t CaloSD::setDetUnitId ( const G4Step * step )

overridepure virtual

Implements SensitiveDetector.

Implemented in HCalSD, CastorSD, HcalTB02SD, AHCalSD, HGCSD, HFNoseSD, HGCalSD, HGCScintSD, EcalTBH4BeamSD, HcalTB06BeamSD, ZdcSD, HGCalTB16SD01, TotemT2ScintSD, ECalSD, and DreamSD.

Referenced by ProcessHits().

◆ setNumberCheckedHits()

void CaloSD::setNumberCheckedHits ( int val )

inlineprotected

Definition at line 116 of file CaloSD.h.

116 { nCheckedHits = val; }

References nCheckedHits, and heppy_batch::val.

Referenced by HFNoseSD::HFNoseSD(), HGCalSD::HGCalSD(), HGCScintSD::HGCScintSD(), and HGCSD::HGCSD().

◆ setParameterized()

void CaloSD::setParameterized ( bool val )

inlineprotected

Definition at line 104 of file CaloSD.h.

104 { isParameterized = val; }

References isParameterized, and heppy_batch::val.

Referenced by CastorSD::CastorSD(), HCalSD::HCalSD(), and ZdcSD::ZdcSD().

◆ setToGlobal()

G4ThreeVector CaloSD::setToGlobal	(	const G4ThreeVector &	local,
		const G4VTouchable *	touch
	)		const

protected

Definition at line 377 of file CaloSD.cc.

                                                                                              {
   return touch->GetHistory()->GetTopTransform().Inverse().TransformPoint(local);
 }

References DTRecHitClients_cfi::local.

◆ setToLocal()

G4ThreeVector CaloSD::setToLocal	(	const G4ThreeVector &	global,
		const G4VTouchable *	touch
	)		const

protected

Definition at line 373 of file CaloSD.cc.

                                                                                              {
   return touch->GetHistory()->GetTopTransform().TransformPoint(global);
 }

Referenced by DreamSD::curve_LY(), HcalTB02SD::curve_LY(), ECalSD::EnergyCorrected(), ECalSD::getDepth(), ECalSD::getRadiationLength(), resetForNewPrimary(), and HcalTB06BeamSD::setDetUnitId().

◆ setTrackID()

int CaloSD::setTrackID ( const G4Step * aStep )

protectedvirtual

Definition at line 674 of file CaloSD.cc.

                                           {
   auto const theTrack = aStep->GetTrack();
   TrackInformation* trkInfo = cmsTrackInformation(theTrack);
   int primaryID = (useFineCaloID_) ? trkInfo->getIDfineCalo() : trkInfo->getIDonCaloSurface();
   if (primaryID <= 0) {
     primaryID = theTrack->GetTrackID();
   }
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "Track ID: " << trkInfo->getIDfineCalo() << ":" << trkInfo->getIDonCaloSurface() << ":"
                               << theTrack->GetTrackID() << ":" << primaryID;
 #endif
  
   if (primaryID != previousID.trackID()) {
     resetForNewPrimary(aStep);
   }
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD::setTrackID for " << GetName()
                               << " trackID= " << aStep->GetTrack()->GetTrackID() << " primaryID= " << primaryID;
 #endif
   return primaryID;
 }

References SensitiveDetector::cmsTrackInformation(), TrackInformation::getIDfineCalo(), TrackInformation::getIDonCaloSurface(), previousID, resetForNewPrimary(), CaloHitID::trackID(), and useFineCaloID_.

Referenced by HCalSD::getFromHFLibrary(), ZdcSD::getFromLibrary(), CastorSD::getFromLibrary(), HCalSD::getFromParam(), and HCalSD::hitForFibre().

◆ setUseMap()

void CaloSD::setUseMap ( bool val )

inlineprotected

Definition at line 105 of file CaloSD.h.

105 { useMap = val; }

References useMap, and heppy_batch::val.

Referenced by HFNoseSD::HFNoseSD(), HGCalSD::HGCalSD(), HGCScintSD::HGCScintSD(), and HGCSD::HGCSD().

◆ storeHit()

void CaloSD::storeHit ( CaloG4Hit * hit )

private

Definition at line 718 of file CaloSD.cc.

                                     {
   if (hit == nullptr || previousID.trackID() < 0) {
     edm::LogWarning("CaloSim") << "CaloSD: hit to be stored is nullptr !!"
                                << " previousID.trackID()= " << previousID.trackID();
     return;
   }
  
   theHC->insert(hit);
   if (useMap)
     hitMap.insert(std::pair<CaloHitID, CaloG4Hit*>(previousID, hit));
 }

References hitMap, previousID, theHC, CaloHitID::trackID(), and useMap.

Referenced by createNewHit().

◆ update() [1/5]

void CaloSD::update ( const ::EndOfEvent * )

overrideprotected

Definition at line 575 of file CaloSD.cc.

                                      {
   endEvent();
   slave.get()->ReserveMemory(theHC->entries());
  
   int count(0);
   int wrong(0);
   double eEM(0.0);
   double eHAD(0.0);
   double eEM2(0.0);
   double eHAD2(0.0);
   double tt(0.0);
   double zloc(0.0);
   double zglob(0.0);
   double ee(0.0);
   int hc_entries = theHC->entries();
   for (int i = 0; i < hc_entries; ++i) {
     if (!saveHit((*theHC)[i])) {
       ++wrong;
     }
     ++count;
     double x = (*theHC)[i]->getEM();
     eEM += x;
     eEM2 += x * x;
     x = (*theHC)[i]->getHadr();
     eHAD += x;
     eHAD2 += x * x;
     tt += (*theHC)[i]->getTimeSlice();
     ee += (*theHC)[i]->getIncidentEnergy();
     zglob += std::abs((*theHC)[i]->getEntry().z());
     zloc += std::abs((*theHC)[i]->getEntryLocal().z());
   }
  
   double norm = (count > 0) ? 1.0 / count : 0.0;
   eEM *= norm;
   eEM2 *= norm;
   eHAD *= norm;
   eHAD2 *= norm;
   eEM2 = std::sqrt(eEM2 - eEM * eEM);
   eHAD2 = std::sqrt(eHAD2 - eHAD * eHAD);
   tt *= norm;
   ee *= norm;
   zglob *= norm;
   zloc *= norm;
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: " << GetName() << " store " << count << " hits; " << wrong
                               << " track IDs not given properly and " << totalHits - count
                               << " hits not passing cuts\n EmeanEM= " << eEM << " ErmsEM= " << eEM2
                               << "\n EmeanHAD= " << eHAD << " ErmsHAD= " << eHAD2 << " TimeMean= " << tt
                               << " E0mean= " << ee << " Zglob= " << zglob << " Zloc= " << zloc << " ";
 #endif
   tkMap.erase(tkMap.begin(), tkMap.end());
   std::vector<std::unique_ptr<CaloG4Hit>>().swap(reusehit);
   if (useMap)
     hitMap.erase(hitMap.begin(), hitMap.end());
 }

References funct::abs(), submitPVResolutionJobs::count, endEvent(), edm::roottree::getEntry(), hitMap, mps_fire::i, reusehit, saveHit(), slave, mathSSE::sqrt(), edm::swap(), theHC, tkMap, totalHits, groupFilesInBlocks::tt, useMap, x, and z.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

◆ update() [2/5]

void CaloSD::update ( const BeginOfEvent * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfEvent * >.

Definition at line 541 of file CaloSD.cc.

                                                {
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD: Dispatched BeginOfEvent for " << GetName() << " !";
 #endif
   clearHits();
   initEvent(g4Event);
 }

References clearHits(), and initEvent().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

◆ update() [3/5]

void CaloSD::update ( const BeginOfRun * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfRun * >.

Definition at line 539 of file CaloSD.cc.

539 { initRun(); }

References initRun().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

◆ update() [4/5]

void CaloSD::update ( const BeginOfTrack * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfTrack * >.

Definition at line 766 of file CaloSD.cc.

                                            {
   int primary = -1;
   TrackInformation* trkInfo = cmsTrackInformation((*trk)());
   if (trkInfo->isPrimary())
     primary = (*trk)()->GetTrackID();
  
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "New track: isPrimary " << trkInfo->isPrimary() << " primary ID = " << primary
                               << " primary ancestor ID " << primAncestor;
 #endif
  
   // update the information if a different primary track ID
  
   if (primary > 0 && primary != primAncestor) {
     primAncestor = primary;
  
     // clean the hits information
  
     if (theHC->entries() > 0)
       cleanHitCollection();
   }
 }

References cleanHitCollection(), SensitiveDetector::cmsTrackInformation(), TrackInformation::isPrimary(), primAncestor, and theHC.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

◆ update() [5/5]

void CaloSD::update ( const EndOfTrack * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const EndOfTrack * >.

Definition at line 549 of file CaloSD.cc.

                                          {
   int id = (*trk)()->GetTrackID();
   TrackInformation* trkI = cmsTrackInformation((*trk)());
   int lastTrackID = -1;
   if (trkI)
     lastTrackID = trkI->getIDonCaloSurface();
   if (id == lastTrackID) {
     const TrackContainer* trksForThisEvent = m_trackManager->trackContainer();
     if (trksForThisEvent != nullptr) {
       int it = (int)(trksForThisEvent->size()) - 1;
       if (it >= 0) {
         TrackWithHistory* trkH = (*trksForThisEvent)[it];
         if (trkH->trackID() == (unsigned int)(id))
           tkMap[id] = trkH;
 #ifdef EDM_ML_DEBUG
         edm::LogVerbatim("CaloSim") << "CaloSD: get track " << it << " from Container of size "
                                     << trksForThisEvent->size() << " with ID " << trkH->trackID();
       } else {
         edm::LogVerbatim("CaloSim") << "CaloSD: get track " << it << " from Container of size "
                                     << trksForThisEvent->size() << " with no ID";
 #endif
       }
     }
   }
 }

References SensitiveDetector::cmsTrackInformation(), TrackInformation::getIDonCaloSurface(), createfilelist::int, m_trackManager, tkMap, SimTrackManager::trackContainer(), and TrackWithHistory::trackID().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

◆ updateHit()

void CaloSD::updateHit ( CaloG4Hit * aHit )

protected

Definition at line 493 of file CaloSD.cc.

                                       {
   aHit->addEnergyDeposit(edepositEM, edepositHAD);
 #ifdef EDM_ML_DEBUG
   edm::LogVerbatim("CaloSim") << "CaloSD:" << GetName() << " Add energy deposit in " << currentID
                               << " Edep_em(MeV)= " << edepositEM << " Edep_had(MeV)= " << edepositHAD;
 #endif
  
   // buffer for next steps:
   previousID = currentID;
 }

References CaloG4Hit::addEnergyDeposit(), currentID, edepositEM, edepositHAD, and previousID.

Referenced by checkHit(), createNewHit(), hitExists(), processHit(), and ProcessHits().

Member Data Documentation

◆ cleanIndex

int CaloSD::cleanIndex

private

Definition at line 169 of file CaloSD.h.

Referenced by CaloSD(), cleanHitCollection(), and clearHits().

◆ correctT

double CaloSD::correctT

private

Definition at line 176 of file CaloSD.h.

Referenced by CaloSD(), cleanHitCollection(), and saveHit().

◆ corrTOFBeam

bool CaloSD::corrTOFBeam

private

Definition at line 165 of file CaloSD.h.

Referenced by CaloSD(), cleanHitCollection(), and saveHit().

◆ currentHit

CaloG4Hit* CaloSD::currentHit

protected

Definition at line 139 of file CaloSD.h.

Referenced by checkHit(), ZdcSD::getFromLibrary(), hitExists(), processHit(), and ProcessHits().

◆ currentID

CaloHitID CaloSD::currentID

protected

Definition at line 135 of file CaloSD.h.

Referenced by CaloSD(), checkHit(), createNewHit(), ECalSD::curve_LY(), HCalSD::getFromHFLibrary(), ZdcSD::getFromLibrary(), CastorSD::getFromLibrary(), HCalSD::getFromParam(), HCalSD::getHitFibreBundle(), HCalSD::getHitPMT(), hitExists(), HCalSD::hitForFibre(), processHit(), ProcessHits(), and updateHit().

◆ edepositEM

float CaloSD::edepositEM

protected

Definition at line 133 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), HCalSD::getFromHFLibrary(), ZdcSD::getFromLibrary(), CastorSD::getFromLibrary(), HCalSD::getFromParam(), HCalSD::getHitFibreBundle(), HCalSD::getHitPMT(), HCalSD::hitForFibre(), ProcessHits(), and updateHit().

◆ edepositHAD

float CaloSD::edepositHAD

protected

Definition at line 133 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), HCalSD::getFromHFLibrary(), ZdcSD::getFromLibrary(), CastorSD::getFromLibrary(), HCalSD::getFromParam(), HCalSD::getHitFibreBundle(), HCalSD::getHitPMT(), HCalSD::hitForFibre(), ProcessHits(), and updateHit().

◆ eminHit

double CaloSD::eminHit

protected

Definition at line 137 of file CaloSD.h.

Referenced by CaloSD(), filterHit(), and HGCSD::HGCSD().

◆ eminHitD

double CaloSD::eminHitD

private

Definition at line 175 of file CaloSD.h.

Referenced by CaloSD(), and filterHit().

◆ energyCut

double CaloSD::energyCut

protected

Definition at line 137 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), HCalSD::getHitFibreBundle(), and HCalSD::getHitPMT().

◆ entranceLocal

G4ThreeVector CaloSD::entranceLocal

protected

Definition at line 130 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), ZdcSD::getFromLibrary(), ProcessHits(), and resetForNewPrimary().

◆ entrancePoint

G4ThreeVector CaloSD::entrancePoint

protected

Definition at line 129 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), ZdcSD::getFromLibrary(), ProcessHits(), and resetForNewPrimary().

◆ fineDetectors_

std::vector<Detector> CaloSD::fineDetectors_

private

Definition at line 182 of file CaloSD.h.

Referenced by CaloSD(), and isItFineCalo().

◆ forceSave

bool CaloSD::forceSave

protected

Definition at line 144 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), ECalSD::getTrackID(), and getTrackID().

◆ hcID

int CaloSD::hcID

private

Definition at line 167 of file CaloSD.h.

Referenced by Initialize().

◆ hitMap

std::map<CaloHitID, CaloG4Hit*> CaloSD::hitMap

private

Definition at line 179 of file CaloSD.h.

Referenced by checkHit(), cleanHitCollection(), storeHit(), and update().

◆ ignoreReject

bool CaloSD::ignoreReject

private

Definition at line 163 of file CaloSD.h.

Referenced by ignoreRejection(), and ProcessHits().

◆ ignoreTrackID

bool CaloSD::ignoreTrackID

private

Definition at line 161 of file CaloSD.h.

Referenced by CaloSD().

◆ incidentEnergy

float CaloSD::incidentEnergy

protected

Definition at line 132 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), ZdcSD::getFromLibrary(), ProcessHits(), and resetForNewPrimary().

◆ isParameterized

bool CaloSD::isParameterized

private

Definition at line 162 of file CaloSD.h.

Referenced by CaloSD(), ProcessHits(), and setParameterized().

◆ kmaxIon

double CaloSD::kmaxIon

protected

Definition at line 142 of file CaloSD.h.

Referenced by CaloSD(), ECalSD::ECalSD(), ECalSD::getEnergyDeposit(), HCalSD::getEnergyDeposit(), and HCalSD::HCalSD().

◆ kmaxNeutron

double CaloSD::kmaxNeutron

protected

Definition at line 142 of file CaloSD.h.

Referenced by CaloSD(), ECalSD::ECalSD(), ECalSD::getEnergyDeposit(), HCalSD::getEnergyDeposit(), and HCalSD::HCalSD().

◆ kmaxProton

double CaloSD::kmaxProton

protected

Definition at line 142 of file CaloSD.h.

Referenced by CaloSD(), ECalSD::ECalSD(), ECalSD::getEnergyDeposit(), HCalSD::getEnergyDeposit(), and HCalSD::HCalSD().

◆ m_trackManager

const SimTrackManager* CaloSD::m_trackManager

private

Definition at line 154 of file CaloSD.h.

Referenced by saveHit(), and update().

◆ meanResponse

std::unique_ptr<CaloMeanResponse> CaloSD::meanResponse

private

Definition at line 157 of file CaloSD.h.

Referenced by CaloSD(), and getResponseWt().

◆ nCheckedHits

int CaloSD::nCheckedHits

private

Definition at line 172 of file CaloSD.h.

Referenced by CaloSD(), checkHit(), and setNumberCheckedHits().

◆ posGlobal

G4ThreeVector CaloSD::posGlobal

protected

Definition at line 131 of file CaloSD.h.

Referenced by CaloSD(), createNewHit(), ZdcSD::getFromLibrary(), hitExists(), and ProcessHits().

◆ previousID

CaloHitID CaloSD::previousID

protected

Definition at line 135 of file CaloSD.h.

Referenced by CaloSD(), clearHits(), hitExists(), processHit(), ProcessHits(), setTrackID(), storeHit(), and updateHit().

◆ primAncestor

int CaloSD::primAncestor

private

Definition at line 168 of file CaloSD.h.

Referenced by CaloSD(), and update().

◆ primIDSaved

int CaloSD::primIDSaved

private

Definition at line 171 of file CaloSD.h.

Referenced by CaloSD(), clearHits(), and createNewHit().

◆ reusehit

std::vector<std::unique_ptr<CaloG4Hit> > CaloSD::reusehit

private

Definition at line 181 of file CaloSD.h.

Referenced by cleanHitCollection(), createNewHit(), and update().

◆ slave

std::unique_ptr<CaloSlaveSD> CaloSD::slave

private

Definition at line 156 of file CaloSD.h.

Referenced by CaloSD(), clearHits(), fillHits(), saveHit(), and update().

◆ suppressHeavy

bool CaloSD::suppressHeavy

protected

Definition at line 141 of file CaloSD.h.

Referenced by CaloSD(), ECalSD::ECalSD(), ECalSD::getEnergyDeposit(), HCalSD::getEnergyDeposit(), and HCalSD::HCalSD().

◆ theHC

CaloG4HitCollection* CaloSD::theHC

private

Definition at line 159 of file CaloSD.h.

Referenced by checkHit(), cleanHitCollection(), EndOfEvent(), getNumberOfHits(), Initialize(), PrintAll(), storeHit(), and update().

◆ timeSlice

float CaloSD::timeSlice

private

Definition at line 174 of file CaloSD.h.

Referenced by CaloSD().

◆ tkMap

std::map<int, TrackWithHistory*> CaloSD::tkMap

private

Definition at line 180 of file CaloSD.h.

Referenced by createNewHit(), and update().

◆ tmaxHit

double CaloSD::tmaxHit

protected

Definition at line 137 of file CaloSD.h.

Referenced by CaloSD(), HGCScintSD::filterHit(), HFNoseSD::filterHit(), HGCalSD::filterHit(), AHCalSD::filterHit(), HGCSD::filterHit(), HCalSD::filterHit(), and filterHit().

◆ totalHits

int CaloSD::totalHits

private

Definition at line 170 of file CaloSD.h.

Referenced by CaloSD(), cleanHitCollection(), createNewHit(), Initialize(), and update().

◆ useFineCaloID_

bool CaloSD::useFineCaloID_

private

Definition at line 177 of file CaloSD.h.

Referenced by CaloSD(), getTrackID(), and setTrackID().

◆ useMap

bool CaloSD::useMap

private

Definition at line 164 of file CaloSD.h.

Referenced by CaloSD(), checkHit(), cleanHitCollection(), createNewHit(), setUseMap(), storeHit(), and update().

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaloSD()

◆ ~CaloSD()

Member Function Documentation

◆ checkHit()

◆ cleanHitCollection()

◆ clear()

◆ clearHits()

◆ createNewHit()

◆ DrawAll()

◆ endEvent()

◆ EndOfEvent()

◆ EnergyCorrected()

◆ fillHits()

◆ filterHit()

◆ getAttenuation()

◆ getDepth()

◆ getEnergyDeposit()

◆ getFromLibrary()

◆ getNumberOfHits()

◆ getResponseWt()

◆ getTrackID()

◆ hitExists()

◆ ignoreRejection()

◆ initEvent()

◆ Initialize()

◆ initRun()

◆ isItFineCalo()

◆ PrintAll()

◆ processHit()

◆ ProcessHits() [1/2]

◆ ProcessHits() [2/2]

◆ reset()

◆ resetForNewPrimary()

◆ saveHit()

◆ setDetUnitId()

◆ setNumberCheckedHits()

◆ setParameterized()

◆ setToGlobal()

◆ setToLocal()

◆ setTrackID()

◆ setUseMap()

◆ storeHit()

◆ update() [1/5]

◆ update() [2/5]

◆ update() [3/5]

◆ update() [4/5]

◆ update() [5/5]

◆ updateHit()

Member Data Documentation

◆ cleanIndex

◆ correctT

◆ corrTOFBeam

◆ currentHit

◆ currentID

◆ edepositEM

◆ edepositHAD

◆ eminHit

◆ eminHitD

◆ energyCut

◆ entranceLocal

◆ entrancePoint

◆ fineDetectors_

◆ forceSave

◆ hcID

◆ hitMap

◆ ignoreReject

◆ ignoreTrackID

◆ incidentEnergy

◆ isParameterized

◆ kmaxIon

◆ kmaxNeutron