Geant4  10.01.p03
G4VAnalysisReader.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: G4VAnalysisReader.hh 71635 2013-06-19 13:48:28Z ihrivnac $
27 
28 // The nonvirtual public interface reader class for g4tools based analysis.
29 // It is defined as a composite of object manager base classes.
30 // Individual use of the component managers is disabled
31 // (except for file manager and Hn manager which are also used from
32 // other object managers).
33 // The functions which has to be implemented in concrete managers
34 // are declared as virtual protected.
35 
36 // Author: Ivana Hrivnacova, 09/04/2014 (ivana@ipno.in2p3.fr)
37 
38 #ifndef G4VAnalysisReader_h
39 #define G4VAnalysisReader_h 1
40 
42 #include "globals.hh"
43 
44 #include <vector>
45 #include <fstream>
46 
47 
48 class G4HnManager;
49 class G4BaseFileManager;
50 class G4VH1Manager;
51 class G4VH2Manager;
52 class G4VH3Manager;
53 class G4VP1Manager;
54 class G4VP2Manager;
55 class G4VRNtupleManager;
56 
58 {
59  public:
60  G4VAnalysisReader(const G4String& type, G4bool isMaster);
61  virtual ~G4VAnalysisReader();
62 
63  // Methods for handling files
64  // G4bool OpenFile(const G4String& fileName = "");
65 
66  // Methods for handling files and directories names
67  void SetFileName(const G4String& fileName);
68  G4String GetFileName() const;
69 
70  // Methods to read histograms from a file
71  G4int ReadH1(const G4String& h1Name, const G4String& fileName = "");
72  G4int ReadH2(const G4String& h2Name, const G4String& fileName = "");
73  G4int ReadH3(const G4String& h3Name, const G4String& fileName = "");
74  G4int ReadP1(const G4String& h1Name, const G4String& fileName = "");
75  G4int ReadP2(const G4String& h2Name, const G4String& fileName = "");
76 
77  // The ids of histograms and ntuples are generated automatically
78  // starting from 0; with following functions it is possible to
79  // change the first Id to start from other value
80  G4bool SetFirstHistoId(G4int firstId);
81  G4bool SetFirstH1Id(G4int firstId);
82  G4bool SetFirstH2Id(G4int firstId);
83  G4bool SetFirstH3Id(G4int firstId);
85  G4bool SetFirstP1Id(G4int firstId);
86  G4bool SetFirstP2Id(G4int firstId);
87  G4bool SetFirstNtupleId(G4int firstId);
88 
89  // Methods to read ntuple from a file
90  G4int GetNtuple(const G4String& ntupleName, const G4String& fileName = "");
91 
92  // Methods for ntuple with id = FirstNtupleId
93  G4bool SetNtupleIColumn(const G4String& columnName, G4int& value);
94  G4bool SetNtupleFColumn(const G4String& columnName, G4float& value);
95  G4bool SetNtupleDColumn(const G4String& columnName, G4double& value);
96  G4bool SetNtupleSColumn(const G4String& columnName, G4String& value);
97  // Bind the ntuple colums of vector type
98  G4bool SetNtupleIColumn(const G4String& columnName,
99  std::vector<int>& vector);
100  G4bool SetNtupleFColumn(const G4String& columnName,
101  std::vector<float>& vector);
102  G4bool SetNtupleDColumn(const G4String& columnName,
103  std::vector<double>& vector);
104  // Methods for ntuple with id > FirstNtupleId
105  G4bool SetNtupleIColumn(G4int ntupleId, const G4String& columnName,
106  G4int& value);
107  G4bool SetNtupleFColumn(G4int ntupleId, const G4String& columnName,
108  G4float& value);
109  G4bool SetNtupleDColumn(G4int ntupleId, const G4String& columnName,
110  G4double& value);
111  G4bool SetNtupleSColumn(G4int ntupleId, const G4String& columnName,
112  G4String& value);
113  // Bind the ntuple colums of vector type
114  G4bool SetNtupleIColumn(G4int ntupleId, const G4String& columnName,
115  std::vector<int>& vector);
116  G4bool SetNtupleFColumn(G4int ntupleId, const G4String& columnName,
117  std::vector<float>& vector);
118  G4bool SetNtupleDColumn(G4int ntupleId, const G4String& columnName,
119  std::vector<double>& vector);
120 
122  G4bool GetNtupleRow(G4int ntupleId);
123 
124  // ASCII option
125 
126  // Return false if there is no object selected for ASCII output,
127  // return true otherwise
128  G4bool IsAscii() const;
129 
130  // Access methods
131  G4int GetNofH1s() const;
132  G4int GetNofH2s() const;
133  G4int GetNofH3s() const;
134  G4int GetNofP1s() const;
135  G4int GetNofP2s() const;
136  G4int GetNofNtuples() const;
137 
138  // Access methods via names
139  G4int GetH1Id(const G4String& name, G4bool warn = true) const;
140  G4int GetH2Id(const G4String& name, G4bool warn = true) const;
141  G4int GetH3Id(const G4String& name, G4bool warn = true) const;
142  G4int GetP1Id(const G4String& name, G4bool warn = true) const;
143  G4int GetP2Id(const G4String& name, G4bool warn = true) const;
144 
145  // Access to histogram & profiles parameters
146  //
147  G4int GetH1Nbins(G4int id) const;
148  G4double GetH1Xmin(G4int id) const;
149  G4double GetH1Xmax(G4int id) const;
150  G4double GetH1Width(G4int id) const;
151  //
152  G4int GetH2Nxbins(G4int id) const;
153  G4double GetH2Xmin(G4int id) const;
154  G4double GetH2Xmax(G4int id) const;
155  G4double GetH2XWidth(G4int id) const;
156  G4int GetH2Nybins(G4int id) const;
157  G4double GetH2Ymin(G4int id) const;
158  G4double GetH2Ymax(G4int id) const;
159  G4double GetH2YWidth(G4int id) const;
160  //
161  G4int GetH3Nxbins(G4int id) const;
162  G4double GetH3Xmin(G4int id) const;
163  G4double GetH3Xmax(G4int id) const;
164  G4double GetH3XWidth(G4int id) const;
165  G4int GetH3Nybins(G4int id) const;
166  G4double GetH3Ymin(G4int id) const;
167  G4double GetH3Ymax(G4int id) const;
168  G4double GetH3YWidth(G4int id) const;
169  G4int GetH3Nzbins(G4int id) const;
170  G4double GetH3Zmin(G4int id) const;
171  G4double GetH3Zmax(G4int id) const;
172  G4double GetH3ZWidth(G4int id) const;
173  //
174  G4int GetP1Nbins(G4int id) const;
175  G4double GetP1Xmin(G4int id) const;
176  G4double GetP1Xmax(G4int id) const;
177  G4double GetP1XWidth(G4int id) const;
178  G4double GetP1Ymin(G4int id) const;
179  G4double GetP1Ymax(G4int id) const;
180  //
181  G4int GetP2Nxbins(G4int id) const;
182  G4double GetP2Xmin(G4int id) const;
183  G4double GetP2Xmax(G4int id) const;
184  G4double GetP2XWidth(G4int id) const;
185  G4int GetP2Nybins(G4int id) const;
186  G4double GetP2Ymin(G4int id) const;
187  G4double GetP2Ymax(G4int id) const;
188  G4double GetP2YWidth(G4int id) const;
189  G4double GetP2Zmin(G4int id) const;
190  G4double GetP2Zmax(G4int id) const;
191 
192  // Access histogram & profiles attributes for plotting
193  //
194  G4String GetH1Title(G4int id) const;
195  G4String GetH1XAxisTitle(G4int id) const;
196  G4String GetH1YAxisTitle(G4int id) const;
197  //
198  G4String GetH2Title(G4int id) const;
199  G4String GetH2XAxisTitle(G4int id) const;
200  G4String GetH2YAxisTitle(G4int id) const;
201  G4String GetH2ZAxisTitle(G4int id) const;
202  //
203  G4String GetH3Title(G4int id) const;
204  G4String GetH3XAxisTitle(G4int id) const;
205  G4String GetH3YAxisTitle(G4int id) const;
206  G4String GetH3ZAxisTitle(G4int id) const;
207  //
208  G4String GetP1Title(G4int id) const;
209  G4String GetP1XAxisTitle(G4int id) const;
210  G4String GetP1YAxisTitle(G4int id) const;
211  G4String GetP1ZAxisTitle(G4int id) const;
212  //
213  G4String GetP2Title(G4int id) const;
214  G4String GetP2XAxisTitle(G4int id) const;
215  G4String GetP2YAxisTitle(G4int id) const;
216  G4String GetP2ZAxisTitle(G4int id) const;
217 
218  // Verbosity
219  void SetVerboseLevel(G4int verboseLevel);
220  G4int GetVerboseLevel() const;
221 
222  // The manager type (starts with an uppercase letter)
223  G4String GetType() const;
224  // The manager file type (starts with a lowercase letter)
225  G4String GetFileType() const;
226 
227  protected:
228  // virtual methods
229  virtual G4int ReadH1Impl(const G4String& /*h1Name*/,
230  const G4String& /*fileName*/,
231  G4bool /*isUserFileName*/) { return false; }
232  virtual G4int ReadH2Impl(const G4String& /*h2Name*/,
233  const G4String& /*fileName*/,
234  G4bool /*isUserFileName*/) { return false; }
235  virtual G4int ReadH3Impl(const G4String& /*h2Name*/,
236  const G4String& /*fileName*/,
237  G4bool /*isUserFileName*/) { return false; }
238  virtual G4int ReadP1Impl(const G4String& /*h1Name*/,
239  const G4String& /*fileName*/,
240  G4bool /*isUserFileName*/) { return false; }
241  virtual G4int ReadP2Impl(const G4String& /*h2Name*/,
242  const G4String& /*fileName*/,
243  G4bool /*isUserFileName*/) { return false; }
244  virtual G4int ReadNtupleImpl(const G4String& /*ntupleName*/,
245  const G4String& /*fileName*/,
246  G4bool /*isUserFileName*/) { return false; }
247 
248  // methods
249  void SetH1Manager(G4VH1Manager* h1Manager);
250  void SetH2Manager(G4VH2Manager* h2Manager);
251  void SetH3Manager(G4VH3Manager* h3Manager);
252  void SetP1Manager(G4VP1Manager* p1Manager);
253  void SetP2Manager(G4VP2Manager* p2Manager);
254  void SetNtupleManager(G4VRNtupleManager* ntupleManager);
255  void SetFileManager(G4BaseFileManager* fileManager);
256 
257  // data members
259 
260  private:
261  // data members
269 };
270 
271 // inline functions
272 
273 #include "G4VAnalysisReader.icc"
274 
275 #endif
276 
G4double GetP2Ymin(G4int id) const
G4int GetH3Nybins(G4int id) const
G4VP1Manager * fVP1Manager
void SetP1Manager(G4VP1Manager *p1Manager)
G4double GetP2Xmax(G4int id) const
virtual G4int ReadH3Impl(const G4String &, const G4String &, G4bool)
G4double GetH1Xmin(G4int id) const
G4int GetP1Id(const G4String &name, G4bool warn=true) const
G4double GetH2Ymax(G4int id) const
G4String GetP2ZAxisTitle(G4int id) const
G4int GetNofP2s() const
G4String GetP1YAxisTitle(G4int id) const
void SetP2Manager(G4VP2Manager *p2Manager)
G4String GetH1XAxisTitle(G4int id) const
G4String GetH2XAxisTitle(G4int id) const
G4double GetH3XWidth(G4int id) const
G4int GetH2Id(const G4String &name, G4bool warn=true) const
G4double GetH1Width(G4int id) const
virtual G4int ReadNtupleImpl(const G4String &, const G4String &, G4bool)
G4String GetH3ZAxisTitle(G4int id) const
G4int ReadP1(const G4String &h1Name, const G4String &fileName="")
G4bool SetFirstProfileId(G4int firstId)
virtual ~G4VAnalysisReader()
G4int GetH2Nxbins(G4int id) const
G4String GetP2XAxisTitle(G4int id) const
G4double GetP2Zmin(G4int id) const
G4String name
Definition: TRTMaterials.hh:40
G4double GetH1Xmax(G4int id) const
G4int GetVerboseLevel() const
float G4float
Definition: G4Types.hh:77
G4double GetP1Xmin(G4int id) const
G4String GetP1ZAxisTitle(G4int id) const
G4bool SetNtupleDColumn(const G4String &columnName, G4double &value)
G4VAnalysisReader(const G4String &type, G4bool isMaster)
G4String GetH2ZAxisTitle(G4int id) const
G4int ReadH2(const G4String &h2Name, const G4String &fileName="")
G4String GetH2YAxisTitle(G4int id) const
G4String GetFileName() const
G4String GetH1Title(G4int id) const
G4AnalysisManagerState fState
int G4int
Definition: G4Types.hh:78
G4VP2Manager * fVP2Manager
G4double GetH3Zmax(G4int id) const
virtual G4int ReadH2Impl(const G4String &, const G4String &, G4bool)
G4double GetH2Xmax(G4int id) const
G4double GetH3Ymax(G4int id) const
G4bool SetNtupleSColumn(const G4String &columnName, G4String &value)
G4double GetP2Zmax(G4int id) const
void SetH3Manager(G4VH3Manager *h3Manager)
G4bool SetNtupleIColumn(const G4String &columnName, G4int &value)
G4String GetP1Title(G4int id) const
G4int GetP2Nxbins(G4int id) const
G4bool SetNtupleFColumn(const G4String &columnName, G4float &value)
G4double GetH3YWidth(G4int id) const
G4double GetH2Ymin(G4int id) const
G4double GetH3Zmin(G4int id) const
G4String GetH3Title(G4int id) const
void SetFileName(const G4String &fileName)
G4double GetP2YWidth(G4int id) const
G4String GetP1XAxisTitle(G4int id) const
G4int ReadH3(const G4String &h3Name, const G4String &fileName="")
G4int GetH3Id(const G4String &name, G4bool warn=true) const
G4double GetP1Ymax(G4int id) const
bool G4bool
Definition: G4Types.hh:79
G4int ReadP2(const G4String &h2Name, const G4String &fileName="")
G4double GetH3Xmax(G4int id) const
G4int GetH1Id(const G4String &name, G4bool warn=true) const
void SetNtupleManager(G4VRNtupleManager *ntupleManager)
G4double GetH3Ymin(G4int id) const
G4int GetH3Nzbins(G4int id) const
G4int GetP1Nbins(G4int id) const
G4double GetH2XWidth(G4int id) const
G4int ReadH1(const G4String &h1Name, const G4String &fileName="")
virtual G4int ReadP1Impl(const G4String &, const G4String &, G4bool)
G4int GetH3Nxbins(G4int id) const
G4bool SetFirstHistoId(G4int firstId)
G4bool SetFirstNtupleId(G4int firstId)
G4VH1Manager * fVH1Manager
G4int GetP2Nybins(G4int id) const
G4String GetH1YAxisTitle(G4int id) const
G4int GetNofP1s() const
void SetH1Manager(G4VH1Manager *h1Manager)
G4bool IsAscii() const
G4double GetH3ZWidth(G4int id) const
G4double GetP1XWidth(G4int id) const
G4int GetNofH2s() const
G4int GetNofH1s() const
G4bool SetFirstH1Id(G4int firstId)
G4double GetP2XWidth(G4int id) const
G4double GetP1Xmax(G4int id) const
G4double GetP2Ymax(G4int id) const
G4bool SetFirstH2Id(G4int firstId)
virtual G4int ReadH1Impl(const G4String &, const G4String &, G4bool)
G4String GetP2Title(G4int id) const
G4VH2Manager * fVH2Manager
G4String GetH3XAxisTitle(G4int id) const
G4int GetP2Id(const G4String &name, G4bool warn=true) const
G4int GetH2Nybins(G4int id) const
G4bool SetFirstP2Id(G4int firstId)
G4double GetP2Xmin(G4int id) const
virtual G4int ReadP2Impl(const G4String &, const G4String &, G4bool)
void SetVerboseLevel(G4int verboseLevel)
G4VH3Manager * fVH3Manager
G4String GetH2Title(G4int id) const
G4String GetH3YAxisTitle(G4int id) const
G4String GetFileType() const
G4bool SetFirstH3Id(G4int firstId)
G4int GetNtuple(const G4String &ntupleName, const G4String &fileName="")
G4double GetH2Xmin(G4int id) const
double G4double
Definition: G4Types.hh:76
G4bool SetFirstP1Id(G4int firstId)
G4String GetP2YAxisTitle(G4int id) const
void SetH2Manager(G4VH2Manager *h2Manager)
G4int GetNofH3s() const
G4double GetH3Xmin(G4int id) const
G4VRNtupleManager * fVNtupleManager
G4double GetP1Ymin(G4int id) const
G4int GetH1Nbins(G4int id) const
G4String GetType() const
G4BaseFileManager * fFileManager
G4double GetH2YWidth(G4int id) const
void SetFileManager(G4BaseFileManager *fileManager)
G4int GetNofNtuples() const