#include <CaloSD.h>

Inheritance diagram for CaloSD:

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

virtual double	getEnergyDeposit (G4Step *step)

void	Initialize (G4HCofThisEvent *HCE) override

void	PrintAll () override

bool	ProcessHits (G4Step step, G4TouchableHistory tHistory) override

bool	ProcessHits (G4GFlashSpot aSpot, G4TouchableHistory ) override

uint32_t	setDetUnitId (const G4Step *step) override=0

	~CaloSD () override

Public Member Functions inherited from SensitiveCaloDetector
	SensitiveCaloDetector (const std::string &iname, const DDCompactView &cpv, 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

	SensitiveDetector (const std::string &iname, const DDCompactView &cpv, const SensitiveDetectorCatalog &, edm::ParameterSet const &p)

	~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
G4bool	checkHit ()

CaloG4Hit *	createNewHit ()

virtual bool	filterHit (CaloG4Hit *, double)

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

virtual uint16_t	getDepth (const G4Step *)

int	getNumberOfHits ()

double	getResponseWt (const G4Track *)

virtual G4bool	getStepInfo (G4Step *aStep)

virtual int	getTrackID (const G4Track *)

G4bool	hitExists ()

virtual void	initRun ()

void	resetForNewPrimary (const G4ThreeVector &, double)

G4ThreeVector	setToGlobal (const G4ThreeVector &, const G4VTouchable *)

G4ThreeVector	setToLocal (const G4ThreeVector &, const G4VTouchable *)

void	update (const BeginOfRun *) override
	This routine will be called when the appropriate signal arrives. More...

void	update (const BeginOfEvent *) 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	update (const ::EndOfEvent *) override

void	updateHit (CaloG4Hit *)

Protected Member Functions inherited from SensitiveDetector
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
int	checkHits

double	correctT

bool	corrTOFBeam

CaloG4Hit *	currentHit

CaloHitID	currentID

float	edepositEM

float	edepositHAD

double	eminHit

double	eminHitD

G4int	emPDG

double	energyCut

G4ThreeVector	entranceLocal

G4ThreeVector	entrancePoint

G4int	epPDG

bool	forceSave

G4int	gammaPDG

float	incidentEnergy

double	kmaxIon

double	kmaxNeutron

double	kmaxProton

const SimTrackManager *	m_trackManager

G4ThreeVector	posGlobal

G4StepPoint *	preStepPoint

CaloHitID	previousID

int	primIDSaved

bool	runInit

bool	suppressHeavy

G4Track *	theTrack

double	tmaxHit

bool	useMap

Private Member Functions
void	cleanHitCollection ()

bool	saveHit (CaloG4Hit *)

void	storeHit (CaloG4Hit *)

void	summarize ()

Private Attributes
int	cleanIndex

int	hcID

std::map< CaloHitID, CaloG4Hit * >	hitMap

std::vector< CaloG4Hit * >	hitvec

bool	ignoreTrackID

CaloMeanResponse *	meanResponse

int	primAncestor

std::vector< CaloG4Hit * >	reusehit

std::vector< unsigned int >	selIndex

CaloSlaveSD *	slave

CaloG4HitCollection *	theHC

float	timeSlice

std::map< int, TrackWithHistory * >	tkMap

int	totalHits

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

Detailed Description

Definition at line 42 of file CaloSD.h.

Constructor & Destructor Documentation

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

Definition at line 24 of file CaloSD.cc.

References checkHits, cleanIndex, correctT, corrTOFBeam, currentID, eminHit, eminHitD, energyCut, forceSave, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), GeV, ignoreTrackID, gen::k, kmaxIon, kmaxNeutron, kmaxProton, meanResponse, MeV, previousID, primAncestor, slave, suppressHeavy, timeSlice, tmaxHit, totalHits, and useMap.

                                               : 
   SensitiveCaloDetector(name, cpv, clg, p),
   G4VGFlashSensitiveDetector(), theTrack(nullptr), preStepPoint(nullptr), eminHit(0), 
   eminHitD(0), m_trackManager(manager), currentHit(nullptr), runInit(false),
   timeSlice(timeSliceUnit), ignoreTrackID(ignoreTkID), hcID(-1), theHC(nullptr), 
   meanResponse(nullptr) {
 
   //Parameters
   edm::ParameterSet m_CaloSD = p.getParameter<edm::ParameterSet>("CaloSD");
   energyCut    = m_CaloSD.getParameter<double>("EminTrack")*GeV;
   tmaxHit      = m_CaloSD.getParameter<double>("TmaxHit")*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")*MeV;
   kmaxProton   = m_CaloSD.getParameter<double>("ProtonThreshold")*MeV;
   kmaxNeutron  = m_CaloSD.getParameter<double>("NeutronThreshold")*MeV;
   checkHits    = 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")*cm;
   correctT     = beamZ/c_light/nanosecond;
 
   SetVerboseLevel(verbn);
   for (unsigned int k=0; k<hcn.size(); ++k) {
     if (name == (G4String)(hcn[k])) {
       if (k < eminHits.size()) eminHit = eminHits[k]*MeV;
       if (k < eminHitX.size()) eminHitD= eminHitX[k]*MeV;
       if (k < tmaxHits.size()) tmaxHit = tmaxHits[k]*ns;
       if (k < useResMap.size() && useResMap[k] > 0) meanResponse = new CaloMeanResponse(p);
       break;
     }
   }
   slave      = new CaloSlaveSD(name);
   currentID  = CaloHitID(timeSlice, ignoreTrackID);
   previousID = CaloHitID(timeSlice, ignoreTrackID);
   
   primAncestor = 0;
   cleanIndex = 0;
   totalHits = 0;
   forceSave = false;
 
   edm::LogInfo("CaloSim") << "CaloSD: Minimum energy of track for saving it " 
                           << energyCut/GeV  << " GeV" << "\n"
                           << "        Use of HitID Map " << useMap << "\n"
                           << "        Check last " << checkHits 
                           << " 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/MeV
                           << " MeV (for depth 0) or " << eminHitD/MeV
                           << " MeV (for nonzero depths); Time Slice Unit " 
                           << timeSlice << " Ignore TrackID Flag " << ignoreTrackID;
 }

CaloSD::~CaloSD ( )

override

Definition at line 87 of file CaloSD.cc.

References meanResponse, slave, and theHC.

                 { 
   delete slave; 
   delete theHC;
   delete meanResponse;
 }

Member Function Documentation

G4bool CaloSD::checkHit ( )

protected

Definition at line 305 of file CaloSD.cc.

References checkHits, currentHit, currentID, runEdmFileComparison::found, hitMap, theHC, updateHit(), and useMap.

Referenced by CastorSD::getFromLibrary(), HCalSD::getFromLibrary(), HCalSD::getFromParam(), HCalSD::getHitFibreBundle(), HCalSD::getHitPMT(), hitExists(), HCalSD::hitForFibre(), and ProcessHits().

                         {  
   //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 (checkHits <= 0) return false;
     int  minhit= (theHC->entries()>checkHits ? theHC->entries()-checkHits : 0);
     int  maxhit= theHC->entries()-1;
     
     for (int j=maxhit; j>minhit&&!found; --j) {
       if ((*theHC)[j]->getID() == currentID) {
         currentHit = (*theHC)[j];
         found      = true;
       }
     }          
   }
   
   if (found) {
     updateHit(currentHit);
     return true;
   } else {
     return false;
   }
 }

void CaloSD::cleanHitCollection ( )

private

Definition at line 662 of file CaloSD.cc.

References cleanIndex, correctT, corrTOFBeam, cond::serialization::equal(), filterHit(), CaloG4Hit::getTimeSlice(), hitMap, hitvec, mps_fire::i, cuy::ii, PFRecoTauDiscriminationByIsolation_cfi::offset, reusehit, selIndex, edm::swap(), theHC, ntuplemaker::time, totalHits, and useMap.

Referenced by EndOfEvent(), and update().

                                 {
   std::vector<CaloG4Hit*>* theCollection = theHC->GetVector();
 
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: collection before merging, size = " << theHC->entries();
 #endif
   
   selIndex.reserve(theHC->entries()-cleanIndex);
   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 ) {
     hitvec.swap(*theCollection);
     sort((hitvec.begin()+cleanIndex), hitvec.end(), CaloG4HitLess());
 #ifdef DebugLog
     edm::LogInfo("CaloSim") << "CaloSD::cleanHitCollection: sort hits in buffer "
                 << "starting from element = " << cleanIndex;
     for (unsigned int i = 0; i<hitvec.size(); ++i) 
       edm::LogInfo("CaloSim") << i << " " << *hitvec[i];
 #endif
     unsigned int i, j;
     CaloG4HitEqual equal;
     for (i=cleanIndex; i<hitvec.size(); ++i) {
       selIndex.push_back(i-cleanIndex);
       int jump = 0;
       for (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.push_back(hitvec[j]);
       }
       i+=jump;
     }
 #ifdef DebugLog
     edm::LogInfo("CaloSim") << "CaloSD: cleanHitCollection merge the hits in buffer ";
     for (unsigned int i = 0; i<hitvec.size(); ++i) 
       edm::LogInfo("CaloSim") << i << " " << *hitvec[i];
 #endif
     for ( unsigned int i = cleanIndex; i < cleanIndex+selIndex.size(); ++i ) {
       hitvec[i] = hitvec[selIndex[i-cleanIndex]+cleanIndex];
     }
     hitvec.resize(cleanIndex+selIndex.size());
 #ifdef DebugLog
     edm::LogInfo("CaloSim") << "CaloSD::cleanHitCollection: remove the merged hits in buffer,"
                 << " new size = " << hitvec.size();
     for (unsigned int i = 0; i<hitvec.size(); ++i) 
       edm::LogInfo("CaloSim") << i << " " << *hitvec[i];
 #endif
     hitvec.swap(*theCollection);
     std::vector<CaloG4Hit*>().swap(hitvec);
     selIndex.clear();
     totalHits = theHC->entries();
   }
 
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: collection after merging, size = " << theHC->entries();
 #endif
 
   int addhit = 0;
 
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: Size of reusehit after merge = " << reusehit.size();
   edm::LogInfo("CaloSim") << "CaloSD: Starting hit selection from index = " << cleanIndex;
 #endif
   
   selIndex.reserve(theCollection->size()-cleanIndex);
   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 DebugLog
       edm::LogInfo("CaloSim") << "CaloSD: dropped CaloG4Hit " << " " << *aHit; 
 #endif
       
       // create the list of hits to be reused
       
       reusehit.push_back((*theCollection)[i]);
       ++addhit;
     } else {
       selIndex.push_back(i-cleanIndex);
     }
   }
 
 #ifdef DebugLog
   edm::LogInfo("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);
       }
     }
   }
   for (unsigned int j = 0; j<selIndex.size(); ++j) {
     (*theCollection)[cleanIndex+j] = (*theCollection)[cleanIndex+selIndex[j]];
   }
 
   theCollection->resize(cleanIndex+selIndex.size());
   std::vector<unsigned int>().swap(selIndex);
 
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: hit collection after selection, size = "
               << theHC->entries();
   theHC->PrintAllHits();
 #endif
     
   cleanIndex = theHC->entries();
 }

void CaloSD::clear ( void )

override

Definition at line 208 of file CaloSD.cc.

208 {}

void CaloSD::clearHits ( )

overridevirtual

Implements SensitiveDetector.

Definition at line 530 of file CaloSD.cc.

References cleanIndex, hitMap, mps_fire::i, CaloSlaveSD::Initialize(), previousID, primIDSaved, CaloHitID::reset(), reusehit, slave, edm::swap(), and useMap.

Referenced by update().

                        {  
   if (useMap) hitMap.erase (hitMap.begin(), hitMap.end());
   for (unsigned int i = 0; i<reusehit.size(); ++i) delete reusehit[i];
   std::vector<CaloG4Hit*>().swap(reusehit);
   cleanIndex  = 0;
   previousID.reset();
   primIDSaved = -99;
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: Clears hit vector for " << GetName() << " " << slave;
 #endif
   slave->Initialize();
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: Initialises slave SD for " << GetName();
 #endif
 }

CaloG4Hit * CaloSD::createNewHit ( )

protected

Definition at line 337 of file CaloSD.cc.

References currentID, CaloHitID::depth(), edepositEM, edepositHAD, energyCut, entranceLocal, entrancePoint, forceSave, GeV, incidentEnergy, TrackWithHistory::momentum(), NULL, 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(), theTrack, CaloHitID::timeSliceID(), tkMap, totalHits, CaloHitID::trackID(), CaloHitID::unitID(), updateHit(), and useMap.

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

                                 {
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD::CreateNewHit for"
               << " Unit " << currentID.unitID() 
               << " " << currentID.depth()
               << " Edeposit = " << edepositEM << " " << edepositHAD;
   edm::LogInfo("CaloSim") << " primary "    << currentID.trackID()
               << " time slice " << currentID.timeSliceID()
               << " For Track  " << theTrack->GetTrackID()
               << " which is a " <<theTrack->GetDefinition()->GetParticleName()
               << " of energy "  << theTrack->GetKineticEnergy()/GeV
               << " " << theTrack->GetMomentum().mag()/GeV
               << " daughter of part. " << theTrack->GetParentID()
               << " and created by " ;
   
   if (theTrack->GetCreatorProcess()!=NULL)
     edm::LogInfo("CaloSim") << theTrack->GetCreatorProcess()->GetProcessName();
   else 
     edm::LogInfo("CaloSim") << "NO process";
 #endif  
   
   CaloG4Hit* aHit;
   if (!reusehit.empty()) {
     aHit = reusehit[0];
     aHit->setEM(0.);
     aHit->setHadr(0.);
     reusehit.erase(reusehit.begin());
   } 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();
     //edm::LogInfo("CaloSim") << "CaloSD: set save the track " << currentID.trackID()
     //      << " etrack " << etrack << " eCut " << energyCut << " flag " << forceSave;
     if (etrack >= energyCut || forceSave) {
       TrackInformation* trkInfo = (TrackInformation *)(theTrack->GetUserInformation());
       trkInfo->storeTrack(true);
       trkInfo->putInHistory();
       //      trkInfo->setAncestor();
 #ifdef DebugLog
       edm::LogInfo("CaloSim") << "CaloSD: set save the track " 
                   << currentID.trackID() << " with Hit";
 #endif
     }
   } else {
     TrackWithHistory * trkh = tkMap[currentID.trackID()];
 #ifdef DebugLog
     edm::LogInfo("CaloSim") << "CaloSD : TrackwithHistory pointer for " 
                 << currentID.trackID() << " is " << trkh;
 #endif
     if (trkh != nullptr) {
       etrack = sqrt(trkh->momentum().Mag2());
       if (etrack >= energyCut) {
         trkh->save();
 #ifdef DebugLog
     edm::LogInfo("CaloSim") << "CaloSD: set save the track " 
                 << currentID.trackID() << " with Hit";
 #endif
       }
     }
   }
   primIDSaved = currentID.trackID();
   if (useMap) totalHits++;
   return aHit;
 }  

void CaloSD::DrawAll ( )

override

Definition at line 210 of file CaloSD.cc.

210 {}

void CaloSD::EndOfEvent ( G4HCofThisEvent * eventHC )

override

Definition at line 196 of file CaloSD.cc.

References cleanHitCollection(), and theHC.

                                          {
   // clean the hits for the last tracks
   
   cleanHitCollection();
   
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: EndofEvent entered with " << theHC->entries()
                           << " entries";
 #endif
   //  TimeMe("CaloSD:sortAndMergeHits",false);
 }

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

overridevirtual

Implements SensitiveCaloDetector.

Definition at line 219 of file CaloSD.cc.

References CaloSlaveSD::Clean(), CaloSlaveSD::hits(), CaloSlaveSD::name(), and slave.

                                                                       {
   if (slave->name() == hname) { cc=slave->hits(); }
   slave->Clean();
 }

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

protectedvirtual

Reimplemented in HCalSD, HGCSD, and AHCalSD.

Definition at line 571 of file CaloSD.cc.

References eminHit, eminHitD, CaloG4Hit::getDepth(), CaloG4Hit::getEnergyDeposit(), and tmaxHit.

Referenced by cleanHitCollection().

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

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

protected

Definition at line 439 of file CaloSD.cc.

References funct::abs(), EnergyCorrector::c, ALCARECOTkAlJpsiMuMu_cff::charge, and mps_merge::weight.

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

                                                                                            {
   double weight = 1.;
   double charge = aStep->GetPreStepPoint()->GetCharge();
 
   if (charge != 0. && aStep->GetStepLength() > 0) {
     G4Material* mat = aStep->GetPreStepPoint()->GetMaterial();
     double density = mat->GetDensity();
     double dedx    = aStep->GetTotalEnergyDeposit()/aStep->GetStepLength();
     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 DebugLog
     edm::LogInfo("CaloSim") << "CaloSD::getAttenuation in " << mat->GetName() 
                 << " Charge " << charge << " dE/dx " << dedx 
                 << " Birk Const " << rkb << ", " << c << " Weight = " 
                 << weight << " dE " << aStep->GetTotalEnergyDeposit();
 #endif
   }
   return weight;
 }

uint16_t CaloSD::getDepth ( const G4Step * )

protectedvirtual

Reimplemented in ECalSD.

Definition at line 569 of file CaloSD.cc.

Referenced by getStepInfo(), and ProcessHits().

569 { return 0; }

double CaloSD::getEnergyDeposit ( G4Step * step )

virtual

Reimplemented in HCalSD, ECalSD, CastorSD, HcalTB02SD, HGCSD, HcalTB06BeamSD, EcalTBH4BeamSD, HGCalTB16SD01, and AHCalSD.

Definition at line 177 of file CaloSD.cc.

Referenced by getStepInfo().

                                              {
   return aStep->GetTotalEnergyDeposit();
 }

int CaloSD::getNumberOfHits ( )

protected

Definition at line 335 of file CaloSD.cc.

References theHC.

Referenced by HCalSD::ProcessHits().

335 { return theHC->entries(); }

CaloSD::theHC

CaloG4HitCollection * theHC

Definition: CaloSD.h:146

double CaloSD::getResponseWt ( const G4Track * aTrack )

protected

Definition at line 581 of file CaloSD.cc.

References TrackInformation::genParticleP(), TrackInformation::genParticlePID(), CaloMeanResponse::getWeight(), and meanResponse.

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

                                                   {
   if (meanResponse) {
     TrackInformation * trkInfo = (TrackInformation *)(aTrack->GetUserInformation());
     return meanResponse->getWeight(trkInfo->genParticlePID(), trkInfo->genParticleP());
   } else {
     return 1;
   }
 }

bool CaloSD::getStepInfo ( G4Step * aStep )

protectedvirtual

Reimplemented in DreamSD.

Definition at line 224 of file CaloSD.cc.

References currentID, TauDecayModes::dec, egammaForCoreTracking_cff::depth, edepositEM, edepositHAD, emPDG, epPDG, RemoveAddSevLevel::flag, gammaPDG, getDepth(), getEnergyDeposit(), getTrackID(), preStepPoint, setDetUnitId(), CaloHitID::setID(), theTrack, ntuplemaker::time, and CaloHitID::unitID().

Referenced by ZdcSD::ProcessHits(), HGCSD::ProcessHits(), HCalSD::ProcessHits(), and ProcessHits().

                                       {  
 
   preStepPoint = aStep->GetPreStepPoint(); 
   theTrack     = aStep->GetTrack();   
   
   double       time  = (aStep->GetPostStepPoint()->GetGlobalTime())/nanosecond;
   unsigned int unitID= setDetUnitId(aStep);
   uint16_t     depth = getDepth(aStep);
   int          primaryID = getTrackID(theTrack);
   
   bool flag = (unitID > 0);
   if (flag) {
     currentID.setID(unitID, time, primaryID, depth);
 #ifdef DebugLog
     G4TouchableHistory* touch =(G4TouchableHistory*)(theTrack->GetTouchable());
     edm::LogInfo("CaloSim") << "CaloSD:: GetStepInfo for"
                 << " PV "     << touch->GetVolume(0)->GetName()
                 << " PVid = " << touch->GetReplicaNumber(0)
                 << " MVid = " << touch->GetReplicaNumber(1)
                 << " Unit   " << currentID.unitID() 
                 << " Edeposit = " << edepositEM << " " << edepositHAD;
   } else {
     G4TouchableHistory* touch =(G4TouchableHistory*)(theTrack->GetTouchable());
     edm::LogInfo("CaloSim") << "CaloSD:: GetStepInfo for"
                 << " PV "     << touch->GetVolume(0)->GetName()
                 << " PVid = " << touch->GetReplicaNumber(0)
                 << " MVid = " << touch->GetReplicaNumber(1)
                 << " Unit   " << std::hex << unitID << std::dec 
                 << " Edeposit = " << edepositEM << " " << edepositHAD;
 #endif
   }
   
   G4int particleCode = theTrack->GetDefinition()->GetPDGEncoding();
   if (particleCode == emPDG ||
       particleCode == epPDG ||
       particleCode == gammaPDG ) {
     edepositEM  = getEnergyDeposit(aStep);
     edepositHAD = 0.;
   } else {
     edepositEM  = 0.;
     edepositHAD = getEnergyDeposit(aStep);
   }
 
   return flag;
 }

int CaloSD::getTrackID ( const G4Track * aTrack )

protectedvirtual

Reimplemented in ECalSD.

Definition at line 548 of file CaloSD.cc.

References forceSave, TrackInformation::getIDonCaloSurface(), and preStepPoint.

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

                                             {
   int primaryID = 0;
   forceSave = false;
   TrackInformation* trkInfo=(TrackInformation *)(aTrack->GetUserInformation());
   if (trkInfo) {
     primaryID = trkInfo->getIDonCaloSurface(); 
 #ifdef DebugLog
     edm::LogInfo("CaloSim") << "CaloSD: hit update from track Id on Calo Surface " 
                 << trkInfo->getIDonCaloSurface();
 #endif   
   } else {
     primaryID = aTrack->GetTrackID();
 #ifdef DebugLog
     edm::LogWarning("CaloSim") << "CaloSD: Problem with primaryID **** set by "
                                << "force to TkID **** " << primaryID << " in "
                                << preStepPoint->GetTouchable()->GetVolume(0)->GetName();
 #endif
   }
   return primaryID;
 }

G4bool CaloSD::hitExists ( )

protected

Definition at line 284 of file CaloSD.cc.

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

Referenced by ZdcSD::ProcessHits(), DreamSD::ProcessHits(), HGCSD::ProcessHits(), HCalSD::ProcessHits(), and ProcessHits().

                          {
 #ifdef DebugLog
   if (currentID.trackID()<1)
     edm::LogWarning("CaloSim") << "***** CaloSD error: primaryID = " 
                                << currentID.trackID()
                                << " maybe detector name changed";
 #endif  
   // 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 = preStepPoint->GetPosition();
   if (currentID.trackID() != previousID.trackID()) { 
     resetForNewPrimary(posGlobal, preStepPoint->GetKineticEnergy());
   }
   return checkHit();
 }

void CaloSD::Initialize ( G4HCofThisEvent * HCE )

override

Definition at line 181 of file CaloSD.cc.

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

                                              { 
   totalHits = 0;
   
 #ifdef DebugLog
   edm::LogInfo("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]);
   HCE->AddHitsCollection(hcID, theHC);
 }

void CaloSD::initRun ( )

protectedvirtual

Reimplemented in CastorSD, HCalSD, HGCSD, DreamSD, and ZdcSD.

Definition at line 546 of file CaloSD.cc.

Referenced by update().

546 {}

void CaloSD::PrintAll ( )

override

Definition at line 212 of file CaloSD.cc.

References theHC.

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

bool CaloSD::ProcessHits	(	G4Step *	step,
		G4TouchableHistory *	tHistory
	)

overridevirtual

Implements SensitiveDetector.

Reimplemented in HCalSD, HGCSD, DreamSD, and ZdcSD.

Definition at line 93 of file CaloSD.cc.

References createNewHit(), currentHit, edepositEM, edepositHAD, getStepInfo(), hitExists(), and SensitiveDetector::NaNTrap().

                                                               {
   
   NaNTrap( aStep ) ;
   
   if (aStep == nullptr) {
     return true;
   } else {
     if (getStepInfo(aStep)) {
       if (hitExists() == false && edepositEM+edepositHAD>0.) 
         currentHit = createNewHit();
     }
   }
   return true;
 } 

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

override

Definition at line 108 of file CaloSD.cc.

References checkHit(), createNewHit(), currentHit, currentID, TauDecayModes::dec, egammaForCoreTracking_cff::depth, edepositEM, edepositHAD, emPDG, entranceLocal, entrancePoint, epPDG, gammaPDG, getDepth(), getTrackID(), GeV, incidentEnergy, LogDebug, posGlobal, preStepPoint, previousID, setDetUnitId(), CaloHitID::setID(), theTrack, ntuplemaker::time, CaloHitID::trackID(), CaloHitID::unitID(), and updateHit().

                                                                  { 
 
   if (aSpot != nullptr) {   
     theTrack = const_cast<G4Track *>(aSpot->GetOriginatorTrack()->GetPrimaryTrack());
     G4int particleCode = theTrack->GetDefinition()->GetPDGEncoding();
     
     if (particleCode == emPDG ||
         particleCode == epPDG ||
         particleCode == gammaPDG ) {
       edepositEM  = aSpot->GetEnergySpot()->GetEnergy();
       edepositHAD = 0.;
     } else {
       edepositEM  = 0.;
       edepositHAD = 0.;
     }
  
     if (edepositEM>0.) {
       G4Step *      fFakeStep          = new G4Step();
       preStepPoint                     = fFakeStep->GetPreStepPoint();
       G4StepPoint * fFakePostStepPoint = fFakeStep->GetPostStepPoint();
       preStepPoint->SetPosition(aSpot->GetPosition());
       fFakePostStepPoint->SetPosition(aSpot->GetPosition());
       
       G4TouchableHandle fTouchableHandle   = aSpot->GetTouchableHandle();
       preStepPoint->SetTouchableHandle(fTouchableHandle);
       fFakeStep->SetTotalEnergyDeposit(aSpot->GetEnergySpot()->GetEnergy());
       
       double       time   = 0;
       unsigned int unitID = setDetUnitId(fFakeStep);
       int          primaryID = getTrackID(theTrack);
       uint16_t     depth = getDepth(fFakeStep);
 
       if (unitID > 0) {
         currentID.setID(unitID, time, primaryID, depth);
 #ifdef DebugLog
         LogDebug("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 = theTrack->GetKineticEnergy();
 #ifdef DebugLog
             LogDebug("CaloSim") << "CaloSD: Incident energy " 
                                 << incidentEnergy/GeV << " GeV and" 
                                 << " entrance point " << entrancePoint 
                                 << " (Global) " << entranceLocal << " (Local)";
 #endif
           }
 
           if (checkHit() == false) currentHit = createNewHit();
         }
       }
       delete  fFakeStep;
     }
     return true;
   } 
   return false;
 }                                   

void CaloSD::resetForNewPrimary	(	const G4ThreeVector &	point,
		double	energy
	)

protected

Definition at line 428 of file CaloSD.cc.

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

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

                                                                          { 
   entrancePoint  = point;
   entranceLocal  = setToLocal(entrancePoint, preStepPoint->GetTouchable());
   incidentEnergy = energy;
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: Incident energy " << incidentEnergy/GeV 
               << " GeV and" << " entrance point " << entrancePoint 
               << " (Global) " << entranceLocal << " (Local)";
 #endif
 }

bool CaloSD::saveHit ( CaloG4Hit * aHit )

private

Definition at line 601 of file CaloSD.cc.

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

Referenced by update().

                                     {  
   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;
   }
   //  edm::LogInfo("CaloSim") << "CalosD: Track ID " << aHit->getTrackID() << " changed to " << tkID << " by SimTrackManager" << " Status " << ok;
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CalosD: Track ID " << aHit->getTrackID() 
               << " changed to " << tkID << " by SimTrackManager"
               << " Status " << ok;
 #endif
   double time = aHit->getTimeSlice();
   if (corrTOFBeam) time += correctT;
   slave->processHits(aHit->getUnitID(), aHit->getEM()/GeV, 
                      aHit->getHadr()/GeV, time, tkID, aHit->getDepth());
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: Store Hit at " << std::hex 
               << aHit->getUnitID() << std::dec << " " 
               << aHit->getDepth() << " due to " << tkID 
               << " in time " << time << " of energy " 
               << aHit->getEM()/GeV << " GeV (EM) and " 
               << aHit->getHadr()/GeV << " GeV (Hadr)";
 #endif
   return ok;
 }

uint32_t CaloSD::setDetUnitId ( const G4Step * step )

overridepure virtual

Implements SensitiveDetector.

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

Referenced by getStepInfo(), and ProcessHits().

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

protected

Definition at line 277 of file CaloSD.cc.

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

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

protected

Definition at line 270 of file CaloSD.cc.

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

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

void CaloSD::storeHit ( CaloG4Hit * hit )

private

Definition at line 590 of file CaloSD.cc.

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

Referenced by createNewHit().

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

void CaloSD::summarize ( )

private

Definition at line 637 of file CaloSD.cc.

Referenced by update().

637 {}

void CaloSD::update ( const BeginOfRun * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfRun * >.

Definition at line 461 of file CaloSD.cc.

References emPDG, epPDG, gammaPDG, initRun(), HiggsValidation_cfi::particleName, and runInit.

                                       {
   G4ParticleTable * theParticleTable = G4ParticleTable::GetParticleTable();
   G4String particleName;
   emPDG = theParticleTable->FindParticle(particleName="e-")->GetPDGEncoding();
   epPDG = theParticleTable->FindParticle(particleName="e+")->GetPDGEncoding();
   gammaPDG = theParticleTable->FindParticle(particleName="gamma")->GetPDGEncoding();
 #ifdef DebugLog
   edm::LogInfo("CaloSim") << "CaloSD: Particle code for e- = " << emPDG
               << " for e+ = " << epPDG << " for gamma = " << gammaPDG;
 #endif
   initRun();
   runInit = true;
 } 

void CaloSD::update ( const BeginOfEvent * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfEvent * >.

Definition at line 475 of file CaloSD.cc.

References clearHits().

                                         {
 #ifdef DebugLog
   edm::LogInfo("CaloSim")  << "CaloSD: Dispatched BeginOfEvent for " 
                << GetName() << " !" ;
 #endif
   clearHits();
 }

void CaloSD::update ( const BeginOfTrack * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfTrack * >.

Definition at line 639 of file CaloSD.cc.

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

                                             {
   int primary = -1;
   TrackInformation * trkInfo = (TrackInformation *)((*trk)()->GetUserInformation());
   if ( trkInfo->isPrimary() ) primary = (*trk)()->GetTrackID();
   
 #ifdef DebugLog
   edm::LogInfo("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();
     
   }
 }

void CaloSD::update ( const EndOfTrack * )

overrideprotectedvirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const EndOfTrack * >.

Definition at line 483 of file CaloSD.cc.

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

                                           {
   int id = (*trk)()->GetTrackID();
   TrackInformation *trkI =(TrackInformation *)((*trk)()->GetUserInformation());
   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 DebugLog
     edm::LogInfo("CaloSim") << "CaloSD: get track " << it << " from "
                 << "Container of size " << trksForThisEvent->size()
                 << " with ID " << trkH->trackID();
       } else {
     edm::LogInfo("CaloSim") << "CaloSD: get track " << it << " from "
                 << "Container of size " << trksForThisEvent->size()
                 << " with no ID";
 #endif
       }
     }
   }
 }

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

overrideprotected

Definition at line 509 of file CaloSD.cc.

References KineDebug3::count(), mps_fire::i, convertSQLiteXML::ok, CaloSlaveSD::ReserveMemory(), saveHit(), slave, summarize(), theHC, tkMap, and totalHits.

                                        {
   int count = 0, wrong = 0;
   bool ok;
   
   slave->ReserveMemory(theHC->entries());
 
   for (int i=0; i<theHC->entries(); ++i) {
     ok = saveHit((*theHC)[i]);
     ++count;
     if (!ok)  ++wrong;
   }
   
   edm::LogInfo("CaloSim") << "CaloSD: " << GetName() << " store " << count
                           << " hits recorded with " << wrong 
                           << " track IDs not given properly and "
                           << totalHits-count << " hits not passing cuts";
   summarize();
 
   tkMap.erase (tkMap.begin(), tkMap.end());
 }

void CaloSD::updateHit ( CaloG4Hit * aHit )

protected

Definition at line 414 of file CaloSD.cc.

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

Referenced by checkHit(), createNewHit(), ZdcSD::getFromLibrary(), CastorSD::getFromLibrary(), HCalSD::getFromLibrary(), HCalSD::getFromParam(), HCalSD::getHitFibreBundle(), HCalSD::getHitPMT(), hitExists(), HCalSD::hitForFibre(), and ProcessHits().

                                       {
   if (edepositEM+edepositHAD != 0) {
     aHit->addEnergyDeposit(edepositEM,edepositHAD);
 #ifdef DebugLog
     edm::LogInfo("CaloSim") << "CaloSD: Add energy deposit in " << currentID 
                 << " em " << edepositEM/MeV << " hadronic " 
                 << edepositHAD/MeV << " MeV"; 
 #endif
   }
 
   // buffer for next steps:
   previousID = currentID;
 }