| 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 electromagnetic/TestEm9/src/Histo.cc
27 /// \brief Implementation of the Histo class
28 //
29 //
30 //---------------------------------------------------------------------------
31 //
32 // ClassName: Histo - Generic histogram/ntuple manager class
33 //
34 //
35 // Author: V.Ivanchenko 30.10.03
36 //
37 //----------------------------------------------------------------------------
38 //
39
40 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
41 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
42
43 #include "Histo.hh"
44
45 #include "HistoMessenger.hh"
46
47 #include "G4RootAnalysisManager.hh"
48
49 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
50 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
51
52 Histo::Histo() : fManager(0), fMessenger(0)
53 {
54 fMessenger = new HistoMessenger(this);
55
56 fHistName = "test";
57 fHistType = "root";
58 fTupleName = "tuple";
59 fTupleTitle = "test";
60 fNHisto = 0;
61 fVerbose = 0;
62 fDefaultAct = true;
63 fHistoActive = false;
64 fNtupleActive = false;
65 }
66
67 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
68
69 Histo::~Histo()
70 {
71 delete fMessenger;
72 }
73
74 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
75
76 void Histo::Book()
77 {
78 if (!(fHistoActive || fNtupleActive)) {
79 return;
80 }
81
82 // Always creating analysis manager
83 fManager = G4RootAnalysisManager::Instance();
84
85 // Creating a tree mapped to a new hbook file.
86 G4String nam = fHistName + "." + fHistType;
87
88 // Open file histogram file
89 if (!fManager->OpenFile(nam)) {
90 G4cout << "Histo::Book: ERROR open file <" << nam << ">" << G4endl;
91 fHistoActive = false;
92 fNtupleActive = false;
93 return;
94 }
95 G4cout << "### Histo::Save: Opended file <" << nam << "> for " << fNHisto << " histograms "
96 << G4endl;
97
98 // Creating an 1-dimensional histograms in the root directory of the tree
99 for (G4int i = 0; i < fNHisto; ++i) {
100 if (fActive[i]) {
101 G4String ss = "h" + fIds[i];
102 fHisto[i] = fManager->CreateH1(ss, fTitles[i], fBins[i], fXmin[i], fXmax[i]);
103 if (fVerbose > 0) {
104 G4cout << "Created histogram #" << i << " id= " << fHisto[i] << " " << ss << " "
105 << fTitles[i] << G4endl;
106 }
107 }
108 }
109 // Creating a tuple factory, whose tuples will be handled by the tree
110 if (fNtupleActive) {
111 fManager->CreateNtuple(fTupleName, fTupleTitle);
112 G4int i;
113 G4int n = fNtupleI.size();
114 for (i = 0; i < n; ++i) {
115 if (fTupleI[i] == -1) {
116 fTupleI[i] = fManager->CreateNtupleIColumn(fNtupleI[i]);
117 }
118 }
119 n = fNtupleF.size();
120 for (i = 0; i < n; ++i) {
121 if (fTupleF[i] == -1) {
122 fTupleF[i] = fManager->CreateNtupleFColumn(fNtupleF[i]);
123 }
124 }
125 n = fNtupleD.size();
126 for (i = 0; i < n; ++i) {
127 if (fTupleD[i] == -1) {
128 fTupleD[i] = fManager->CreateNtupleDColumn(fNtupleD[i]);
129 }
130 }
131 }
132 }
133
134 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
135
136 void Histo::Save()
137 {
138 if (!(fHistoActive || fNtupleActive)) {
139 return;
140 }
141
142 // Creating a tree mapped to a new hbook file.
143 G4String nam = fHistName + "." + fHistType;
144
145 // Write histogram file
146 if (!fManager->Write()) {
147 G4Exception("Histo::Save()", "hist01", FatalException, "Cannot write ROOT file.");
148 }
149 if (fVerbose > 0) {
150 G4cout << "### Histo::Save: Histograms and Ntuples are saved" << G4endl;
151 }
152 if (fManager->CloseFile() && fVerbose > 0) {
153 G4cout << " File is closed" << G4endl;
154 }
155 fManager->Clear();
156 }
157
158 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
159
160 void Histo::Add1D(const G4String& id, const G4String& name, G4int nb, G4double x1, G4double x2,
161 G4double u)
162 {
163 if (fVerbose > 0) {
164 G4cout << "Histo::Add1D: New histogram will be booked: #" << id << " <" << name << " " << nb
165 << " " << x1 << " " << x2 << " " << u << G4endl;
166 }
167 ++fNHisto;
168 x1 /= u;
169 x2 /= u;
170 fActive.push_back(fDefaultAct);
171 fBins.push_back(nb);
172 fXmin.push_back(x1);
173 fXmax.push_back(x2);
174 fUnit.push_back(u);
175 fIds.push_back(id);
176 fTitles.push_back(name);
177 fHisto.push_back(-1);
178 }
179
180 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
181
182 void Histo::SetHisto1D(G4int i, G4int nb, G4double x1, G4double x2, G4double u)
183 {
184 if (i >= 0 && i < fNHisto) {
185 if (fVerbose > 0) {
186 G4cout << "Histo::SetHisto1D: #" << i << " " << nb << " " << x1 << " " << x2 << " " << u
187 << G4endl;
188 }
189 fBins[i] = nb;
190 fXmin[i] = x1;
191 fXmax[i] = x2;
192 fUnit[i] = u;
193 fActive[i] = true;
194 fHistoActive = true;
195 }
196 else {
197 G4cout << "Histo::SetHisto1D: WARNING! wrong histogram index " << i << G4endl;
198 }
199 }
200
201 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
202
203 void Histo::Activate(G4int i, G4bool val)
204 {
205 if (fVerbose > 1) {
206 G4cout << "Histo::Activate: Histogram: #" << i << " " << val << G4endl;
207 }
208 if (i >= 0 && i < fNHisto) {
209 fActive[i] = val;
210 if (val) {
211 fHistoActive = true;
212 }
213 }
214 }
215
216 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
217
218 void Histo::Fill(G4int i, G4double x, G4double w)
219 {
220 if (!fHistoActive) {
221 return;
222 }
223 if (fVerbose > 1) {
224 G4cout << "Histo::Fill: Histogram: #" << i << " at x= " << x << " weight= " << w << G4endl;
225 }
226 if (i >= 0 && i < fNHisto) {
227 if (fActive[i]) {
228 fManager->FillH1(fHisto[i], x / fUnit[i], w);
229 }
230 }
231 else {
232 G4cout << "Histo::Fill: WARNING! wrong histogram index " << i << G4endl;
233 }
234 }
235
236 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
237
238 void Histo::ScaleH1(G4int i, G4double x)
239 {
240 if (!fHistoActive) {
241 return;
242 }
243 if (fVerbose > 0) {
244 G4cout << "Histo::Scale: Histogram: #" << i << " by factor " << x << G4endl;
245 }
246 if (i >= 0 && i < fNHisto) {
247 if (fActive[i]) {
248 fManager->GetH1(fHisto[i])->scale(x);
249 }
250 }
251 else {
252 G4cout << "Histo::Scale: WARNING! wrong histogram index " << i << G4endl;
253 }
254 }
255
256 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
257
258 void Histo::AddTuple(const G4String& w1)
259 {
260 fTupleTitle = w1;
261 }
262
263 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
264
265 void Histo::AddTupleI(const G4String& w1)
266 {
267 fNtupleActive = true;
268 fNtupleI.push_back(w1);
269 fTupleI.push_back(-1);
270 }
271
272 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
273
274 void Histo::AddTupleF(const G4String& w1)
275 {
276 fNtupleActive = true;
277 fNtupleF.push_back(w1);
278 fTupleF.push_back(-1);
279 }
280
281 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
282
283 void Histo::AddTupleD(const G4String& w1)
284 {
285 fNtupleActive = true;
286 fNtupleD.push_back(w1);
287 fTupleD.push_back(-1);
288 }
289
290 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
291
292 void Histo::FillTupleI(G4int i, G4int x)
293 {
294 if (!fNtupleActive) {
295 return;
296 }
297 G4int n = fNtupleI.size();
298 if (i >= 0 && i < n) {
299 if (fVerbose > 1) {
300 G4cout << "Histo::FillTupleI: i= " << i << " id= " << fTupleI[i] << " <" << fNtupleI[i]
301 << "> = " << x << G4endl;
302 }
303 fManager->FillNtupleIColumn(fTupleI[i], x);
304 }
305 else {
306 G4cout << "Histo::FillTupleI: WARNING! wrong ntuple index " << i << G4endl;
307 }
308 }
309
310 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
311
312 void Histo::FillTupleF(G4int i, G4float x)
313 {
314 if (!fNtupleActive) {
315 return;
316 }
317 G4int n = fNtupleF.size();
318 if (i >= 0 && i < n) {
319 if (fVerbose > 1) {
320 G4cout << "Histo::FillTupleF: i= " << i << " id= " << fTupleF[i] << " <" << fNtupleF[i]
321 << "> = " << x << G4endl;
322 }
323 fManager->FillNtupleFColumn(fTupleF[i], x);
324 }
325 else {
326 G4cout << "Histo::FillTupleF: WARNING! wrong ntuple index " << i << G4endl;
327 }
328 }
329
330 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
331
332 void Histo::FillTupleD(G4int i, G4double x)
333 {
334 if (!fNtupleActive) {
335 return;
336 }
337 G4int n = fNtupleD.size();
338 if (i >= 0 && i < n) {
339 if (fVerbose > 1) {
340 G4cout << "Histo::FillTupleD: i= " << i << " id= " << fTupleD[i] << " <" << fNtupleD[i]
341 << "> = " << x << G4endl;
342 }
343 fManager->FillNtupleDColumn(fTupleD[i], x);
344 }
345 else {
346 G4cout << "Histo::FillTupleD: WARNING! wrong ntuple index " << i << G4endl;
347 }
348 }
349
350 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
351
352 void Histo::AddRow()
353 {
354 if (!fNtupleActive) {
355 return;
356 }
357 fManager->AddNtupleRow();
358 }
359
360 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
361
362 void Histo::SetFileName(const G4String& nam)
363 {
364 fHistName = nam;
365 fHistoActive = true;
366 }
367
368 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
369
370 void Histo::SetFileType(const G4String& nam)
371 {
372 // format other than ROOT is not tested
373 if (nam == "root" || nam == "ROOT") {
374 fHistType = "root";
375 }
376 else if (nam == "xml" || nam == "XML") {
377 fHistType = "xml";
378 }
379 else if (nam == "ascii" || nam == "ASCII" || nam == "Csv" || nam == "csv" || nam == "CSV") {
380 fHistType = "ascii";
381 }
382 }
383
384 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
385