#include <SimG4Core/Notification/interface/SimTrackManager.h>

Classes
class	StrictWeakOrdering

Public Types
typedef std::pair< int, math::XYZVectorD >	MapVertexPosition
	this map contains association between vertex number and position More...

typedef std::vector< std::pair< int, math::XYZVectorD > >	MapVertexPositionVector

typedef std::map< int, MapVertexPositionVector >	MotherParticleToVertexMap

typedef MotherParticleToVertexMap	VertexMap

Public Member Functions
void	addTkCaloStateInfo (uint32_t t, const std::pair< math::XYZVectorD, math::XYZTLorentzVectorD > &p)

void	addTrack (TrackWithHistory *iTrack, bool inHistory, bool withAncestor)

void	cleanTkCaloStateInfoMap ()

void	cleanTracksWithHistory ()

void	deleteTracks ()

int	giveMotherNeeded (int i) const

void	reset ()

void	setCollapsePrimaryVertices (bool iSet)

void	setLHCTransportLink (const edm::LHCTransportLinkContainer *thisLHCTlink)

	SimTrackManager (bool iCollapsePrimaryVertices=false)

void	storeTracks (G4SimEvent *simEvent)

const TrackContainer *	trackContainer () const

bool	trackExists (unsigned int i) const

virtual	~SimTrackManager ()

Private Member Functions
void	cleanVertexMap ()

void	fillMotherList ()

int	getOrCreateVertex (TrackWithHistory , int, G4SimEvent simEvent)

int	idSavedTrack (int) const

const SimTrackManager &	operator= (const SimTrackManager &)=delete

void	reallyStoreTracks (G4SimEvent *simEvent)

void	resetGenID ()

void	saveTrackAndItsBranch (TrackWithHistory *)
	this saves a track and all its parents looping over the non ordered vector More...

	SimTrackManager (const SimTrackManager &)=delete

Private Attributes
std::vector< std::pair< int, int > >	ancestorList

std::vector< std::pair< int, int > >	idsave

unsigned int	lastHist

unsigned int	lastTrack

bool	m_collapsePrimaryVertices

int	m_nVertices

bool	m_SaveSimTracks

TrackContainer *	m_trksForThisEvent

MotherParticleToVertexMap	m_vertexMap

std::map< uint32_t, std::pair< math::XYZVectorD, math::XYZTLorentzVectorD > >	mapTkCaloStateInfo

const edm::LHCTransportLinkContainer *	theLHCTlink

Detailed Description

Description: Holds tracking information used by the sensitive detectors

Usage: <usage>

Definition at line 35 of file SimTrackManager.h.

Member Typedef Documentation

typedef std::pair<int, math::XYZVectorD> SimTrackManager::MapVertexPosition

this map contains association between vertex number and position

Definition at line 43 of file SimTrackManager.h.

typedef std::vector<std::pair<int, math::XYZVectorD> > SimTrackManager::MapVertexPositionVector

Definition at line 44 of file SimTrackManager.h.

typedef std::map<int, MapVertexPositionVector> SimTrackManager::MotherParticleToVertexMap

Definition at line 45 of file SimTrackManager.h.

typedef MotherParticleToVertexMap SimTrackManager::VertexMap

Definition at line 46 of file SimTrackManager.h.

Constructor & Destructor Documentation

SimTrackManager::SimTrackManager ( bool iCollapsePrimaryVertices = false )

Definition at line 28 of file SimTrackManager.cc.

Referenced by setLHCTransportLink().

     : m_trksForThisEvent(nullptr),
       m_nVertices(0),
       m_collapsePrimaryVertices(iCollapsePrimaryVertices),
       lastTrack(0),
       lastHist(0),
       theLHCTlink(nullptr) {}

SimTrackManager::~SimTrackManager ( )

virtual

Definition at line 36 of file SimTrackManager.cc.

References deleteTracks(), and m_trksForThisEvent.

                                   {
   if (m_trksForThisEvent != nullptr)
     deleteTracks();
 }

SimTrackManager::SimTrackManager ( const SimTrackManager & )

privatedelete

Member Function Documentation

void SimTrackManager::addTkCaloStateInfo	(	uint32_t	t,
		const std::pair< math::XYZVectorD, math::XYZTLorentzVectorD > &	p
	)

inline

Definition at line 75 of file SimTrackManager.h.

References mapTkCaloStateInfo.

Referenced by EventAction::addTkCaloStateInfo().

                                                                                                 {
     std::map<uint32_t, std::pair<math::XYZVectorD, math::XYZTLorentzVectorD> >::const_iterator it =
         mapTkCaloStateInfo.find(t);
 
     if (it == mapTkCaloStateInfo.end()) {
       mapTkCaloStateInfo.insert(std::pair<uint32_t, std::pair<math::XYZVectorD, math::XYZTLorentzVectorD> >(t, p));
     }
   }

void SimTrackManager::addTrack	(	TrackWithHistory *	iTrack,
		bool	inHistory,
		bool	withAncestor
	)

inline

Definition at line 63 of file SimTrackManager.h.

References ancestorList, idsave, m_trksForThisEvent, TrackWithHistory::parentID(), and TrackWithHistory::trackID().

Referenced by EventAction::addTrack().

                                                                              {
     std::pair<int, int> thePair(iTrack->trackID(), iTrack->parentID());
     idsave.push_back(thePair);
     if (inHistory) {
       m_trksForThisEvent->push_back(iTrack);
     }
     if (withAncestor) {
       std::pair<int, int> thisPair(iTrack->trackID(), 0);
       ancestorList.push_back(thisPair);
     }
   }

void SimTrackManager::cleanTkCaloStateInfoMap ( )

Definition at line 195 of file SimTrackManager.cc.

References mapTkCaloStateInfo, and edm::swap().

Referenced by EventAction::EndOfEventAction(), reset(), and trackContainer().

                                               {
   mapTkCaloStateInfo.clear();
   std::map<uint32_t, std::pair<math::XYZVectorD, math::XYZTLorentzVectorD> >().swap(mapTkCaloStateInfo);
 }

void SimTrackManager::cleanTracksWithHistory ( )

Definition at line 291 of file SimTrackManager.cc.

References fillMotherList(), idsave, lastTrack, LogDebug, m_trksForThisEvent, EgammaValidation_cff::num, TrackWithHistory::saved(), saveTrackAndItsBranch(), edm::second(), OrderedSet::t, and TrackWithHistory::trackID().

Referenced by EventAction::prepareForNewPrimary(), storeTracks(), and trackContainer().

                                              {
   if ((*m_trksForThisEvent).empty() && idsave.empty()) {
     return;
   }
 
 #ifdef DebugLog
   LogDebug("SimTrackManager") << "SimTrackManager::cleanTracksWithHistory has " << idsave.size()
                               << " mother-daughter relationships stored with lastTrack = " << lastTrack;
 #endif
 
   if (lastTrack > 0 && lastTrack >= (*m_trksForThisEvent).size()) {
     lastTrack = 0;
     edm::LogError("SimTrackManager") << " SimTrackManager::cleanTracksWithHistory track index corrupted";
   }
 
   stable_sort(m_trksForThisEvent->begin() + lastTrack, m_trksForThisEvent->end(), trkIDLess());
 
   stable_sort(idsave.begin(), idsave.end());
 
 #ifdef DebugLog
   LogDebug("SimTrackManager") << " SimTrackManager::cleanTracksWithHistory knows " << m_trksForThisEvent->size()
                               << " tracks with history before branching";
   for (unsigned int it = 0; it < (*m_trksForThisEvent).size(); it++) {
     LogDebug("SimTrackManager") << " 1 - Track in position " << it << " G4 track number "
                                 << (*m_trksForThisEvent)[it]->trackID() << " mother "
                                 << (*m_trksForThisEvent)[it]->parentID() << " status "
                                 << (*m_trksForThisEvent)[it]->saved();
   }
 #endif
 
   for (unsigned int it = lastTrack; it < m_trksForThisEvent->size(); it++) {
     TrackWithHistory* t = (*m_trksForThisEvent)[it];
     if (t->saved()) {
       saveTrackAndItsBranch(t);
     }
   }
   unsigned int num = lastTrack;
   for (unsigned int it = lastTrack; it < m_trksForThisEvent->size(); it++) {
     TrackWithHistory* t = (*m_trksForThisEvent)[it];
     int g4ID = t->trackID();
     if (t->saved() == true) {
       if (it > num)
         (*m_trksForThisEvent)[num] = t;
       num++;
       for (unsigned int itr = 0; itr < idsave.size(); itr++) {
         if ((idsave[itr]).first == g4ID) {
           (idsave[itr]).second = g4ID;
           break;
         }
       }
     } else {
       delete t;
     }
   }
 
   (*m_trksForThisEvent).resize(num);
 
 #ifdef DebugLog
   LogDebug("SimTrackManager") << " AFTER CLEANING, I GET " << (*m_trksForThisEvent).size()
                               << " tracks to be saved persistently";
   for (unsigned int it = 0; it < (*m_trksForThisEvent).size(); it++) {
     LogDebug("SimTrackManager") << " Track in position " << it << " G4 track number "
                                 << (*m_trksForThisEvent)[it]->trackID() << " mother "
                                 << (*m_trksForThisEvent)[it]->parentID() << " Status "
                                 << (*m_trksForThisEvent)[it]->saved() << " id "
                                 << (*m_trksForThisEvent)[it]->particleID()
                                 << " E(MeV)= " << (*m_trksForThisEvent)[it]->totalEnergy();
   }
 #endif
 
   fillMotherList();
 
   lastTrack = (*m_trksForThisEvent).size();
 }

void SimTrackManager::cleanVertexMap ( )

private

Definition at line 189 of file SimTrackManager.cc.

References m_nVertices, and m_vertexMap.

Referenced by reset(), and setLHCTransportLink().

                                      {
   m_vertexMap.clear();
   MotherParticleToVertexMap().swap(m_vertexMap);
   m_nVertices = 0;
 }

void SimTrackManager::deleteTracks ( )

Definition at line 62 of file SimTrackManager.cc.

References mps_fire::i, and m_trksForThisEvent.

Referenced by EventAction::EndOfEventAction(), trackContainer(), and ~SimTrackManager().

                                    {
   for (unsigned int i = 0; i < m_trksForThisEvent->size(); i++) {
     delete (*m_trksForThisEvent)[i];
   }
   delete m_trksForThisEvent;
   m_trksForThisEvent = nullptr;
 }

void SimTrackManager::fillMotherList ( )

private

Definition at line 259 of file SimTrackManager.cc.

References ancestorList, dqmdumpme::first, idsave, idSavedTrack(), lastHist, LogDebug, and dqmiodumpmetadata::n.

Referenced by cleanTracksWithHistory(), and setLHCTransportLink().

                                      {
   if (!ancestorList.empty() && lastHist > ancestorList.size()) {
     lastHist = ancestorList.size();
     edm::LogError("SimTrackManager") << " SimTrackManager::fillMotherList track index corrupted";
   }
   /*
   std::cout << "### SimTrackManager::fillMotherList: "
         << idsave.size() << " saved; ancestor: " << lastHist 
         << "  " << ancestorList.size() << std::endl;
   for (unsigned int i = 0; i< idsave.size(); ++i) { 
     std::cout  << " ISV: Track ID = " << (idsave[i]).first 
            << " Mother ID = " << (idsave[i]).second << std::endl;
   }
   */
   for (unsigned int n = lastHist; n < ancestorList.size(); n++) {
     int theMotherId = idSavedTrack((ancestorList[n]).first);
     ancestorList[n].second = theMotherId;
     /*
     std::cout  << " ANC: Track ID = " << (ancestorList[n]).first 
            << " Mother ID = " << (ancestorList[n]).second << std::endl;
     */
 #ifdef DebugLog
     LogDebug("SimTrackManager") << "Track ID = " << (ancestorList[n]).first
                                 << " Mother ID = " << (ancestorList[n]).second;
 #endif
   }
 
   lastHist = ancestorList.size();
 
   idsave.clear();
 }

int SimTrackManager::getOrCreateVertex	(	TrackWithHistory *	trkH,
		int	iParentID,
		G4SimEvent *	simEvent
	)

private

Definition at line 151 of file SimTrackManager.cc.

References G4SimEvent::add(), RPCNoise_example::check, TrackWithHistory::creatorProcess(), dqmdumpme::first, TrackWithHistory::globalTime(), dqmdumpme::k, m_nVertices, m_vertexMap, class-composition::parent, OfflineHarvestingSequence_cosmic::ptype, mathSSE::sqrt(), and TrackWithHistory::vertexPosition().

Referenced by reallyStoreTracks(), and setLHCTransportLink().

                                                                                                   {
   int parent = iParentID;
   int check = -1;
 
   for (std::vector<TrackWithHistory*>::const_iterator it = (*m_trksForThisEvent).begin();
        it != (*m_trksForThisEvent).end();
        it++) {
     if ((*it)->trackID() == uint32_t(parent)) {
       check = 0;
       break;
     }
   }
 
   if (check == -1) {
     parent = -1;
   }
 
   VertexMap::const_iterator iterator = m_vertexMap.find(parent);
   if (iterator != m_vertexMap.end()) {
     // loop over saved vertices
     for (unsigned int k = 0; k < m_vertexMap[parent].size(); k++) {
       if (sqrt((trkH->vertexPosition() - (((m_vertexMap[parent])[k]).second)).Mag2()) < 0.001) {
         return (((m_vertexMap[parent])[k]).first);
       }
     }
   }
 
   unsigned int ptype = 0;
   const G4VProcess* pr = trkH->creatorProcess();
   if (pr) {
     ptype = pr->GetProcessSubType();
   }
   simEvent->add(new G4SimVertex(trkH->vertexPosition(), trkH->globalTime(), parent, ptype));
   m_vertexMap[parent].push_back(MapVertexPosition(m_nVertices, trkH->vertexPosition()));
   m_nVertices++;
   return (m_nVertices - 1);
 }

int SimTrackManager::giveMotherNeeded ( int i ) const

inline

Definition at line 84 of file SimTrackManager.h.

References mps_fire::i, idsave, and edm::second().

Referenced by CaloSD::saveHit().

                                     {
     int theResult = 0;
     for (unsigned int itr = 0; itr < idsave.size(); itr++) {
       if ((idsave[itr]).first == i) {
         theResult = (idsave[itr]).second;
         break;
       }
     }
     return theResult;
   }

int SimTrackManager::idSavedTrack ( int id ) const

private

Definition at line 200 of file SimTrackManager.cc.

References ancestorList, dqmdumpme::first, triggerObjects_cff::id, globals_cff::id1, idsave, dqmiolumiharvest::j, dqmiodumpmetadata::n, notFound, and edm::second().

Referenced by fillMotherList(), and setLHCTransportLink().

                                               {
   int idMother = id;
   if (id > 0) {
     unsigned int n = idsave.size();
     if (0 < n) {
       int jmax = n - 1;
       int j, id1;
 
       // first loop forward
       bool notFound = true;
       for (j = 0; j <= jmax; ++j) {
         if ((idsave[j]).first == idMother) {
           id1 = (idsave[j]).second;
           if (0 == id1 || id1 == idMother) {
             return id1;
           }
           jmax = j - 1;
           idMother = id1;
           notFound = false;
           break;
         }
       }
       if (notFound) {
         return 0;
       }
 
       // recursive loop
       do {
         notFound = true;
         // search ID scan backward
         for (j = jmax; j >= 0; --j) {
           if ((idsave[j]).first == idMother) {
             id1 = (idsave[j]).second;
             if (0 == id1 || id1 == idMother) {
               return id1;
             }
             jmax = j - 1;
             idMother = id1;
             notFound = false;
             break;
           }
         }
         if (notFound) {
           // ID not in the list of saved track - look into ancestors
           jmax = ancestorList.size() - 1;
           for (j = jmax; j >= 0; --j) {
             if ((ancestorList[j]).first == idMother) {
               idMother = (ancestorList[j]).second;
               return idMother;
             }
           }
           return 0;
         }
       } while (!notFound);
     }
   }
   return idMother;
 }

const SimTrackManager& SimTrackManager::operator= ( const SimTrackManager & )

privatedelete

Referenced by setLHCTransportLink().

void SimTrackManager::reallyStoreTracks ( G4SimEvent * simEvent )

private

Definition at line 109 of file SimTrackManager.cc.

References G4SimEvent::add(), TrackWithHistory::genParticleID(), getOrCreateVertex(), LogDebug, m_trksForThisEvent, mapTkCaloStateInfo, TrackWithHistory::momentum(), TrackWithHistory::parentID(), TrackWithHistory::particleID(), TrackWithHistory::totalEnergy(), and TrackWithHistory::trackID().

Referenced by setLHCTransportLink(), and storeTracks().

                                                             {
   // loop over the (now ordered) vector and really save the tracks
 #ifdef DebugLog
   LogDebug("SimTrackManager") << "Inside the reallyStoreTracks method object to be stored = "
                               << m_trksForThisEvent->size();
 #endif
 
   for (unsigned int it = 0; it < m_trksForThisEvent->size(); it++) {
     TrackWithHistory* trkH = (*m_trksForThisEvent)[it];
     // at this stage there is one vertex per track,
     // so the vertex id of track N is also N
     int ivertex = -1;
     int ig;
 
     math::XYZVectorD pm(0., 0., 0.);
     unsigned int iParentID = trkH->parentID();
     for (unsigned int iit = 0; iit < m_trksForThisEvent->size(); ++iit) {
       if ((*m_trksForThisEvent)[iit]->trackID() == iParentID) {
         pm = (*m_trksForThisEvent)[iit]->momentum();
         break;
       }
     }
     ig = trkH->genParticleID();
     ivertex = getOrCreateVertex(trkH, iParentID, simEvent);
     std::map<uint32_t, std::pair<math::XYZVectorD, math::XYZTLorentzVectorD> >::const_iterator cit =
         mapTkCaloStateInfo.find(trkH->trackID());
     std::pair<math::XYZVectorD, math::XYZTLorentzVectorD> tcinfo;
     if (cit != mapTkCaloStateInfo.end()) {
       tcinfo = cit->second;
     }
     simEvent->add(new G4SimTrack(trkH->trackID(),
                                  trkH->particleID(),
                                  trkH->momentum(),
                                  trkH->totalEnergy(),
                                  ivertex,
                                  ig,
                                  pm,
                                  tcinfo.first,
                                  tcinfo.second));
   }
 }

void SimTrackManager::reset ( void )

Definition at line 44 of file SimTrackManager.cc.

References ancestorList, cleanTkCaloStateInfoMap(), cleanVertexMap(), mps_fire::i, idsave, lastHist, lastTrack, m_trksForThisEvent, and edm::swap().

Referenced by EventAction::BeginOfEventAction(), and trackContainer().

                             {
   if (m_trksForThisEvent == nullptr) {
     m_trksForThisEvent = new TrackContainer();
   } else {
     for (unsigned int i = 0; i < m_trksForThisEvent->size(); i++) {
       delete (*m_trksForThisEvent)[i];
     }
     delete m_trksForThisEvent;
     m_trksForThisEvent = new TrackContainer();
   }
   cleanVertexMap();
   cleanTkCaloStateInfoMap();
   std::vector<std::pair<int, int> >().swap(idsave);
   ancestorList.clear();
   lastTrack = 0;
   lastHist = 0;
 }

void SimTrackManager::resetGenID ( )

private

Definition at line 366 of file SimTrackManager.cc.

References TrackWithHistory::genParticleID(), m_trksForThisEvent, TrackWithHistory::setGenParticleID(), and theLHCTlink.

Referenced by setLHCTransportLink(), and storeTracks().

                                  {
   if (theLHCTlink == nullptr)
     return;
 
   for (unsigned int it = 0; it < m_trksForThisEvent->size(); it++) {
     TrackWithHistory* trkH = (*m_trksForThisEvent)[it];
     int genParticleID_ = trkH->genParticleID();
     if (genParticleID_ == -1) {
       continue;
     } else {
       for (unsigned int itrlink = 0; itrlink < (*theLHCTlink).size(); itrlink++) {
         if ((*theLHCTlink)[itrlink].afterHector() == genParticleID_) {
           trkH->setGenParticleID((*theLHCTlink)[itrlink].beforeHector());
           continue;
         }
       }
     }
   }
 
   theLHCTlink = nullptr;
 }

void SimTrackManager::saveTrackAndItsBranch ( TrackWithHistory * trkWHist )

private

this saves a track and all its parents looping over the non ordered vector

Definition at line 71 of file SimTrackManager.cc.

References Exception, m_trksForThisEvent, class-composition::parent, TrackWithHistory::parentID(), and TrackWithHistory::save().

Referenced by cleanTracksWithHistory(), and setLHCTransportLink().

                                                                       {
   using namespace std;
   TrackWithHistory* trkH = trkWHist;
   if (trkH == nullptr) {
     edm::LogError("SimTrackManager") << " SimTrackManager::saveTrackAndItsBranch got 0 pointer ";
     throw cms::Exception("SimTrackManager::saveTrackAndItsBranch") << " cannot handle hits for tracking";
   }
   trkH->save();
   unsigned int parent = trkH->parentID();
 
   TrackContainer::const_iterator tk_itr = std::lower_bound(
       (*m_trksForThisEvent).begin(), (*m_trksForThisEvent).end(), parent, SimTrackManager::StrictWeakOrdering());
 
   TrackWithHistory* tempTk = *tk_itr;
 
   if (tk_itr != m_trksForThisEvent->end() && (*tk_itr)->trackID() == parent) {
     saveTrackAndItsBranch(tempTk);
   }
 }

void SimTrackManager::setCollapsePrimaryVertices ( bool iSet )

inline

Definition at line 83 of file SimTrackManager.h.

References m_collapsePrimaryVertices.

Referenced by EventAction::EventAction().

83 { m_collapsePrimaryVertices = iSet; }

SimTrackManager::m_collapsePrimaryVertices

bool m_collapsePrimaryVertices

Definition: SimTrackManager.h:126

void SimTrackManager::setLHCTransportLink ( const edm::LHCTransportLinkContainer * thisLHCTlink )

inline

Definition at line 104 of file SimTrackManager.h.

References cleanVertexMap(), fillMotherList(), getOrCreateVertex(), idSavedTrack(), operator=(), reallyStoreTracks(), resetGenID(), saveTrackAndItsBranch(), SimTrackManager(), and theLHCTlink.

104 { theLHCTlink = thisLHCTlink; }

SimTrackManager::theLHCTlink

const edm::LHCTransportLinkContainer * theLHCTlink

Definition: SimTrackManager.h:135

void SimTrackManager::storeTracks ( G4SimEvent * simEvent )

Definition at line 91 of file SimTrackManager.cc.

References ancestorList, cleanTracksWithHistory(), idsave, m_trksForThisEvent, reallyStoreTracks(), resetGenID(), and edm::swap().

Referenced by EventAction::EndOfEventAction(), and trackContainer().

                                                       {
   cleanTracksWithHistory();
 
   // fill the map with the final mother-daughter relationship
   idsave.swap(ancestorList);
   stable_sort(idsave.begin(), idsave.end());
 
   std::vector<std::pair<int, int> >().swap(ancestorList);
 
   // to get a backward compatible order
   stable_sort(m_trksForThisEvent->begin(), m_trksForThisEvent->end(), trkIDLess());
 
   // to reset the GenParticle ID of a SimTrack to its pre-LHCTransport value
   resetGenID();
 
   reallyStoreTracks(simEvent);
 }

const TrackContainer* SimTrackManager::trackContainer ( ) const

inline

Definition at line 52 of file SimTrackManager.h.

References cleanTkCaloStateInfoMap(), cleanTracksWithHistory(), deleteTracks(), m_trksForThisEvent, reset(), and storeTracks().

Referenced by EventAction::trackContainer(), and CaloSD::update().

52 { return m_trksForThisEvent; }

SimTrackManager::m_trksForThisEvent

TrackContainer * m_trksForThisEvent

Definition: SimTrackManager.h:122

bool SimTrackManager::trackExists ( unsigned int i ) const

inline

Definition at line 94 of file SimTrackManager.h.

References RemoveAddSevLevel::flag, mps_fire::i, and m_trksForThisEvent.

Referenced by CaloSD::saveHit().

                                          {
     bool flag = false;
     for (unsigned int itr = 0; itr < (*m_trksForThisEvent).size(); ++itr) {
       if ((*m_trksForThisEvent)[itr]->trackID() == i) {
         flag = true;
         break;
       }
     }
     return flag;
   }