G4UA::iGeant4::TrackProcessorUserActionFullG4 Class Reference

#include <TrackProcessorUserActionFullG4.h>

Inheritance diagram for G4UA::iGeant4::TrackProcessorUserActionFullG4:

Collaboration diagram for G4UA::iGeant4::TrackProcessorUserActionFullG4:

Classes
struct	Config

Public Member Functions
	TrackProcessorUserActionFullG4 (const Config &config)
virtual	~TrackProcessorUserActionFullG4 ()
virtual void	PreUserTrackingAction (const G4Track *) override final
virtual void	BeginOfEventAction (const G4Event *) override final
virtual void	EndOfEventAction (const G4Event *) override final
virtual void	PostUserTrackingAction (const G4Track *) override final
virtual void	UserSteppingAction (const G4Step *) override final
ISF::ISFParticleContainer	ReturnSecondaries (ISF::ISFParticle const *parent)

Protected Attributes
ISF::ISFParticleContainer	m_storedSecondaries

Private Member Functions
void	ISFSteppingAction (const G4Step *, ISF::ISFParticle *curISP) override final
	Called by the base class after the G4Track->ISFParticle association has been established.
ISF::EntryLayer	entryLayer (const G4Step *aStep)
void	setupPrimary (G4Track &)
	Setup the given G4Track as the current primary particle which we'll process.
void	setupSecondary (const G4Track &)
	Setup the given G4Track as the current secondary particle which we'll process.
void	updateCurrentBaseISFParticle (ISF::ISFParticle *baseISFParticle)
	Set the base ISFParticle for the currently traced particle.
VTrackInformation::TrackClassification	classify (HepMC::ConstGenParticlePtr primaryGenParticle, HepMC::ConstGenParticlePtr generationZeroGenParticle, HepMC::ConstGenParticlePtr currentGenParticle, int regenerationNumber) const
	Classify the particle represented by the given set of truth links.

Private Attributes
Config	m_config
ISF::IEntryLayerTool *	m_entryLayerToolQuick
	access to the ISF Entry Layer tool which is used to record entry-layer collections
ISF::IGeoIDSvc *	m_geoIDSvcQuick
	access to the central ISF GeoID serice
std::map< std::string, int, std::less< std::string > >	m_entryLayerMap
AtlasDetDescr::AtlasRegion	m_nextGeoID
const G4Track *	m_currentTrack
ISF::ISFParticle *	m_curBaseISP {}
	The most recent ISFParticle ancestor that triggers the currently processed G4Track.

Detailed Description

Definition at line 34 of file TrackProcessorUserActionFullG4.h.

Constructor & Destructor Documentation

TrackProcessorUserActionFullG4()

G4UA::iGeant4::TrackProcessorUserActionFullG4::TrackProcessorUserActionFullG4

(

const Config &

config

)

Definition at line 39 of file TrackProcessorUserActionFullG4.cxx.

      : TrackProcessorUserActionBase(),m_config(config),
        m_entryLayerToolQuick(nullptr),
        m_geoIDSvcQuick(nullptr),
        m_currentTrack(nullptr)
    {
 
      if(4<m_config.verboseLevel)
        {
          G4cout << "create TrackProcessorUserActionFullG4" << G4endl;
        }
 
      m_nextGeoID = m_config.truthVolLevel>1?AtlasDetDescr::fAtlasCavern:AtlasDetDescr::fUndefinedAtlasRegion;
 
      if ( !m_config.entryLayerTool.empty() ) {
        if ( m_config.entryLayerTool.retrieve().isFailure()) {
          G4ExceptionDescription description;
          description << G4String("TrackProcessorUserActionFullG4: ") + "Could not retrieve ISF Entry Layer Tool: " << m_config.entryLayerTool;
          G4Exception("G4UA::iGeant4::TrackProcessorUserActionFullG4", "NoISFEntryLayerTool", FatalException, description);
          return; //The G4Exception call above should abort the job, but Coverity does not seem to pick this up.
        }
        m_entryLayerToolQuick = &(*m_config.entryLayerTool);
      }
 
      if ( !m_config.geoIDSvc.empty() ) {
        if (m_config.geoIDSvc.retrieve().isFailure()) {
          G4ExceptionDescription description;
          description << G4String("TrackProcessorUserActionFullG4: ") + "Could not retrieve ISF GeoID Svc: " << m_config.geoIDSvc;
          G4Exception("G4UA::iGeant4::TrackProcessorUserActionFullG4", "NoISFGeoIDSvc", FatalException, description);
          return; //The G4Exception call above should abort the job, but Coverity does not seem to pick this up.
        }
 
        m_geoIDSvcQuick = &(*m_config.geoIDSvc);
      }
 
      m_entryLayerMap["CALO::CALO"]       = m_config.truthVolLevel+1;
      m_entryLayerMap["MUONQ02::MUONQ02"] = m_config.truthVolLevel+1;
      m_entryLayerMap[m_config.isITkGeometry ? "ITK::ITK" : "IDET::IDET"] = m_config.truthVolLevel+1;
 
    }

~TrackProcessorUserActionFullG4()

virtual G4UA::iGeant4::TrackProcessorUserActionFullG4::~TrackProcessorUserActionFullG4 ( )

inlinevirtual

Definition at line 53 of file TrackProcessorUserActionFullG4.h.

{}

Member Function Documentation

BeginOfEventAction()

void G4UA::iGeant4::TrackProcessorUserActionBase::BeginOfEventAction ( const G4Event * )

finaloverridevirtualinherited

Definition at line 46 of file TrackProcessorUserActionBase.cxx.

{
  m_curBaseISP = nullptr;
  return;
}

classify()

VTrackInformation::TrackClassification G4UA::iGeant4::TrackProcessorUserActionBase::classify ( HepMC::ConstGenParticlePtr primaryGenParticle, HepMC::ConstGenParticlePtr generationZeroGenParticle, HepMC::ConstGenParticlePtr currentGenParticle, int regenerationNumber ) const

privateinherited

Classify the particle represented by the given set of truth links.

Definition at line 220 of file TrackProcessorUserActionBase.cxx.

{
  // if particle points to a non-zero truth particle it can not just be a 'simple' Secondary
 
  if (currentGenParticle) {
    if (currentGenParticle == primaryGenParticle) {
      return VTrackInformation::Primary;
    }
    else if (generationZeroGenParticle == primaryGenParticle && regenerationNumber>0) {
      return VTrackInformation::RegeneratedPrimary;
    }
    else {
      return VTrackInformation::RegisteredSecondary;
    }
  }
 
  return VTrackInformation::Secondary;
}

EndOfEventAction()

void G4UA::iGeant4::TrackProcessorUserActionBase::EndOfEventAction ( const G4Event * )

finaloverridevirtualinherited

Definition at line 52 of file TrackProcessorUserActionBase.cxx.

{
  m_curBaseISP = nullptr;
  return;
}

entryLayer()

ISF::EntryLayer G4UA::iGeant4::TrackProcessorUserActionFullG4::entryLayer ( const G4Step * aStep )

private

Definition at line 169 of file TrackProcessorUserActionFullG4.cxx.

    {
      //
      // this is the same prescription for getting the entry layer as in
      // MCTruth/MCTruthSteppingAction
      //
 
      const G4StepPoint *preStep =aStep->GetPreStepPoint();
      const G4StepPoint *postStep=aStep->GetPostStepPoint();
 
      const G4TouchableHistory *preTHist=static_cast<const G4TouchableHistory*>(preStep->GetTouchable());
      const G4TouchableHistory *postTHist=static_cast<const G4TouchableHistory*>(postStep->GetTouchable());
      int nLev1 = preTHist->GetHistoryDepth();
      int nLev2 = postTHist->GetHistoryDepth();
 
      std::map<std::string, int, std::less<std::string> >::const_iterator it;
 
      std::string vname1;
      bool pass=false;
      for (it=m_entryLayerMap.begin(); it!=m_entryLayerMap.end(); ++it) {
 
        int il=(*it).second;
 
        if (il<=(nLev1+1)) {
          vname1=preTHist->GetVolume(nLev1-il+1)->GetName();
 
          if (vname1!=(*it).first) continue;
 
          if (il<=(nLev2+1)) {
            if (vname1 == static_cast<const std::string&>(postTHist->GetVolume(nLev2-il+1)->GetName()))
            {
              continue;
            }
          }
 
          pass=true;
          break;
        }
      }
 
 
      ISF::EntryLayer layer=ISF::fUnsetEntryLayer;
      if (pass) {
        if      (!m_config.isITkGeometry && vname1=="IDET::IDET") layer=ISF::fAtlasCaloEntry;
        else if ( m_config.isITkGeometry && vname1=="ITK::ITK")   layer=ISF::fAtlasCaloEntry;
        else if (vname1=="CALO::CALO")       layer=ISF::fAtlasMuonEntry;
        else if (vname1=="MUONQ02::MUONQ02") layer=ISF::fAtlasMuonExit;
      }
 
      return layer;
    }

ISFSteppingAction()

void G4UA::iGeant4::TrackProcessorUserActionFullG4::ISFSteppingAction ( const G4Step * aStep, ISF::ISFParticle * curISP )

finaloverrideprivatevirtual

Called by the base class after the G4Track->ISFParticle association has been established.

Implements G4UA::iGeant4::TrackProcessorUserActionBase.

Definition at line 80 of file TrackProcessorUserActionFullG4.cxx.

    {
      G4Track*           aTrack   = aStep->GetTrack();
      //int               aTrackID  = aTrack->GetTrackID(); // Only used in DEBUG messages
      G4TrackStatus aTrackStatus  = aTrack->GetTrackStatus();
 
      const G4StepPoint *preStep  = aStep->GetPreStepPoint();
      const G4StepPoint *postStep = aStep->GetPostStepPoint();
 
 
      AtlasDetDescr::AtlasRegion nextG4GeoID = ::iGeant4::ISFG4GeoHelper::nextGeoId(aStep,
                                                                                    m_config.
                                                                                    truthVolLevel,
                                                                                    m_geoIDSvcQuick);
      if ( curISP->nextGeoID()!=nextG4GeoID ) {
        curISP->setNextGeoID( nextG4GeoID );
      }
 
      // check if dead track
      if ( aTrackStatus==fStopAndKill ) {
        // ATH_MSG_DEBUG("Stepping dead G4Track, returning. TrackLength="<<aTrack->GetTrackLength()<<
        //               " TrackEkin="<<aTrack->GetKineticEnergy()<<" TrackID="<<aTrackID);
        return;
      }
 
      const G4VPhysicalVolume *preVol  = preStep->GetPhysicalVolume();
      const G4VPhysicalVolume *postVol = postStep->GetPhysicalVolume();
 
      // check if particle left detector volume
      if ( postVol==0 ) {
        // ATH_MSG_DEBUG("G4Step not in physical volume, returning. TrackLength="<<
        //               aTrack->GetTrackLength()<<" TrackEkin="<<aTrack->GetKineticEnergy()<<
        //               " TrackID="<<aTrackID);
        // left world
        return;
      }
 
      // check if particle is within same physical volume
      if ( preVol==postVol ) {
        // ATH_MSG_DEBUG("G4Track stays inside current volume");
        return;
      }
 
      //
      // this point is only reached if particle has crossed
      // a sub-det boundary in the Geant4-only mode
      //
 
      TrackHelper tHelp(aTrack);
 
      // only process particle at entry layer if primary or registered secondary
 
      if ( ! tHelp.IsSecondary() ) {
 
        // get entry layer
        ISF::EntryLayer layer = entryLayer(aStep);
 
        if (layer!=ISF::fUnsetEntryLayer) {
 
 
          AtlasDetDescr::AtlasRegion nextGeoID = ::iGeant4::ISFG4GeoHelper::nextGeoId(aStep,
                                                                                      m_config.truthVolLevel,
                                                                                      m_geoIDSvcQuick);
 
          ISF::ISFParticle *tmpISP = ::iGeant4::ISFG4Helper::convertG4TrackToISFParticle( *aTrack,
                                                                                *curISP,
                                                                                nullptr // truthBinding
                                                                                );
          tmpISP->setNextGeoID(nextGeoID);
          tmpISP->setNextSimID(ISF::fUndefinedSimID);
 
          auto generationZeroBarcode = tHelp.GetBarcode(); // FIXME barcode-based
          tmpISP->setBarcode(generationZeroBarcode); // FIXME barcode-based
          auto generationZeroID = tHelp.GetUniqueID();
          tmpISP->setId(generationZeroID);
 
          tmpISP->setNextGeoID( nextGeoID );
 
          // inform the entry layer tool about this particle
          m_entryLayerToolQuick->registerParticle( *tmpISP, layer);
 
          delete tmpISP;
        }
 
      }
 
      return;
    }

PostUserTrackingAction()

void G4UA::iGeant4::TrackProcessorUserActionBase::PostUserTrackingAction ( const G4Track * )

finaloverridevirtualinherited

Definition at line 244 of file TrackProcessorUserActionBase.cxx.

{
  m_curBaseISP = nullptr;
  return;
}

PreUserTrackingAction()

void G4UA::iGeant4::TrackProcessorUserActionFullG4::PreUserTrackingAction ( const G4Track * aTrack )

finaloverridevirtual

Reimplemented from G4UA::iGeant4::TrackProcessorUserActionBase.

Definition at line 221 of file TrackProcessorUserActionFullG4.cxx.

                                                                                   {
      // reset geoId, call upstream method
      m_nextGeoID = m_config.truthVolLevel>1?AtlasDetDescr::fAtlasCavern:AtlasDetDescr::fUndefinedAtlasRegion;
      m_currentTrack = aTrack;
      TrackProcessorUserActionBase::PreUserTrackingAction(aTrack);
      return;
    }

ReturnSecondaries()

ISF::ISFParticleContainer G4UA::iGeant4::TrackProcessorUserActionBase::ReturnSecondaries ( ISF::ISFParticle const * parent )

inherited

Definition at line 250 of file TrackProcessorUserActionBase.cxx.

{
  // For now, just return all particles
  ISF::ISFParticleContainer result;
  std::swap( result, m_storedSecondaries );
  return result;
}

setupPrimary()

void G4UA::iGeant4::TrackProcessorUserActionBase::setupPrimary ( G4Track & aTrack )

privateinherited

Setup the given G4Track as the current primary particle which we'll process.

Definition at line 121 of file TrackProcessorUserActionBase.cxx.

{
  //
  // Get PrimaryParticleInformation from G4PrimaryParticle (assigned by TransportTool::addPrimaryVertex)
  //
 
  auto* trackInfo = ::iGeant4::ISFG4Helper::getISFTrackInfo(aTrack);
  if ( trackInfo && aTrack.GetCurrentStepNumber() > 0 ) {
    // A suspended primary re-enters PreUserTrackingAction on resume, still
    // carrying the TrackInformation from its first pass. The Quirks extension
    // is the only user of fSuspend. A resumed track keeps its step counter, so
    // a primary genuinely started twice is still fatal below.
    updateCurrentBaseISFParticle( trackInfo->GetBaseISFParticle() );
    return;
  }
  if ( trackInfo ) {
    G4ExceptionDescription description;
    description << G4String("PreUserTrackingAction: ")
                << "Started simulation of primary particle which already has a TrackInformation/TrackBarcodeInfo object attached (trackID: "
                << aTrack.GetTrackID() << ", track pos: "<<aTrack.GetPosition() << ", mom: "<<aTrack.GetMomentum()
                << ", parentID " << aTrack.GetParentID() << ")";
    G4Exception("iGeant4::TrackProcessorUserActionBase", "TrackInformationAlreadyExists", FatalException, description);
    return; // The G4Exception call above should abort the job, but Coverity does not seem to pick this up.
  }
 
  auto* primaryPartInfo = dynamic_cast <PrimaryParticleInformation*> (aTrack.GetDynamicParticle()->GetPrimaryParticle()->GetUserInformation());
  if (!primaryPartInfo) {
    G4ExceptionDescription description;
    description << G4String("PreUserTrackingAction: ") + "NULL PrimaryParticleInformation pointer for current G4Step (trackID "
                << aTrack.GetTrackID() << ", track pos: "<<aTrack.GetPosition() << ", mom: "<<aTrack.GetMomentum()
                << ", parentID " << aTrack.GetParentID() << ")";
    G4Exception("iGeant4::TrackProcessorUserActionBase", "NoPPInfo", FatalException, description);
    return; // The G4Exception call above should abort the job, but Coverity does not seem to pick this up.
  }
 
  // get base ISFParticle and link to TrackInformation
  auto* baseISP = primaryPartInfo->GetISFParticle();
  if (!baseISP) {
    G4ExceptionDescription description;
    description << G4String("PreUserTrackingAction: ") + "No ISFParticle associated with primary particle (trackID: "
                << aTrack.GetTrackID() << ", track pos: "<<aTrack.GetPosition() << ", mom: "<<aTrack.GetMomentum()
                << ", parentID " << aTrack.GetParentID() << ")";
    G4Exception("iGeant4::TrackProcessorUserActionBase", "NoISFParticle", FatalException, description);
    return; // The G4Exception call above should abort the job, but Coverity does not seem to pick this up.
  }
 
  ISF::TruthBinding* truthBinding = baseISP->getTruthBinding();
  if (!truthBinding) {
    G4ExceptionDescription description;
    description << G4String("PreUserTrackingAction: ") + "No ISF::TruthBinding associated with primary particle (trackID: "
                << aTrack.GetTrackID() << ", track pos: "<<aTrack.GetPosition() << ", mom: "<<aTrack.GetMomentum()
                << ", parentID " << aTrack.GetParentID() << ")";
    G4Exception("iGeant4::TrackProcessorUserActionBase", "NoISFTruthBinding", FatalException, description);
    return; // The G4Exception call above should abort the job, but Coverity does not seem to pick this up.
  }
 
  int regenerationNr = primaryPartInfo->GetRegenerationNr();
 
  // Keep the legacy classification based on generation-zero identity; the
  // true primary is stored separately on TrackInformation by ISFG4Helper.
  HepMC::GenParticlePtr generationZeroGenParticle = truthBinding->getGenerationZeroGenParticle();
  HepMC::GenParticlePtr primaryGenParticle = generationZeroGenParticle;
  HepMC::GenParticlePtr currentGenParticle = truthBinding->getCurrentGenParticle();
 
  auto classification = classify(primaryGenParticle,
                                 generationZeroGenParticle,
                                 currentGenParticle,
                                 regenerationNr);
 
  auto* newTrackInfo = ::iGeant4::ISFG4Helper::attachTrackInfoToNewG4Track(aTrack,
                                                                 *baseISP,
                                                                 classification,
                                                                 generationZeroGenParticle );
  newTrackInfo->SetRegenerationNr(regenerationNr);
 
  updateCurrentBaseISFParticle(baseISP);
 
  return;
}

setupSecondary()

void G4UA::iGeant4::TrackProcessorUserActionBase::setupSecondary ( const G4Track & aTrack )

privateinherited

Setup the given G4Track as the current secondary particle which we'll process.

Definition at line 201 of file TrackProcessorUserActionBase.cxx.

{
  auto* trackInfo = ::iGeant4::ISFG4Helper::getISFTrackInfo(aTrack);
 
  ISF::ISFParticle* baseISFParticle = trackInfo->GetBaseISFParticle();
 
  updateCurrentBaseISFParticle(baseISFParticle);
 
  return;
}

updateCurrentBaseISFParticle()

void G4UA::iGeant4::TrackProcessorUserActionBase::updateCurrentBaseISFParticle ( ISF::ISFParticle * baseISFParticle )

privateinherited

Set the base ISFParticle for the currently traced particle.

Definition at line 212 of file TrackProcessorUserActionBase.cxx.

{
  m_curBaseISP = baseISFParticle;
  return;
}

UserSteppingAction()

void G4UA::iGeant4::TrackProcessorUserActionBase::UserSteppingAction ( const G4Step * aStep )

finaloverridevirtualinherited

Definition at line 58 of file TrackProcessorUserActionBase.cxx.

{
  // get geoID from parent
  //TODO ELLI AtlasDetDescr::AtlasRegion curGeoID = m_curBaseISP->nextGeoID();
  //TODO ELLI ATH_MSG_DEBUG( "Currently simulating TrackID = " << aStep->GetTrack()->GetTrackID() <<
  //TODO ELLI                " inside geoID = " << curGeoID );
 
  // AdePT currently does not return the G4Secondary vector per G4Step. As the vector is required to attach
  // the G4VUserInfo in the PreUserTrackingAction below, the G4VUserInfo is not available, which
  // would lead to nullptr access crashes
#ifdef ATHSIMULATION_USE_ADEPT
  return;
#endif
  //
  // call the ISFSteppingAction method of the implementation
  //
  ISFSteppingAction( aStep, m_curBaseISP );
 
  //
  // propagate the current ISFParticle link to all secondaries
  //
  const std::vector<const G4Track*>  *secondaryVector = aStep->GetSecondaryInCurrentStep();
  if (secondaryVector && !secondaryVector->empty()) {
    for ( auto* aConstSecondaryTrack : *secondaryVector ) {
      // get a non-const G4Track for current secondary (nasty!)
      G4Track* aSecondaryTrack ATLAS_THREAD_SAFE = const_cast<G4Track*>( aConstSecondaryTrack ); // imposed by Geant4 interface
 
      auto *trackInfo = ::iGeant4::ISFG4Helper::getISFTrackInfo(*aSecondaryTrack);
 
      // G4Tracks aready returned to ISF will have a TrackInformation attached to them
      bool particleReturnedToISF = trackInfo && trackInfo->GetReturnedToISF();
      if (!particleReturnedToISF) {
        HepMC::GenParticlePtr generationZeroGenParticle{};
        ::iGeant4::ISFG4Helper::attachTrackInfoToNewG4Track( *aSecondaryTrack,
                                                  *m_curBaseISP,
                                                  VTrackInformation::Secondary,
                                                  generationZeroGenParticle );
      }
    } // <- loop over secondaries from this step
  }
 
  return;
}

Member Data Documentation

m_config

Config G4UA::iGeant4::TrackProcessorUserActionFullG4::m_config

private

Definition at line 61 of file TrackProcessorUserActionFullG4.h.

m_curBaseISP

ISF::ISFParticle* G4UA::iGeant4::TrackProcessorUserActionBase::m_curBaseISP {}

privateinherited

The most recent ISFParticle ancestor that triggers the currently processed G4Track.

Definition at line 68 of file TrackProcessorUserActionBase.h.

{};

m_currentTrack

const G4Track* G4UA::iGeant4::TrackProcessorUserActionFullG4::m_currentTrack

private

Definition at line 75 of file TrackProcessorUserActionFullG4.h.

m_entryLayerMap

std::map<std::string, int, std::less<std::string> > G4UA::iGeant4::TrackProcessorUserActionFullG4::m_entryLayerMap

private

Definition at line 72 of file TrackProcessorUserActionFullG4.h.

m_entryLayerToolQuick

ISF::IEntryLayerTool* G4UA::iGeant4::TrackProcessorUserActionFullG4::m_entryLayerToolQuick

private

access to the ISF Entry Layer tool which is used to record entry-layer collections

quickaccess avoiding gaudi ovehead

Definition at line 66 of file TrackProcessorUserActionFullG4.h.

m_geoIDSvcQuick

ISF::IGeoIDSvc* G4UA::iGeant4::TrackProcessorUserActionFullG4::m_geoIDSvcQuick

private

access to the central ISF GeoID serice

quickaccess avoiding gaudi ovehead

Definition at line 69 of file TrackProcessorUserActionFullG4.h.

m_nextGeoID

AtlasDetDescr::AtlasRegion G4UA::iGeant4::TrackProcessorUserActionFullG4::m_nextGeoID

private

Definition at line 74 of file TrackProcessorUserActionFullG4.h.

m_storedSecondaries

ISF::ISFParticleContainer G4UA::iGeant4::TrackProcessorUserActionBase::m_storedSecondaries

protectedinherited

Definition at line 45 of file TrackProcessorUserActionBase.h.

---

The documentation for this class was generated from the following files:

• TrackProcessorUserActionFullG4.h
• TrackProcessorUserActionFullG4.cxx