PhysicsValidationUserAction.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
// class header
#include "PhysicsValidationUserAction.h"
 
// ISF includes
#include "ISF_Event/ISFParticle.h"
 
#include "ISF_Interfaces/IParticleHelper.h"
 
// ISF Geant4 includes
#include "ISF_Geant4Event/Geant4TruthIncident.h"
 
//Athena includes
#include "AtlasDetDescr/AtlasRegion.h"
#include "MCTruth/AtlasG4EventUserInfo.h"
#include "MCTruth/VTrackInformation.h"
 
// Geant4 includes
#include "G4ParticleDefinition.hh"
#include "G4DynamicParticle.hh"
#include "G4TouchableHistory.hh"
#include "G4Event.hh"
#include "G4EventManager.hh"
#include "G4Step.hh"
#include "G4TransportationManager.hh"
 
//External includes
#include "AtlasHepMC/GenVertex.h"
// ROOT includes
#include "TTree.h"
// STL includes
#include <cmath>
#include <iostream>
#include "GaudiKernel/ISvcLocator.h"
 
namespace G4UA{
 
  namespace iGeant4 {
 
    PhysicsValidationUserAction::PhysicsValidationUserAction(const Config& config)
      : AthMessaging("PhysicsValidationUserAction")
      , m_config(config)
      , m_geoIDSvcQuick(nullptr)
      // branches
      , m_particles(nullptr)
      , m_pdg(0)
      , m_scIn(0)
      , m_scEnd(0)
      , m_gen(0)
      , m_geoID(0)
      , m_pth(0.)
      , m_pph(0.)
      , m_p(0.)
      , m_eloss(0.)
      , m_radloss(0.)
      , m_ionloss(0.)
      , m_wzOaTr(0), m_thIn(0), m_phIn(0), m_dIn(0)
      , m_thEnd(0), m_phEnd(0), m_dEnd(0)
      , m_X0(0), m_L0(0), m_wZ(0), m_dt(0)
      // more branches
      , m_interactions(nullptr)
      , m_process(0), m_pdg_mother(0), m_gen_mother(0), m_nChild(0)
      , m_vtx_dist(0), m_vtx_theta(0), m_vtx_phi(0), m_vtx_e_diff(0)
      , m_vtx_p_diff(0), m_vtx_plong_diff(0), m_vtx_pperp_diff(0)
      , m_p_mother(0), m_radLength(0)
      , m_volumeOffset(1)
      , m_minHistoryDepth(0)
      , m_currentTrack(0)
    {
      setLevel(m_config.verboseLevel);
    }
 
    void PhysicsValidationUserAction::BeginOfEventAction(const G4Event*)
    {
 
 
      ATH_MSG_VERBOSE("idRmax: "<<m_config.idR      <<", idZmax: "<<m_config.idZ);
      ATH_MSG_VERBOSE("caloR : "<<m_config.caloRmean<<", caloZ : "<<m_config.caloZmean);
      ATH_MSG_VERBOSE("muonR : "<<m_config.muonRmean<<", muonZ : "<<m_config.muonZmean);
      ATH_MSG_VERBOSE("muonR : "<<m_config.cavernRmean<<", muonZ : "<<m_config.cavernZmean);
      ATH_MSG_VERBOSE("cavernR : "<<m_config.cavernRmean<<", cavernZ : "<<m_config.cavernZmean);
      
      m_currentTrack = -1;
      m_trackGenMap.clear();
      //m_idToStackParticleMap.clear();
      
      
    }
 
    void PhysicsValidationUserAction::EndOfEventAction(const G4Event*)
    {
      
      m_X0=0.;
      m_L0=0.;
      m_wZ=0.;
      m_wzOaTr=0.;
      
      m_radLength=0;
      
      return;
    }
 
    void PhysicsValidationUserAction::BeginOfRunAction(const G4Run*)
    {
 
      if (m_config.geoIDSvc.retrieve().isFailure()) {
    ATH_MSG_FATAL("Could not retrieve ISF GeoID Svc: " << m_config.geoIDSvc);
    return;
      }
 
      m_geoIDSvcQuick = &(*m_config.geoIDSvc);
 
      // setup for validation mode
      if ( m_config.validationOutput) {
    
    // retrieve the histogram service
    if ( m_config.thistSvc.retrieve().isSuccess() ) {
      // Create the prefix of histogram names for the THistSvc
      const char *treeName="particles";
      const std::string prefix = "/" + m_config.validationStream + "/"+ treeName;
      m_particles = new TTree( treeName, treeName );
      m_particles->Branch("pdg"       , &m_pdg    , "pdg/I"         );         // pdg id
      m_particles->Branch("scIn"      , &m_scIn   , "scIn/I"         );        // input process
      m_particles->Branch("scOut"     , &m_scEnd  , "scOut/I"         );       // endpoint process
      m_particles->Branch("gen"       , &m_gen    , "gen/I"         );         // generation (0 for primary)
      m_particles->Branch("geoID"     , &m_geoID  , "geoID/I"         );       // subdetector id
      m_particles->Branch("pth"       , &m_pth     , "pth/F"            );     // input momentum polar angle
      m_particles->Branch("pph"       , &m_pph     , "pph/F"            );     // input momemtum azimuthal angle
      m_particles->Branch("p"         , &m_p      , "p/F"            );        // input momentum
      m_particles->Branch("eloss"     , &m_eloss  , "eloss/F"            );    // energy loss
      m_particles->Branch("radloss"     , &m_radloss  , "radloss/F"            );   // radiative eloss
      m_particles->Branch("ionloss"     , &m_ionloss  , "ionloss/F"            );   // ionization eloss
      m_particles->Branch("wzOaTr"     , &m_wzOaTr  , "wzOaTr/F"            );      // zOverZtimesRho times dInX0
      m_particles->Branch("X0"        , &m_X0     , "X0/F"            );            // dInX0 (material thickness)
      m_particles->Branch("L0"        , &m_L0     , "L0/F"            );            // dInL0
      m_particles->Branch("wZ"        , &m_wZ     , "wZ/F"            );            // averageZ time dInX0
      m_particles->Branch("dt"        , &m_dt     , "dt/F"            );            // time interval
      m_particles->Branch("thIn"      , &m_thIn   , "thIn/F"            );          // polar angle input position
      m_particles->Branch("phIn"      , &m_phIn   , "phIn/F"            );          // azimuthal angle input position
      m_particles->Branch("dIn"       , &m_dIn    , "dIn/F"            );           // distance input position
      m_particles->Branch("thEnd"     , &m_thEnd  , "thEnd/F"            );         // polar angle exit position
      m_particles->Branch("phEnd"     , &m_phEnd  , "phEnd/F"            );         // azimuthal angle exit position
      m_particles->Branch("dEnd"      , &m_dEnd   , "dEnd/F"            );          // distance exit position
      
      // register the Tree to the THistSvc and return it's StatusCode
      if(m_config.thistSvc->regTree( prefix, m_particles)!=StatusCode::SUCCESS){
        ATH_MSG_ERROR("Cannot register validation tree");
      }
      
      m_X0=0.;
      m_L0=0.;
      m_wZ=0.;
      m_wzOaTr=0.;
      
      const char *treeNameInt="interactions";
      const std::string prefixInt = "/" + m_config.validationStream + "/"+ treeNameInt;
      m_interactions = new TTree( treeNameInt, treeNameInt );
      m_interactions->Branch("process"     , &m_process  , "process/I"         );
      m_interactions->Branch("pdg_mother"  , &m_pdg_mother  , "pdg_mother/I"         );
      m_interactions->Branch("gen_mother"  , &m_gen_mother  , "gen_mother/I"         );
      m_interactions->Branch("nChild"      , &m_nChild      , "nch/I"         );
      m_interactions->Branch("vtx_dist"    , &m_vtx_dist    , "vtx_dist/F"         );
      m_interactions->Branch("vtx_theta"   , &m_vtx_theta   , "vtx_theta/F"         );
      m_interactions->Branch("vtx_phi"     , &m_vtx_phi     , "vtx_phi/F"         );
      m_interactions->Branch("vtx_e_diff"  , &m_vtx_e_diff  , "vtx_e_diff/F"         );
      m_interactions->Branch("vtx_p_diff"  , &m_vtx_p_diff  , "vtx_p_diff/F"         );
      m_interactions->Branch("vtx_plong_diff"  , &m_vtx_plong_diff  , "vtx_plong_diff/F"         );
      m_interactions->Branch("vtx_pperp_diff"  , &m_vtx_pperp_diff  , "vtx_pperp_diff/F"         );
      m_interactions->Branch("radLength"    , &m_radLength     , "radLength/F"         );
      m_interactions->Branch("p_mother"    , &m_p_mother    , "p_mother/F"         );
      m_interactions->Branch("pdg_child"   , m_pdg_child    , "pdg_child[nch]/I"         );
      m_interactions->Branch("fp_child"    , m_fp_child     , "fp_child[nch]/F"         );
      m_interactions->Branch("oa_child"    , m_oa_child     , "oa_child[nch]/F"         );
      // register the Tree to the THistSvc and return it's StatusCode
      if(m_config.thistSvc->regTree( prefixInt, m_interactions)!=StatusCode::SUCCESS){
        ATH_MSG_ERROR("Cannot register validation tree");
      }
      
      m_radLength = 0.;
      
    }
      }
      
      
      // get the geometry manager and check how many layers are present.
      G4TransportationManager *transportationManager(G4TransportationManager::GetTransportationManager());
      G4LogicalVolume *world((*(transportationManager->GetWorldsIterator()))->GetLogicalVolume());
      ATH_MSG_VERBOSE("World G4LogicalVolume Name: " << world->GetName() << " has " << world->GetNoDaughters() << " daughters.");
      if ("World::World"==world->GetName())
    {
      ATH_MSG_INFO("Atlas::Atlas is not the world volume, so assume we are in a cosmics job.");
      //Cosmics-specific configuration.
      m_volumeOffset=2;
      m_minHistoryDepth=1;
    }
      
    }
 
    void PhysicsValidationUserAction::UserSteppingAction(const G4Step* aStep)
    {
      //std::cout<<"PhysicsValidationUserAction::SteppingAction"<<std::endl;
      
      // process identification
      const G4VProcess * process = aStep->GetPostStepPoint()->GetProcessDefinedStep();
      
      // material info
      G4StepPoint *preStep=aStep->GetPreStepPoint();
      G4StepPoint *postStep=aStep->GetPostStepPoint();
      
      G4ThreeVector mom = preStep->GetMomentum();
      const G4ThreeVector& pos = preStep->GetPosition();
      
      // info about generating particle
      G4Track * track = aStep->GetTrack();
      
      int trackID=track->GetTrackID();
      const bool trackIsAlive = (track->GetTrackStatus() == fAlive || track->GetTrackStatus() == fStopButAlive);
      
      if (trackID != m_currentTrack) {     // for new G4Track only
    
    m_pdg = track->GetDefinition()->GetPDGEncoding();
    const G4VProcess* creation = track->GetCreatorProcess();
    m_scIn = creation? creation->GetProcessSubType() : -1;
    
    VTrackInformation * trackInfo= static_cast<VTrackInformation*>(track->GetUserInformation());
    HepMC::GenParticlePtr currentGenParticle= trackInfo ? trackInfo->GetCurrentGenParticle() : nullptr;
    HepMC::GenVertexPtr vtx = currentGenParticle ? currentGenParticle->production_vertex() : nullptr;
    m_gen = currentGenParticle? 0 : -1;
    
    if (currentGenParticle)  { // mc truth known
      while (currentGenParticle && vtx ) {
        int pdgID=currentGenParticle->pdg_id();
#ifdef HEPMC3
        const HepMC::GenParticlePtr  genmom = vtx->particles_in().size()>0 ? vtx->particles_in().front() : nullptr;
        if ( genmom && pdgID!=genmom->pdg_id() ) m_gen++;
        else if (vtx->particles_out().size()>0 && currentGenParticle!=vtx->particles_out().front()) m_gen++;
 
#else
        HepMC::GenParticlePtr genmom = vtx->particles_in_size()>0 ? *(vtx->particles_in_const_begin()) : nullptr;
        if ( genmom && pdgID!=genmom->pdg_id() ) m_gen++;
        else if (vtx->particles_out_size()>0 && currentGenParticle!=*(vtx->particles_out_const_begin())) m_gen++;
#endif
        vtx = genmom ? genmom->production_vertex() : nullptr;
        currentGenParticle = genmom;
      }
    } else {
      // retrieve info from parent track
      int parentID=track->GetParentID();
      std::map<int, int>::iterator genIt = m_trackGenMap.find(parentID);
      if ( genIt != m_trackGenMap.end()) m_gen = (genIt->second >= 0) ? genIt->second+1 : genIt->second-1;
    }
    
    m_trackGenMap.try_emplace(trackID, m_gen);
    
    m_currentTrack=trackID;
    
    m_radLength = 0.;
      }
      
      AtlasDetDescr::AtlasRegion geoID = m_geoIDSvcQuick->identifyNextGeoID( pos.x(),
                                         pos.y(),
                                         pos.z(),
                                         mom.x(),
                                         mom.y(),
                                         mom.z() );
      
      
      
      double stepLength = aStep->GetStepLength();
      double radLengthInX0  = preStep->GetMaterial()->GetRadlen();
      double l0  = preStep->GetMaterial()->GetNuclearInterLength();
      float stepInX0   = stepLength/radLengthInX0;
      
      if (stepInX0>1.e-06) {
    
    m_X0 += stepInX0;
    m_radLength += stepInX0;
    
    if (l0>0.) {
      m_L0 += stepLength/l0;
      // average Z/A over fraction of atoms rather than weight fraction
      // const G4double* fVec = preStep->GetMaterial()->GetFractionVector();      // mass fraction
      double totNA =  preStep->GetMaterial()->GetTotNbOfAtomsPerVolume();
      const G4ElementVector* eVec = preStep->GetMaterial()->GetElementVector();
      const G4double* atVector = preStep->GetMaterial() ->GetVecNbOfAtomsPerVolume();
      float mFactor =stepInX0* preStep->GetMaterial()->GetDensity();
      
      float zOverA = 0.;    float frSum = 0.;
      for (unsigned int i=0; i<eVec->size(); i++) {
        float fEl = atVector ?  atVector[i]/totNA : 0.;
        m_wZ += stepInX0*fEl*((*eVec)[i]->GetZ());
        //std::cout <<"elements:"<<i<<","<<fVec[i]<<":"<<(*eVec)[i]->GetZ()<< ","<<m_wZ<<","<<m_wZ/m_X0<<std::endl;
        //m_wA += stepInX0*fVec[i]*((*eVec)[i]->GetA());
        zOverA += fEl*((*eVec)[i]->GetZ())/((*eVec)[i]->GetA());
        frSum += fEl;
      }
      if (fabs(frSum-1.)>0.01)  ATH_MSG_DEBUG("G4 material description inconsistent, sum of element fractions:"<< frSum);
      m_wzOaTr += mFactor*zOverA;
    }
    
      }
      
      
      // save interaction info (if any)
      if ( process && process->GetProcessSubType()>0 && process->GetProcessSubType()!=91) {
    
    float eloss = postStep->GetMomentum().mag()-preStep->GetMomentum().mag();
    
    if (process->GetProcessSubType()==2 ) m_ionloss+=eloss;
    if (process->GetProcessSubType()==3 ) m_radloss+=eloss;
    
    AtlasG4EventUserInfo* atlasG4EvtUserInfo = static_cast<AtlasG4EventUserInfo*> (G4EventManager::GetEventManager()->GetConstCurrentEvent()->GetUserInformation());
    VTrackInformation * trackInfo = static_cast<VTrackInformation*>(track->GetUserInformation());
    ::iGeant4::Geant4TruthIncident truth( aStep, *trackInfo->GetBaseISFParticle(), geoID, atlasG4EvtUserInfo);
    unsigned int nSec = truth.numberOfChildren();
    if (nSec>0 || !trackIsAlive ) {      // save interaction info
      //std::cout <<"interaction:"<< process->GetProcessSubType() <<":"<<nSec<< std::endl;
      m_process=process->GetProcessSubType();
      m_pdg_mother = track->GetDefinition()->GetPDGEncoding();
      m_gen_mother = m_gen;
      G4ThreeVector mom = preStep->GetMomentum();
      m_p_mother   = mom.mag();
      
      m_vtx_dist    = postStep->GetPosition().mag();
      m_vtx_theta   = postStep->GetPosition().theta();
      m_vtx_phi     = postStep->GetPosition().phi();
      
      int iPrimSurv = !trackIsAlive ? 0 : 1;
      m_nChild     = nSec+iPrimSurv;
      
      G4ThreeVector pbal(mom);
      
      if (iPrimSurv>0) {
        m_pdg_child[0] = m_pdg_mother;
        m_fp_child[0] = postStep->GetMomentum().mag()/m_p_mother;
        m_oa_child[0] = mom*postStep->GetMomentum()/m_p_mother/postStep->GetMomentum().mag();
        pbal -= postStep->GetMomentum();
      }
      
      unsigned int nSecMax = nSec+iPrimSurv> MAXCHILDREN ? MAXCHILDREN-iPrimSurv : nSec;
      for (unsigned int isec=0; isec< nSec; isec++) {
        G4ThreeVector secMom = truth.childP(isec);
        if (isec<nSecMax) {
          m_pdg_child[isec+iPrimSurv] = truth.childPdgCode(isec);
          m_fp_child[isec+iPrimSurv] = secMom.mag()/m_p_mother;
          m_oa_child[isec+iPrimSurv] = secMom*mom/m_p_mother/secMom.mag();
        }
        pbal -= secMom;
      }
      
      m_vtx_p_diff = pbal.mag();
      m_vtx_plong_diff = pbal*mom/m_p_mother;
      m_vtx_pperp_diff = std::sqrt(m_vtx_p_diff*m_vtx_p_diff-m_vtx_plong_diff*m_vtx_plong_diff);
      
      m_interactions->Fill();
      
      // reset the radiation length
      if (m_process==3) m_radLength = 0.;
    }
      }
      
      // crossing subdetector boundary ?
      G4VPhysicalVolume *preVol=preStep->GetPhysicalVolume();
      G4VPhysicalVolume *postVol=postStep->GetPhysicalVolume();
      
      if (postVol==0) {
    // left world -save info
    m_scEnd = 0;
    m_geoID = geoID;
    m_dt = track->GetLocalTime();
    
    m_pth = track->GetVertexMomentumDirection().theta();
    m_pph = track->GetVertexMomentumDirection().phi();
    m_p   = track->GetVertexKineticEnergy();
    m_eloss = track->GetKineticEnergy()-m_p;
    
    m_thIn= track->GetVertexPosition().theta();
    m_phIn= track->GetVertexPosition().phi();
    m_dIn=  track->GetVertexPosition().mag();
    
    m_thEnd=postStep->GetPosition().theta();
    m_phEnd=postStep->GetPosition().phi();
    m_dEnd=postStep->GetPosition().mag();
    
    m_particles->Fill();
    m_X0 = 0.;
    m_L0 = 0.;
    m_wZ = 0.;
    m_wzOaTr = 0.;
    
    m_radloss = 0.;
    m_ionloss = 0.;
    
    return;
      }
      
      // if particle killed, save the info
      if ( !trackIsAlive ) {
    m_scEnd = process? process->GetProcessSubType() : -1;
    m_geoID = geoID;
    m_dt = track->GetLocalTime();
    
    m_pth = track->GetVertexMomentumDirection().theta();
    m_pph = track->GetVertexMomentumDirection().phi();
    m_p   = track->GetVertexKineticEnergy();
    m_eloss = track->GetKineticEnergy()-m_p;
    
    m_thIn= track->GetVertexPosition().theta();
    m_phIn= track->GetVertexPosition().phi();
    m_dIn=  track->GetVertexPosition().mag();
    
    m_thEnd=postStep->GetPosition().theta();
    m_phEnd=postStep->GetPosition().phi();
    m_dEnd=postStep->GetPosition().mag();
    
    m_particles->Fill();
    m_X0 = 0.;
    m_L0 = 0.;
    m_wZ = 0.;
    m_radloss = 0.;
    m_ionloss = 0.;
    m_wzOaTr = 0.;
    m_radLength = 0.;
      }
      
      if ( preVol==postVol ) return;      // assume boundaries do not cross G4Volumes
      
      // Detector boundaries defined by central GeoIDSvc
      const G4ThreeVector &postPos  = postStep->GetPosition();
      const G4ThreeVector &postMom  = postStep->GetMomentum();
      AtlasDetDescr::AtlasRegion  nextGeoID = m_geoIDSvcQuick->identifyNextGeoID( postPos.x(),
                                          postPos.y(),
                                          postPos.z(),
                                          postMom.x(),
                                          postMom.y(),
                                          postMom.z() );
      
      // save info if leaving the subdetector
      if ( nextGeoID == geoID) {
    ATH_MSG_DEBUG("track stays inside "<<geoID);
      } else {
        ATH_MSG_DEBUG("track moves from "<<geoID<<" to "<<nextGeoID);
 
        // Don't save if doing a zero step ?
        //if (aStep->GetTrack()->GetTrackLength() == 0.) {
        if (aStep->GetStepLength() == 0.) {
          return;
        }
 
        // don't change geometry assignment for validation ntuple
        m_geoID = geoID;
 
        //4ParticleDefinition* particleDefinition = track->GetDefinition();
 
        const G4ThreeVector& g4pos = track->GetPosition();
        //const double gTime = track->GetGlobalTime();
        const HepGeom::Point3D<double> position(g4pos.x(),g4pos.y(),g4pos.z());
 
        G4ThreeVector g4mom = track->GetMomentum();
        const HepGeom::Vector3D<double> momentum(g4mom.x(),g4mom.y(),g4mom.z());
 
        bool dead=false;
        if (track->GetTrackStatus()==fStopAndKill) {
          dead=true;
        }
 
        if (!dead) {
 
          // track info
          //VTrackInformation * trackInfo= static_cast<VTrackInformation*>(track->GetUserInformation());
          m_scEnd = 0;
          m_dt = track->GetLocalTime();
 
          m_pth = track->GetVertexMomentumDirection().theta();
          m_pph = track->GetVertexMomentumDirection().phi();
          m_p   = track->GetVertexKineticEnergy();
          m_eloss = track->GetKineticEnergy()-m_p;
 
          m_thIn= track->GetVertexPosition().theta();
          m_phIn= track->GetVertexPosition().phi();
          m_dIn=  track->GetVertexPosition().mag();
 
          m_thEnd=postStep->GetPosition().theta();
          m_phEnd=postStep->GetPosition().phi();
          m_dEnd=postStep->GetPosition().mag();
 
          m_particles->Fill();
          m_X0 = 0.;
          m_L0 = 0.;
          m_wZ = 0.;
          m_radloss = 0.;
          m_ionloss = 0.;
          m_wzOaTr= 0.;
        }
        m_X0=0.;
 
      }
      
    }
 
    void PhysicsValidationUserAction::PreUserTrackingAction(const G4Track*)
    {
      return;
    }
 
  } // namespace iGeant4
 
} // namespace G4UA