| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 /// \file FinalStateHistoManager.hh
27 /// \brief Create a set of histos for final state study.
28 //
29 // Author: G.Hugo, 08 December 2022
30 //
31 // ***************************************************************************
32 //
33 // FinalStateHistoManager
34 //
35 /// Create a set of histos for final state study.
36 /// In practice, the interactions studied here are hadron nuclear inelastic interactions
37 /// (though the code is fully generic).
38 ///
39 /// Energy spectra are plotted for all encountered secondaries
40 /// (one histo per secondary).
41 /// In addition, the residual nuclei Z and A distributions are plotted.
42 ///
43 /// All histograms are G4H1.
44 /// They are created and filled via the G4VAnalysisManager.
45 ///
46 /// The histograms can be dumped to all usual formats, including ROOT
47 /// (via G4VAnalysisManager).
48 /// An interesting added feature here, is that the plots, while being allocated
49 /// and filled via G4VAnalysisManager, are also dumped
50 /// in a Flair-compatible format (via tools::histo::flair).
51 ///
52 /// NB 1: Note that instead of a hardcoded number associated to a hardcoded set of particles,
53 /// particle PDG IDs are used to index the histos.
54 /// This allows a dynamic storage of all particles encountered in the final states.
55 ///
56 /// NB 2: tools::histo::flair code, which allows the dump of any G4H1
57 /// into Flair-compatible format, is fully application-agnostic,
58 /// and is placed in FlukaCern/utils.
59 /// It could also be added as an extension of core G4 Analysis Manager.
60 //
61 // ***************************************************************************
62
63 #ifndef FINAL_STATE_HISTO_MANAGER_HH
64 #define FINAL_STATE_HISTO_MANAGER_HH
65
66 #include "G4H1Wrapper.hh"
67 #include "G4SystemOfUnits.hh"
68 #include "globals.hh"
69
70 #include <memory>
71 #include <unordered_map>
72 #include <vector>
73
74 class G4DynamicParticle;
75 class G4VAnalysisManager;
76
77 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
78
79 class FinalStateHistoManager
80 {
81 public:
82 FinalStateHistoManager();
83
84 void Book();
85 void BeginOfEvent();
86 void ScoreSecondary(const G4DynamicParticle* const secondary);
87 void EndOfEvent();
88 void EndOfRun() const;
89
90 private:
91 void DumpAllG4H1IntoRootFile() const;
92 void
93 DumpAllG4H1IntoFlairFile(const std::map<G4String, const G4H1Wrapper*>& particlesHistos) const;
94
95 G4String fOutputFileName = "all_secondaries";
96 G4String fRootOutputFileName = fOutputFileName + ".root";
97 G4String fFlairOutputFileName = fOutputFileName + ".hist";
98
99 G4int fNumBins = 90;
100 G4double fMinKineticEnergy = 10. * keV;
101 G4double fMaxKineticEnergy = 10. * TeV;
102 G4String fFunctionName = "none";
103 G4String fBinSchemeName = "log";
104 G4String fRootEnergyUnit = "MeV";
105
106 G4int fNucleiZMax = 25;
107 G4int fNucleiAMax = 50;
108
109 G4int fNumEvents = 0;
110
111 G4VAnalysisManager* fAnalysisManager = nullptr;
112
113 // key is particle PDG ID:
114 std::unordered_map<G4int, std::unique_ptr<G4H1Wrapper>> fParticleData;
115 // key is nuclei Z or A score index:
116 std::unordered_map<G4int, std::unique_ptr<G4H1Wrapper>> fNucleiData;
117 G4int fNucleiZScoreIndex = 0;
118 G4int fNucleiAScoreIndex = 1;
119 };
120
121 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
122
123 #endif
124