| 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 tools_histo_flair.hh
27 /// \brief Tools to dump any G4H1 into Flair-compatible format.
28 //
29 // Author: G.Hugo, 08 December 2022
30 //
31 // ***************************************************************************
32 //
33 // tools_histo_flair
34 //
35 /// Tools to dump any G4H1 into Flair-compatible format.
36 ///
37 /// These tools are fully application-agnostic,
38 /// and could also be placed outside of the G4 examples,
39 /// as a core G4 Analysis Manager extension.
40 //
41 // ***************************************************************************
42
43 #ifndef TOOLS_HISTO_FLAIR_HH
44 #define TOOLS_HISTO_FLAIR_HH
45
46 #include "g4hntools_defs.hh"
47 #include "globals.hh"
48
49 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
50
51 namespace tools
52 {
53 namespace histo
54 {
55 namespace flair
56 {
57
58 // Supported abscissa types (can be extended)
59 enum Abscissa
60 {
61 KineticEnergy,
62 Z,
63 A
64 };
65
66 G4String getAbscissaName(const Abscissa abscissaKind);
67 G4String getAbscissaUnit(const Abscissa abscissaKind);
68 G4double getAbscissaUnitValue(const Abscissa abscissaKind);
69
70 G4String sformat(const char* fmt, ...);
71
72 G4double computeError(const G4double mean, const G4double sumSquares, const G4int numEvents);
73
74 // Dump G4H1 (histo mode) to a Flair-compatible format.
75 void dumpG4H1HistoInFlairFormat(std::ofstream& output, const G4int indexInOutputFile,
76 const G4String& histoName, G4H1* const histo,
77 const Abscissa abscissaKind, const G4String& binSchemeName,
78 const G4int numEvents, const G4double sumSquaredEventTotals = 0.,
79 const G4double sumSquaredEventInRangeTotals = 0.);
80
81 // Dump G4H1 (profile mode, ie no stats) to a Flair-compatible format.
82 void dumpG4H1ProfileInFlairFormat(std::ofstream& output, const G4int indexInOutputFile,
83 const G4String& histoName, G4H1* const histo,
84 const Abscissa abscissaKind, const G4String& binSchemeName);
85
86 void dumpG4H1InFlairFormat(std::ofstream& output, const G4int indexInOutputFile,
87 const G4String& histoName, G4H1* const histo,
88 const Abscissa abscissaKind, const G4String& binSchemeName,
89 const G4int numEvents, const G4bool isProfile = false,
90 const G4double sumSquaredEventTotals = 0.,
91 const G4double sumSquaredEventInRangeTotals = 0.);
92 } // namespace flair
93 } // namespace histo
94 } // namespace tools
95
96 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
97
98 #endif
99