src/TStandard_Analysis.cc

Go to the documentation of this file.

/*
* 
* Copyright: Mathieu Trocme, mathieu.trocme@gmail.com (21 september 2009)
* 
* This software is a computer program whose purpose is to: provide a universal Hit/SD output method in Geant4 with a proper Root coupling 
* 
* This software is governed by the CeCILL license under French law and abiding by the rules of distribution of free software. 
* You can use, modify and/or redistribute the software under the terms of the CeCILL license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
* As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the successive licensors have only limited liability. 
* In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. 
* Users are therefore encouraged to load and test the software's suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security. 
* 
* The fact that you are presently reading this means that you have had knowledge of the CeCILL license and that you accept its terms.
* 
*/


// 
// Documentation : See doc.html (readme, main.cc, ...)
// Convention    : Root coding convention: TMyClass for classes, fMyVariable for class data members, kMyVariable for constants, gMyVariable for global variables
// Help          : http://www.lcsim.org/software/geant4/doxygen/html/classes.html
// 


#include "TStandard_Analysis.hh" 
#include "TStandard_Analysis_Messenger.hh"  /// for compilation reason


// *********************************************************************************************************


TStandard_Analysis::TStandard_Analysis ( TAlphaRad_DetectorConstruction* theTAlphaRad_DetectorConstruction , TGPS_PrimaryGeneratorAction* theTGPS_PrimaryGeneratorAction )
{

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::TStandard_Analysis() \n" ; }

   fTAlphaRad_DetectorConstruction   = theTAlphaRad_DetectorConstruction   ; 
   fTGPS_PrimaryGeneratorAction = theTGPS_PrimaryGeneratorAction ; 
 
   fTStandard_Analysis_msg = new TStandard_Analysis_Messenger (this) ;

   /// Run 

   fRootFout = NULL ; fRootFoutName = "" ; 
   fRootTree = NULL ; 

   fNCells = fTAlphaRad_DetectorConstruction->GetNCells() ; 
   fTMyRootEvent = new TMyRootEvent () ; 
   fTMyRootEvent->InitEvent(fNCells) ;   

   fRunNumber = -1 ; 
   fNEvents = -1 ; 
   fEventNumber = -1 ;  
   fTimer_tot = new G4Timer () ; fTimer_tot->Start() ;
   fTimer_run = new G4Timer () ; 

   /// Event 

   fSDManager = G4SDManager::GetSDMpointer() ;

   fCell_HC_ID = new G4int                    [fNCells] ; for (G4int cellNumber=0; cellNumber<fNCells; cellNumber++) { fCell_HC_ID[cellNumber] = -1   ; }
   fCell_HC    = new THitsCollection* [fNCells] ; for (G4int cellNumber=0; cellNumber<fNCells; cellNumber++) { fCell_HC   [cellNumber] = NULL ; }
   fHCE = NULL ; 
   fHit = NULL ; 
   fNHits = -1 ; 
   fTrackID = -1 ; 
   fTrackIDarray = NULL ;
   fDirection_z = G4ThreeVector(0.,0.,1.) ;

   /// Stepping

//    fParticleName = "particle_nothing" ;  
//    fVolumeName   = "volume_nothing"   ;  
//    fHasEnteredTheDetector = false ; 

   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::TStandard_Analysis() \n" ; }
   
}


// *********************************************************************************************************


TStandard_Analysis::~TStandard_Analysis ()
{

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::~TStandard_Analysis() \n" ; }

   fTimer_tot->Stop() ; 
   fprintf (stdout,"\n\n") ;  
   fprintf (stdout,"*********************************************\n") ;  
   fprintf (stdout," >> Total Computing time = %.1f s\n",fTimer_tot->GetRealElapsed()) ;  
   fprintf (stdout,"*********************************************\n") ; 

   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::~TStandard_Analysis() \n" ; }

}


/// *********************************************************************************************************
/// *********************************************************************************************************
///  Run Action
/// *********************************************************************************************************
/// *********************************************************************************************************


void TStandard_Analysis::BeginOfRun ( const G4Run* aRun )
{  

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::BeginOfRun() \n" ; }

   fTimer_run->Start() ;
   fRunNumber = aRun->GetRunID() + 1 ;
   fNEvents = aRun->GetNumberOfEventToBeProcessed() ;

   if ( fRootFoutName == "" )  /// See TStandard_Analysis_Messenger::TStandard_Analysis_Messenger()
   { 
      fRootFoutName = TString(Form("alpharad_%.0e_%s_t=%03dmum_r=%03dmm_sdd=%03dmm.root",
         Double_t(fNEvents), TString(fTGPS_PrimaryGeneratorAction->GetGPS()->GetCurrentSource()->GetParticleDefinition()->GetParticleName()).Data(),
         Int_t(fTGPS_PrimaryGeneratorAction->GetGPS()->GetCurrentSource()->GetPosDist()->GetHalfZ()/micrometer),
         Int_t(fTGPS_PrimaryGeneratorAction->GetGPS()->GetCurrentSource()->GetPosDist()->GetRadius()/mm),
         Int_t(fTAlphaRad_DetectorConstruction->GetSourceToDetectorDistance()/mm))) ; 
   }
   fRootFout = new TFile (fRootFoutName,"RECREATE","AlphaRad GEANT4 simulation") ;
   if ( fRootFout == NULL ) { G4Exception( G4String("\n!!!\n!!! Error in TDummy_RunAction::BeginOfRunAction(): '" + fRootFoutName + "' cannot be created. \n!!!").data() ) ; } 
   fRootTree = new TTree ("tree","AlphaRad GEANT4 simulation") ; 

   fNInitialParticles = new TParameter<long> ("nInitialParticles",fNEvents) ; 
   fRootTree->GetUserInfo()->Add(fNInitialParticles) ; 
   fRootTree->Branch("evt","TMyRootEvent",&fTMyRootEvent) ; 

   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::BeginOfRun() \n" ; }

   return ; 

}


// *********************************************************************************************************


void TStandard_Analysis::EndOfRun ( const G4Run* aRun )
{ 

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::EndOfRun() \n" ; }

   fRootTree->Write() ;  
   fRootFout->Close() ;  

   fTimer_run->Stop() ;
   fprintf (stdout,"\n\n###########################################################################################################################################") ; 
   fprintf (stdout,"\n#") ;  
   fprintf (stdout,"\n# Simulation successful (See file '%s', running time = %.1f s) ",fRootFoutName.Data(),fTimer_run->GetRealElapsed()) ;  
   fprintf (stdout,"\n#") ;  
   fprintf (stdout,"\n###########################################################################################################################################\n\n") ;  

   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::EndOfRun() \n" ; }

   return ; 
}


/// *********************************************************************************************************
/// *********************************************************************************************************
///  Event Action
/// *********************************************************************************************************
/// *********************************************************************************************************


void TStandard_Analysis::BeginOfEvent ( const G4Event* aEvent )
{  

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::BeginOfEvent() \n" ; }

   fEventNumber = aEvent->GetEventID()+1 ; 

   if ( ( fEventNumber%1000 ) == 0  ) { fprintf (stdout,"*** Event %010ld/%010ld \n",fEventNumber,fNEvents) ; } 

   for (G4int cellNumber=0; cellNumber<fNCells; cellNumber++) 
   { 
      fCell_HC_ID[cellNumber] = fSDManager->GetCollectionID( fTAlphaRad_DetectorConstruction->GetSDName(cellNumber) + "/" + fTAlphaRad_DetectorConstruction->GetSDName(cellNumber) + "_HC" ) ;  
   }

   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::BeginOfEvent() \n" ; }

   return ; 

}


// *********************************************************************************************************


void TStandard_Analysis::EndOfEvent ( const G4Event* aEvent )
{ 

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::EndOfEvent() \n" ; }

   /// Getting fHCE and filling fCell_HC [cellNumber]

   fHCE = aEvent->GetHCofThisEvent() ;            
   if ( fHCE != NULL )  {               
      for (G4int cellNumber=0; cellNumber<fNCells; cellNumber++) { 
         if ( fCell_HC_ID [cellNumber]  != -1 ) { fCell_HC [cellNumber] = (THitsCollection*) (fHCE->GetHC(fCell_HC_ID [cellNumber])) ; } 
      }
   }

   /// Computing the number of particles per event

   fTrackID = -1 ; 
   fTrackIDarray = new std::vector<G4int> ;

   for (G4int cellNumber=0; cellNumber<fNCells; cellNumber++) 
   { 
      if ( fCell_HC[cellNumber] != NULL ) 
      { 
         fNHits = fCell_HC[cellNumber]->entries() ; 
         for (G4int hitNumber=0; hitNumber<fNHits; hitNumber++) 
         { 
            fHit = (*fCell_HC[cellNumber])[hitNumber] ; 
            if ( !binary_search(fTrackIDarray->begin(),fTrackIDarray->end(),fHit->GetTrackID()) ) { fTrackID = fHit->GetTrackID() ; fTrackIDarray->push_back(fTrackID) ; }
         } 
      } 
   }
   //fprintf (stdout,"\n\nEvent %09d/%09d:\n",fEventNumber,fNEvents) ;
   //fprintf (stdout,">> fNParticlesPerEvent = %d \n",fTrackIDarray->size()) ; 
   fTMyRootEvent->SetNParticlesPerEvent(fTrackIDarray->size()) ;

   /// Filling the tree particle per particle, cell by cell

   for (unsigned ppe=0; ppe<fTrackIDarray->size() ; ppe++)  /// particlePerEvent
   {
      for (G4int cellNumber=0; cellNumber<fNCells; cellNumber++) 
      {
         fTMyRootEvent->SetVolumeName(cellNumber,TString(fTAlphaRad_DetectorConstruction->GetSDName(cellNumber).data())) ;
         if ( fCell_HC[cellNumber] != NULL ) 
         {
            fNHits = fCell_HC[cellNumber]->entries() ; 
            fNHitsPerParticlePerCell = 0 ; fEdep_cumul = 0. ; fDose_cumul = 0. ; fRangeTot_cumul = 0. ; fRangeProj_cumul = 0. ; fRangeProjZ_cumul = 0. ;  /// working on one particle only
            for (G4int hitNumber=0; hitNumber<fNHits; hitNumber++) 
            { 
               fHit = (*fCell_HC[cellNumber])[hitNumber] ;
               if ( fHit->GetTrackID() == fTrackIDarray->at(ppe) )  /// working on one particle only
               { 
                  //fprintf (stdout,"\nHIT #%012d",hitNumber+1) ; //fHit->Print() ; 
                  fNHitsPerParticlePerCell ++ ;
                  if ( fNHitsPerParticlePerCell == 1 ) {
                     /// Vertex information
                     fTMyRootEvent->SetEventNumber        (fEventNumber) ;  
                     fTMyRootEvent->SetParticleName       (            fHit->GetParticleName       ()     ) ;
                     fTMyRootEvent->SetZ                  (            fHit->GetZ                  ()     ) ;
                     fTMyRootEvent->SetA                  (            fHit->GetA                  ()     ) ;
                     fTMyRootEvent->SetTrackID            (            fHit->GetTrackID            ()     ) ;
                     fTMyRootEvent->SetParentTrackID      (            fHit->GetParentTrackID      ()     ) ;
                     fTMyRootEvent->SetCreatorProcessName (            fHit->GetCreatorProcessName ()     ) ;
                     fTMyRootEvent->SetEkin0              (            fHit->GetEkin0              ()/MeV ) ;
                     fTMyRootEvent->SetRx0                (            fHit->GetRx0                ()/um  ) ;
                     fTMyRootEvent->SetRy0                (            fHit->GetRy0                ()/um  ) ;
                     fTMyRootEvent->SetRz0                (            fHit->GetRz0                ()/um  ) ;
                     fTMyRootEvent->SetTheta0             (            fHit->GetTheta0             ()/deg ) ;
                     fTMyRootEvent->SetPhi0               (            fHit->GetPhi0               ()/deg ) ;
                     /// Entrance cell information
                     fTMyRootEvent->SetEkin               (cellNumber, fHit->GetEkin               ()/MeV ) ;
                     fTMyRootEvent->SetRx                 (cellNumber, fHit->GetRx                 ()/um  ) ;
                     fTMyRootEvent->SetRy                 (cellNumber, fHit->GetRy                 ()/um  ) ;
                     fTMyRootEvent->SetRz                 (cellNumber, fHit->GetRz                 ()/um  ) ;
                     fTMyRootEvent->SetTheta              (cellNumber, fHit->GetTheta              ()/deg ) ;
                     fTMyRootEvent->SetPhi                (cellNumber, fHit->GetPhi                ()/deg ) ;
                     fTMyRootEvent->SetGlobalTime         (cellNumber, fHit->GetGlobalTime         ()     ) ;  /// ns  
                     fTMyRootEvent->SetLocalTime          (cellNumber, fHit->GetLocalTime          ()     ) ;  /// ns
                     fTMyRootEvent->SetWeight             (cellNumber, fHit->GetWeight             ()     ) ;
                     fDirection_ref = fHit->GetDirection() ;
                  }
                  /// Inside cell summation
                  fEdep        = fHit->GetEdep    () ; fEdep_cumul     += fEdep     ;
                  fDose        = fHit->GetDose    () ; fDose_cumul     += fDose     ;
                  fRangeTot    = fHit->GetRangeTot() ; fRangeTot_cumul += fRangeTot ;
                  fRangeProj   = fRangeTot*( (fHit->GetDirection()*fDirection_ref) / (fHit->GetDirection().mag()*fDirection_ref.mag()) ) ; fRangeProj_cumul  += fRangeProj  ;  /// fRangeProj  = fRangeTot*cos(v1,v2)
                  fRangeProjZ  = fRangeTot*( (fHit->GetDirection()*fDirection_z  ) / (fHit->GetDirection().mag()*fDirection_z.mag()  ) ) ; fRangeProjZ_cumul += fRangeProjZ ;  /// fRangeProjZ = fRangeTot*cos(v1,uz)
                  //fprintf (stdout,"\n* fEdep = %5.3f MeV / fEdep_cumul = %5.3f MeV", fEdep/MeV, fEdep_cumul/MeV) ; 
                  //fprintf (stdout,"\n* fRangeTot = %6.3f mum / fRangeTot_cumul = %6.3f mum", fRangeTot/um, fRangeTot_cumul/um) ;
                  //fprintf (stdout,"\n* fRangeProj = %6.3f mum / fRangeProj_cumul = %6.3f mum\n", fRangeProj/um, fRangeProj_cumul/um) ;
                  //fprintf (stdout,"\n* fRangeProjZ = %6.3f mum / fRangeProjZ_cumul = %6.3f mum\n", fRangeProjZ/um, fRangeProjZ_cumul/um) ;
               }
            }
            fTMyRootEvent->SetEdep       (cellNumber, fEdep_cumul       /MeV  ) ;
            fTMyRootEvent->SetDose       (cellNumber, fDose_cumul       /gray ) ;
            fTMyRootEvent->SetRangeTot   (cellNumber, fRangeTot_cumul   /um   ) ;
            fTMyRootEvent->SetRangeProj  (cellNumber, fRangeProj_cumul  /um   ) ;
            fTMyRootEvent->SetRangeProjZ (cellNumber, fRangeProjZ_cumul /um   ) ;
            //fprintf (stdout,"\n* fEdep_cumul = %5.3f MeV", fEdep_cumul/MeV) ; 
            //fprintf (stdout,"\n* fRangeTot_cumul = %6.3f mum", fRangeTot_cumul/um) ;
            //fprintf (stdout,"\n* fRangeProj_cumul = %6.3f mum\n", fRangeProj_cumul/um) ;
            //fprintf (stdout,"\n* fRangeProjZ_cumul = %6.3f mum\n", fRangeProjZ_cumul/um) ;
            fTMyRootEvent->SetNHits      (cellNumber, fNHitsPerParticlePerCell) ;
            //fprintf (stdout,"\n\n>> nHits = %d / %d",fNHitsPerParticlePerCell, fTMyRootEvent->GetNHits(cellNumber)) ; 
            //fprintf (stdout,"  \n>> Edep  = %f MeV\n",fEdep/MeV) ; 
         }
      }
      fRootTree->Fill() ;
      fTMyRootEvent->ClearEvent() ;
   }


   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::EndOfEvent() \n" ; }

   return ; 
}


// *********************************************************************************************************
// *********************************************************************************************************
//  Stepping Action
// *********************************************************************************************************
// *********************************************************************************************************


void TStandard_Analysis::Stepping ( const G4Step* aStep )
{  

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::Stepping() \n" ; }

//    //    if (1)
//    if ( aStep->GetTrack()->GetParentID() == 0 ) 
//    { 
// 
//       /// BIRTH
// 
//    if ( aStep->GetPreStepPoint()->GetGlobalTime() == 0. )
//    if ( aStep->GetPreStepPoint()->GetLocalTime () == 0. )
//       if ( aStep->GetPreStepPoint()->GetProperTime() == 0. )  /// original step (does not work with massless particle for which proper time = 0.0 s)  
//       {
//          // ...
//       }
// 
//       /// LIFE
// 
//       if ( aStep->GetTrack()->GetVolume()->GetName() == "MyDetector" )
//       {
//          // ...
//          fHasEnteredTheDetector = true ; 
//             /*
//             // Below's a few more attributes to get back:   
//                volName     = aStep->GetTrack()->GetVolume()->GetName() ;
//                matName     = aStep->GetTrack()->GetMaterial()->GetName() ;
//                rho    = aStep->GetTrack()->GetMaterial()->GetDensity()/(g/cm3)     ;  /// [g/cm3]
//                T     = aStep->GetTrack()->GetMaterial()->GetTemperature()          ;  /// [K]
//                P     = aStep->GetTrack()->GetMaterial()->GetPressure()/atmosphere ;  /// [atm]
//                v     = aStep->GetTrack()->GetVelocity()*1.e6                      ;  /// [m/s] (mm/ns to m/s)         
//                beta  = v / (c_light*1.e6) ;  
//                if (m != 0.) { gamma = aStep->GetTrack()->GetTotalEnergy() / aStep->GetTrack()->GetDefinition()->GetPDGMass() ; }
//                stepLength  = aTrack->GetStepLength()   ;  /// mm       
//                trackLength = aTrack->GetTrackLength() ;  /// mm      
//             */
//       }
// 
//       /// DEATH
// 
//       if ( aStep->GetTrack()->GetTrackStatus()==fStopAndKill || aStep->GetTrack()->GetTrackStatus()==fKillTrackAndSecondaries )
//       { 
//          // ...
//          // fHasEnteredTheDetector = false ;
//       }
// 
//    }
//    else  /// Kill secondaries
//    {
//       aStep->GetTrack()->SetTrackStatus(fKillTrackAndSecondaries) ;
//    }

   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::Stepping() \n" ; }

   return ; 

}


// *********************************************************************************************************
// *********************************************************************************************************
//  Messenger methods
// *********************************************************************************************************
// *********************************************************************************************************


void TStandard_Analysis::SetRootFileName ( G4String aFileName )
{  

   if (gMyDebug) { G4cout << "\n### In TStandard_Analysis::Stepping() \n" ; }

   fRootFoutName = aFileName ;

   if (gMyDebug) { G4cout << "\n### Out of TStandard_Analysis::SetRootFileName() \n" ; }

   return ; 

}

Copyright: Mathieu Trocmé, Sun 4 Oct 2009 (CeCILL license)