G4UA::iGeant4::TrackProcessorUserActionBase Class Reference

#include <TrackProcessorUserActionBase.h>

Inheritance diagram for G4UA::iGeant4::TrackProcessorUserActionBase:

Collaboration diagram for G4UA::iGeant4::TrackProcessorUserActionBase:

Public Member Functions
	TrackProcessorUserActionBase ()=default
virtual void	BeginOfEventAction (const G4Event *) override final
virtual void	EndOfEventAction (const G4Event *) override final
virtual void	PreUserTrackingAction (const G4Track *) override
virtual void	PostUserTrackingAction (const G4Track *) override final
virtual void	UserSteppingAction (const G4Step *) override final
ISF::ISFParticleContainer	ReturnSecondaries (ISF::ISFParticle const *parent)

Protected Member Functions
virtual void	ISFSteppingAction (const G4Step *, ISF::ISFParticle *)=0
	This method is called by TrackProcessorUserActionBase after the G4Track->ISFParticle association has been established for the current G4Track.

Protected Attributes
ISF::ISFParticleContainer	m_storedSecondaries

Private Member Functions
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
ISF::ISFParticle *	m_curBaseISP {}
	The most recent ISFParticle ancestor that triggers the currently processed G4Track.

Detailed Description

Definition at line 27 of file TrackProcessorUserActionBase.h.

Constructor & Destructor Documentation

TrackProcessorUserActionBase()

G4UA::iGeant4::TrackProcessorUserActionBase::TrackProcessorUserActionBase ( )

default

Member Function Documentation

BeginOfEventAction()

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

finaloverridevirtual

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

private

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

Definition at line 212 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 * )

finaloverridevirtual

Definition at line 52 of file TrackProcessorUserActionBase.cxx.

{
  m_curBaseISP = nullptr;
  return;
}

ISFSteppingAction()

virtual void G4UA::iGeant4::TrackProcessorUserActionBase::ISFSteppingAction ( const G4Step * , ISF::ISFParticle *  )

protectedpure virtual

This method is called by TrackProcessorUserActionBase after the G4Track->ISFParticle association has been established for the current G4Track.

Implemented in G4UA::iGeant4::TrackProcessorUserActionFullG4, and G4UA::iGeant4::TrackProcessorUserActionPassBack.

PostUserTrackingAction()

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

finaloverridevirtual

Definition at line 236 of file TrackProcessorUserActionBase.cxx.

{
  m_curBaseISP = nullptr;
  return;
}

PreUserTrackingAction()

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

overridevirtual

Reimplemented in G4UA::iGeant4::TrackProcessorUserActionFullG4.

Definition at line 102 of file TrackProcessorUserActionBase.cxx.

{
  // AdePT currently does not return the G4Secondary vector per G4Step. As the vector is required to attach
  // the G4VUserInfo below the G4VUserInfo is not available, which would lead to nullptr access crashes
#ifdef ATHSIMULATION_USE_ADEPT
  return;
#endif
 
  bool isPrimary = ! aTrack->GetParentID();
  if (isPrimary) {
    G4Track* nonConstTrack ATLAS_THREAD_SAFE = const_cast<G4Track*> (aTrack); // imposed by Geant4 interface
    setupPrimary(*nonConstTrack);
  } else {
    setupSecondary(*aTrack);
  }
 
  return;
}

ReturnSecondaries()

ISF::ISFParticleContainer G4UA::iGeant4::TrackProcessorUserActionBase::ReturnSecondaries

(

ISF::ISFParticle const *

parent

)

Definition at line 242 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 )

private

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 ) {
    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 )

private

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

Definition at line 193 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 )

private

Set the base ISFParticle for the currently traced particle.

Definition at line 204 of file TrackProcessorUserActionBase.cxx.

{
  m_curBaseISP = baseISFParticle;
  return;
}

UserSteppingAction()

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

finaloverridevirtual

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_curBaseISP

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

private

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

Definition at line 68 of file TrackProcessorUserActionBase.h.

{};

m_storedSecondaries

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

protected

Definition at line 45 of file TrackProcessorUserActionBase.h.

---

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

• TrackProcessorUserActionBase.h
• TrackProcessorUserActionBase.cxx