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