SimTrackManager Class Reference

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

Classes
class	StrictWeakOrdering

Public Types
typedef std::map< int, VertexPositionVector >	VertexMap
typedef std::pair< int, math::XYZVectorD >	VertexPosition
typedef std::vector< std::pair< int, math::XYZVectorD > >	VertexPositionVector

Public Member Functions
void	addTrack (TrackWithHistory *iTrack, const G4Track *track, bool inHistory, bool withAncestor)
void	cleanTracksWithHistory ()
void	deleteTracks ()
TrackWithHistory *	getTrackByID (int trackID, bool strict=false) const
int	giveMotherNeeded (int i) const
const SimTrackManager &	operator= (const SimTrackManager &)=delete
void	reset ()
void	setLHCTransportLink (const edm::LHCTransportLinkContainer *thisLHCTlink)
	SimTrackManager (TmpSimEvent *)
	SimTrackManager (const SimTrackManager &)=delete
void	storeTracks ()
const std::vector< TrackWithHistory * > *	trackContainer () const
bool	trackExists (int i) const
	~SimTrackManager ()

Private Member Functions
void	cleanVertexMap ()
void	fillMotherList ()
int	getOrCreateVertex (TrackWithHistory *, int)
int	idSavedTrack (int) const
void	reallyStoreTracks ()
void	ReportException (unsigned int id) const
void	resetGenID ()
void	saveTrackAndItsBranch (TrackWithHistory *)
	this saves a track and all its parents looping over the non ordered vector More...

Private Attributes
std::vector< std::pair< int, int > >	ancestorList
std::vector< std::pair< int, int > >	idsave
unsigned int	lastHist {0}
unsigned int	lastTrack {0}
std::vector< std::pair< int, math::XYZVectorD > >	m_endPoints
int	m_nVertices {0}
TmpSimEvent *	m_simEvent
std::vector< TrackWithHistory * >	m_trackContainer
VertexMap	m_vertexMap
const edm::LHCTransportLinkContainer *	theLHCTlink {nullptr}

Detailed Description

Description: Holds tracking information used by the sensitive detectors Created: Fri Nov 25 17:36:41 EST 2005

Definition at line 28 of file SimTrackManager.h.

Member Typedef Documentation

VertexMap

typedef std::map<int, VertexPositionVector> SimTrackManager::VertexMap

Definition at line 37 of file SimTrackManager.h.

VertexPosition

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

Definition at line 35 of file SimTrackManager.h.

VertexPositionVector

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

Definition at line 36 of file SimTrackManager.h.

Constructor & Destructor Documentation

SimTrackManager() [1/2]

SimTrackManager::SimTrackManager ( TmpSimEvent *  ptr )

explicit

Definition at line 38 of file SimTrackManager.cc.

References ancestorList, idsave, m_endPoints, and m_trackContainer.

                                                 : m_simEvent(ptr) {
  idsave.reserve(1000);
  ancestorList.reserve(1000);
  m_trackContainer.reserve(1000);
  m_endPoints.reserve(1000);
}

~SimTrackManager()

SimTrackManager::~SimTrackManager

(

)

Definition at line 45 of file SimTrackManager.cc.

References reset().

{ reset(); }

SimTrackManager() [2/2]

SimTrackManager::SimTrackManager ( const SimTrackManager &  )

delete

Member Function Documentation

addTrack()

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

Definition at line 72 of file SimTrackManager.cc.

References ancestorList, idsave, m_endPoints, m_trackContainer, AlCaHLTBitMon_ParallelJobs::p, TrackWithHistory::parentID(), HLT_2024v12_cff::track, TrackWithHistory::trackID(), and findQualityFiles::v.

Referenced by TrackingAction::PostUserTrackingAction().

                                                                                                                {
  std::pair<int, int> thePair(iTrack->trackID(), iTrack->parentID());
  idsave.push_back(thePair);
  if (inHistory) {
    m_trackContainer.push_back(iTrack);
    const auto& v = track->GetStep()->GetPostStepPoint()->GetPosition();
    std::pair<int, math::XYZVectorD> p(iTrack->trackID(),
                                       math::XYZVectorD(v.x() * invcm, v.y() * invcm, v.z() * invcm));
    m_endPoints.push_back(p);
  }
  if (withAncestor) {
    std::pair<int, int> thisPair(iTrack->trackID(), 0);
    ancestorList.push_back(thisPair);
  }
}

cleanTracksWithHistory()

void SimTrackManager::cleanTracksWithHistory

(

)

Definition at line 288 of file SimTrackManager.cc.

References fillMotherList(), idsave, ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it, lastTrack, LogDebug, m_trackContainer, EgammaValidation_cff::num, saveTrackAndItsBranch(), submitPVValidationJobs::t, and geometryCSVtoXML::xx.

Referenced by TrackingAction::PreUserTrackingAction(), and storeTracks().

                                             {
  if (m_trackContainer.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_trackContainer.size()) {
    lastTrack = 0;
    edm::LogError("SimTrackManager") << " SimTrackManager::cleanTracksWithHistory track index corrupted";
  }

  std::stable_sort(m_trackContainer.begin() + lastTrack, m_trackContainer.end(), trkIDLess());
  std::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_trackContainer.size(); it++) {
    LogDebug("SimTrackManager") << " 1 - Track in position " << it << " G4 track number "
                                << m_trackContainer[it]->trackID() << " mother " << m_trackContainer[it]->parentID()
                                << " status " << m_trackContainer[it]->saved();
  }
#endif

  for (auto const& t : m_trackContainer) {
    if (t->saved()) {
      saveTrackAndItsBranch(t);
    }
  }
  unsigned int num = lastTrack;
  for (unsigned int it = lastTrack; it < m_trackContainer.size(); ++it) {
    auto t = m_trackContainer[it];
    int g4ID = m_trackContainer[it]->trackID();
    if (t->saved()) {
      if (it > num) {
        m_trackContainer[num] = t;
      }
      ++num;
      for (auto& xx : idsave) {
        if (xx.first == g4ID) {
          xx.second = g4ID;
          break;
        }
      }
    } else {
      delete t;
    }
  }

  m_trackContainer.resize(num);

#ifdef DebugLog
  LogDebug("SimTrackManager") << " AFTER CLEANING, I GET " << m_trackContainer.size()
                              << " tracks to be saved persistently";
  for (unsigned int it = 0; it < m_trackContainer.size(); ++it) {
    LogDebug("SimTrackManager") << " Track in position " << it << " G4 track number " << m_trackContainer[it]->trackID()
                                << " mother " << m_trackContainer[it]->parentID() << " Status "
                                << m_trackContainer[it]->saved() << " id " << m_trackContainer[it]->particleID()
                                << " E(MeV)= " << m_trackContainer[it]->totalEnergy();
  }
#endif

  fillMotherList();
  lastTrack = m_trackContainer.size();
}

cleanVertexMap()

void SimTrackManager::cleanVertexMap ( )

private

Definition at line 66 of file SimTrackManager.cc.

References m_nVertices, and m_vertexMap.

Referenced by reset().

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

deleteTracks()

void SimTrackManager::deleteTracks

(

)

Definition at line 56 of file SimTrackManager.cc.

References m_endPoints, and m_trackContainer.

Referenced by reset().

                                   {
  if (!m_trackContainer.empty()) {
    for (auto const& ptr : m_trackContainer) {
      delete ptr;
    }
    m_trackContainer.clear();
    m_endPoints.clear();
  }
}

fillMotherList()

void SimTrackManager::fillMotherList ( )

private

Definition at line 262 of file SimTrackManager.cc.

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

Referenced by cleanTracksWithHistory().

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

  lastHist = ancestorList.size();
  idsave.clear();
}

getOrCreateVertex()

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

private

Definition at line 177 of file SimTrackManager.cc.

References TmpSimEvent::add(), l1ctLayer2EG_cff::id, m_nVertices, m_simEvent, m_trackContainer, m_vertexMap, class-composition::parent, TrackWithHistory::processType(), TrackWithHistory::time(), TrackWithHistory::vertexPosition(), and geometryCSVtoXML::xx.

Referenced by reallyStoreTracks().

                                                                            {
  int parent = -1;
  for (auto const& trk : m_trackContainer) {
    int id = trk->trackID();
    if (id == iParentID) {
      parent = id;
      break;
    }
  }

  VertexMap::const_iterator iterator = m_vertexMap.find(parent);
  if (iterator != m_vertexMap.end()) {
    // loop over saved vertices
    for (auto const& xx : m_vertexMap[parent]) {
      if ((trkH->vertexPosition() - xx.second).Mag2() < r_limit2) {
        return xx.first;
      }
    }
  }

  m_simEvent->add(new TmpSimVertex(trkH->vertexPosition(), trkH->time(), parent, trkH->processType()));
  m_vertexMap[parent].push_back(VertexPosition(m_nVertices, trkH->vertexPosition()));
  ++m_nVertices;
  return (m_nVertices - 1);
}

getTrackByID()

TrackWithHistory* SimTrackManager::getTrackByID ( int  trackID, bool  strict = false  ) const

inline

Definition at line 73 of file SimTrackManager.h.

References m_trackContainer, ReportException(), and HLT_2024v12_cff::track.

Referenced by CaloSD::findBoundaryCrossingParent(), and EventAction::getTrackByID().

                                                                         {
    TrackWithHistory* track = nullptr;
    for (auto const& ptr : m_trackContainer) {
      if (ptr->trackID() == trackID) {
        track = ptr;
        break;
      }
    }
    if (nullptr == track && strict) {
      ReportException(trackID);
    }
    return track;
  }

giveMotherNeeded()

int SimTrackManager::giveMotherNeeded ( int  i ) const

inline

Definition at line 51 of file SimTrackManager.h.

References mps_fire::i, idsave, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by CaloSD::saveHit().

                                    {
    int theResult = 0;
    for (auto const& p : idsave) {
      if (p.first == i) {
        theResult = p.second;
        break;
      }
    }
    return theResult;
  }

idSavedTrack()

int SimTrackManager::idSavedTrack ( int  id ) const

private

Definition at line 203 of file SimTrackManager.cc.

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

Referenced by fillMotherList().

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

operator=()

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

delete

reallyStoreTracks()

void SimTrackManager::reallyStoreTracks ( )

private

Definition at line 124 of file SimTrackManager.cc.

References TmpSimEvent::add(), TmpSimTrack::copyCrossedBoundaryVars(), Exception, dqmdumpme::first, getOrCreateVertex(), mps_fire::i, PSimHit::k_tidOffset, m_endPoints, m_simEvent, m_trackContainer, and groupFilesInBlocks::nn.

Referenced by storeTracks().

                                        {
  // loop over the (now ordered) vector and really save the tracks
#ifdef DebugLog
  edm::LogVerbatim("SimTrackManager") << "reallyStoreTracks() NtracksWithHistory= " << m_trackContainer->size();
#endif

  int nn = m_endPoints.size();
  for (auto& trkH : m_trackContainer) {
    // at this stage there is one vertex per track,
    // so the vertex id of track N is also N
    int iParentID = trkH->parentID();
    int ig = trkH->genParticleID();
    int ivertex = getOrCreateVertex(trkH, iParentID);

    auto ptr = trkH;
    if (0 < iParentID) {
      for (auto& trk : m_trackContainer) {
        if (trk->trackID() == iParentID) {
          ptr = trk;
          break;
        }
      }
    }
    // Track at surface is the track at intersection point between tracker and calo
    // envelops if exist. If not exist the momentum is zero, position is the end of
    // the track
    const math::XYZVectorD& pm = ptr->momentum();
    math::XYZVectorD spos(0., 0., 0.);
    math::XYZTLorentzVectorD smom(0., 0., 0., 0.);
    int id = trkH->trackID();
    if (trkH->crossedBoundary()) {
      spos = trkH->getPositionAtBoundary();
      smom = trkH->getMomentumAtBoundary();
    } else {
      for (int i = 0; i < nn; ++i) {
        if (id == m_endPoints[i].first) {
          spos = m_endPoints[i].second;
          break;
        }
      }
    }

    if (id >= static_cast<int>(PSimHit::k_tidOffset)) {
      throw cms::Exception("SimTrackManager::reallyStoreTracks")
          << " SimTrack ID " << id << " exceeds maximum allowed by PSimHit identifier" << PSimHit::k_tidOffset;
    }
    TmpSimTrack* g4simtrack =
        new TmpSimTrack(id, trkH->particleID(), trkH->momentum(), trkH->totalEnergy(), ivertex, ig, pm, spos, smom);
    g4simtrack->copyCrossedBoundaryVars(trkH);
    m_simEvent->add(g4simtrack);
  }
}

ReportException()

void SimTrackManager::ReportException ( unsigned int  id ) const

private

Definition at line 379 of file SimTrackManager.cc.

References Exception, and m_trackContainer.

Referenced by getTrackByID().

                                                           {
  throw cms::Exception("Unknown", "SimTrackManager::getTrackByID")
      << "Fail to get track " << id << " from SimTrackManager, container size= " << m_trackContainer.size();
}

reset()

void SimTrackManager::reset

(

void

)

Definition at line 47 of file SimTrackManager.cc.

References ancestorList, cleanVertexMap(), deleteTracks(), idsave, lastHist, and lastTrack.

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

                            {
  deleteTracks();
  cleanVertexMap();
  idsave.clear();
  ancestorList.clear();
  lastTrack = 0;
  lastHist = 0;
}

resetGenID()

void SimTrackManager::resetGenID ( )

private

Definition at line 358 of file SimTrackManager.cc.

References m_trackContainer, theLHCTlink, and geometryCSVtoXML::xx.

Referenced by storeTracks().

                                 {
  if (theLHCTlink == nullptr)
    return;

  for (auto const& trkH : m_trackContainer) {
    int genParticleID = trkH->genParticleID();
    if (genParticleID == -1) {
      continue;
    } else {
      for (auto const& xx : *theLHCTlink) {
        if (xx.afterHector() == genParticleID) {
          trkH->setGenParticleID(xx.beforeHector());
          continue;
        }
      }
    }
  }

  theLHCTlink = nullptr;
}

saveTrackAndItsBranch()

void SimTrackManager::saveTrackAndItsBranch ( TrackWithHistory *  trkWHist )

private

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

Definition at line 89 of file SimTrackManager.cc.

References Exception, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, m_trackContainer, class-composition::parent, TrackWithHistory::parentID(), and TrackWithHistory::setToBeSaved().

Referenced by cleanTracksWithHistory().

                                                                      {
  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->setToBeSaved();
  int parent = trkH->parentID();

  auto tk_itr =
      std::lower_bound(m_trackContainer.begin(), m_trackContainer.end(), parent, SimTrackManager::StrictWeakOrdering());

  if (tk_itr != m_trackContainer.end() && (*tk_itr)->trackID() == parent) {
    saveTrackAndItsBranch(*tk_itr);
  }
}

setLHCTransportLink()

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

inline

Definition at line 87 of file SimTrackManager.h.

References theLHCTlink.

{ theLHCTlink = thisLHCTlink; }

storeTracks()

void SimTrackManager::storeTracks

(

)

Definition at line 106 of file SimTrackManager.cc.

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

Referenced by EventAction::EndOfEventAction().

                                  {
  cleanTracksWithHistory();

  // fill the map with the final mother-daughter relationship
  idsave.swap(ancestorList);
  std::stable_sort(idsave.begin(), idsave.end());

  std::vector<std::pair<int, int> >().swap(ancestorList);

  // to get a backward compatible order
  std::stable_sort(m_trackContainer.begin(), m_trackContainer.end(), trkIDLess());

  // to reset the GenParticle ID of a SimTrack to its pre-LHCTransport value
  resetGenID();

  reallyStoreTracks();
}

trackContainer()

const std::vector<TrackWithHistory*>* SimTrackManager::trackContainer ( ) const

inline

Definition at line 42 of file SimTrackManager.h.

References m_trackContainer.

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

{ return &m_trackContainer; }

trackExists()

bool SimTrackManager::trackExists ( int  i ) const

inline

Definition at line 62 of file SimTrackManager.h.

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

Referenced by CaloSD::saveHit().

                                {
    bool flag = false;
    for (auto const& ptr : m_trackContainer) {
      if (ptr->trackID() == i) {
        flag = true;
        break;
      }
    }
    return flag;
  }

Member Data Documentation

ancestorList

std::vector<std::pair<int, int> > SimTrackManager::ancestorList

private

Definition at line 116 of file SimTrackManager.h.

Referenced by addTrack(), fillMotherList(), idSavedTrack(), reset(), SimTrackManager(), and storeTracks().

idsave

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

private

Definition at line 115 of file SimTrackManager.h.

Referenced by addTrack(), cleanTracksWithHistory(), fillMotherList(), giveMotherNeeded(), idSavedTrack(), reset(), SimTrackManager(), and storeTracks().

lastHist

unsigned int SimTrackManager::lastHist {0}

private

Definition at line 109 of file SimTrackManager.h.

Referenced by fillMotherList(), and reset().

lastTrack

unsigned int SimTrackManager::lastTrack {0}

private

Definition at line 108 of file SimTrackManager.h.

Referenced by cleanTracksWithHistory(), and reset().

m_endPoints

std::vector<std::pair<int, math::XYZVectorD> > SimTrackManager::m_endPoints

private

Definition at line 117 of file SimTrackManager.h.

Referenced by addTrack(), deleteTracks(), reallyStoreTracks(), and SimTrackManager().

m_nVertices

int SimTrackManager::m_nVertices {0}

private

Definition at line 107 of file SimTrackManager.h.

Referenced by cleanVertexMap(), and getOrCreateVertex().

m_simEvent

TmpSimEvent* SimTrackManager::m_simEvent

private

Definition at line 111 of file SimTrackManager.h.

Referenced by getOrCreateVertex(), and reallyStoreTracks().

m_trackContainer

std::vector<TrackWithHistory*> SimTrackManager::m_trackContainer

private

Definition at line 118 of file SimTrackManager.h.

Referenced by addTrack(), cleanTracksWithHistory(), deleteTracks(), getOrCreateVertex(), getTrackByID(), reallyStoreTracks(), ReportException(), resetGenID(), saveTrackAndItsBranch(), SimTrackManager(), storeTracks(), trackContainer(), and trackExists().

m_vertexMap

VertexMap SimTrackManager::m_vertexMap

private

Definition at line 114 of file SimTrackManager.h.

Referenced by cleanVertexMap(), and getOrCreateVertex().

theLHCTlink

const edm::LHCTransportLinkContainer* SimTrackManager::theLHCTlink {nullptr}

private

Definition at line 112 of file SimTrackManager.h.

Referenced by resetGenID(), and setLHCTransportLink().