Geant4  10.03
Par02Output.hh
Go to the documentation of this file.
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 // $Id: $
27 //
30 
31 #ifndef PAR02_OUTPUT_H
32 #define PAR02_OUTPUT_H
33 
34 #include "G4ThreeVector.hh"
35 #include "globals.hh"
36 
42 
43 class Par02Output {
44  public:
45 
48 
51  static Par02Output* Instance();
52 
55  void SetFileName( G4String name );
56 
60 
64  void AppendName( G4bool app );
65 
70  void StartAnalysis( G4int runID );
71 
74  void EndAnalysis();
75 
78  void CreateNtuples();
79 
82  void CreateHistograms();
83 
95  void SaveTrack( SaveType aWhatToSave, G4int aPartID, G4int aPDG,
96  G4ThreeVector aVector, G4double aResolution = 0,
97  G4double aEfficiency = 1, G4double aEnergy = 0 ) ;
98 
103  void FillHistogram( G4int HNo, G4double value ) const;
104 
105  ~Par02Output();
106 
107  protected:
108 
110  Par02Output();
111 
112  private:
113 
116 
119 
122 
125 
130 };
131 
132 #endif
133 
static G4ThreadLocal G4int fCurrentNtupleId
Current ntuple Id.
Definition: Par02Output.hh:118
void AppendName(G4bool app)
Sets fFileNameWithRunNo that indicates whether to add the run number to the file name.
Definition: Par02Output.cc:75
G4String fFileName
A name of the output root file.
Definition: Par02Output.hh:121
void EndAnalysis()
Calls the G4AnalysisManager::Instance(). It writes to the output file and close it.
Definition: Par02Output.cc:100
CLHEP::Hep3Vector G4ThreeVector
static G4ThreadLocal G4int fCurrentID
A control value of particle ID to ensure that data saved to various ntuples match the same particle...
Definition: Par02Output.hh:129
void CreateNtuples()
Creates Ntuples used to store information about particle (its ID, PDG code, energy deposits...
Definition: Par02Output.cc:108
void CreateHistograms()
Creates histograms to combine information from all the events in the run. To be called for each run i...
Definition: Par02Output.cc:146
const char * name(G4int ptype)
#define G4ThreadLocal
Definition: tls.hh:89
int G4int
Definition: G4Types.hh:78
void FillHistogram(G4int HNo, G4double value) const
Fills the histogram.
Definition: Par02Output.cc:219
Par02Output()
A default, protected constructor (due to singleton pattern).
Definition: Par02Output.cc:48
Handling the saving to the file.
Definition: Par02Output.hh:43
bool G4bool
Definition: G4Types.hh:79
G4String GetFileName()
Gets the file name of the output root file.
Definition: Par02Output.cc:81
SaveType
Indicates to which ntuple to save the information.
Definition: Par02Output.hh:47
static Par02Output * Instance()
Allows the access to the unique Par02Output object.
Definition: Par02Output.cc:60
void SaveTrack(SaveType aWhatToSave, G4int aPartID, G4int aPDG, G4ThreeVector aVector, G4double aResolution=0, G4double aEfficiency=1, G4double aEnergy=0)
Saves the information about the particle (track).
Definition: Par02Output.cc:162
void StartAnalysis(G4int runID)
Calls the G4AnalysisManager::Instance(). It sets the file name of the output file based on fFileName ...
Definition: Par02Output.cc:87
static Par02Output * fPar02Output
The pointer to the only Par02Output class object.
Definition: Par02Output.hh:115
G4bool fFileNameWithRunNo
If true, a run number should be added to the file. Default: false.
Definition: Par02Output.hh:124
void SetFileName(G4String name)
Sets the file name of the output root file.
Definition: Par02Output.cc:69
double G4double
Definition: G4Types.hh:76