Hadr02/src/Histo.cc

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 /// \file hadronic/Hadr02/src/Histo.cc
0027 /// \brief Implementation of the Histo class
0028 //
0029 //
0030 //---------------------------------------------------------------------------
0031 //
0032 // ClassName:   Histo - Generic histogram/ntuple manager class
0033 //
0034 //
0035 // Author:      V.Ivanchenko 30.10.03
0036 //
0037 //----------------------------------------------------------------------------
0038 //
0039
0040 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0041 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0042
0043 #include "Histo.hh"
0044
0045 #include "HistoMessenger.hh"
0046
0047 #include "G4RootAnalysisManager.hh"
0048 #include "G4SystemOfUnits.hh"
0049 #include "G4XmlAnalysisManager.hh"
0050 #include "G4ios.hh"
0051
0052 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0053 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0054
0055 Histo::Histo()
0056 {
0057   fManager = 0;
0058   fMessenger = new HistoMessenger(this);
0059
0060   fHistName = "test";
0061   fHistType = "root";
0062   fTupleName = "tuple";
0063   fTupleTitle = "test";
0064   fNHisto = 0;
0065   fVerbose = 0;
0066   fDefaultAct = true;
0067   fHistoActive = false;
0068   fNtupleActive = false;
0069 }
0070
0071 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0072
0073 Histo::~Histo()
0074 {
0075   delete fMessenger;
0076 }
0077
0078 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0079
0080 void Histo::Book()
0081 {
0082   if (!(fHistoActive || fNtupleActive)) {
0083     return;
0084   }
0085
0086   // Always creating analysis manager
0087   if (fHistType == "root") {
0088     fManager = G4RootAnalysisManager::Instance();
0089   }
0090   else {
0091     fManager = G4XmlAnalysisManager::Instance();
0092   }
0093
0094   // Creating a tree mapped to a new hbook file.
0095   G4String nam = fHistName;  // + "." + fHistType;
0096
0097   // Open file histogram file
0098   if (!fManager->OpenFile(nam)) {
0099     G4cout << "Histo::Book: ERROR open file <" << nam << ">" << G4endl;
0100     fHistoActive = false;
0101     fNtupleActive = false;
0102     return;
0103   }
0104   G4cout << "### Histo::Save: Opended file <" << nam << ">  for " << fNHisto << " histograms "
0105          << G4endl;
0106
0107   // Creating an 1-dimensional histograms in the root directory of the tree
0108   for (G4int i = 0; i < fNHisto; ++i) {
0109     if (fActive[i]) {
0110       G4String ss = "h" + fIds[i];
0111       fHisto[i] = fManager->CreateH1(ss, fTitles[i], fBins[i], fXmin[i], fXmax[i]);
0112       if (fVerbose > 0) {
0113         G4cout << "Created histogram #" << i << "  id= " << fHisto[i] << "  " << ss << "  "
0114                << fTitles[i] << G4endl;
0115       }
0116     }
0117   }
0118   // Creating a tuple factory, whose tuples will be handled by the tree
0119   if (fNtupleActive) {
0120     fManager->CreateNtuple(fTupleName, fTupleTitle);
0121     G4int i;
0122     G4int n = fNtupleI.size();
0123     for (i = 0; i < n; ++i) {
0124       if (fTupleI[i] == -1) {
0125         fTupleI[i] = fManager->CreateNtupleIColumn(fNtupleI[i]);
0126       }
0127     }
0128     n = fNtupleF.size();
0129     for (i = 0; i < n; ++i) {
0130       if (fTupleF[i] == -1) {
0131         fTupleF[i] = fManager->CreateNtupleFColumn(fNtupleF[i]);
0132       }
0133     }
0134     n = fNtupleD.size();
0135     for (i = 0; i < n; ++i) {
0136       if (fTupleD[i] == -1) {
0137         fTupleD[i] = fManager->CreateNtupleDColumn(fNtupleD[i]);
0138       }
0139     }
0140   }
0141 }
0142
0143 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0144
0145 void Histo::Save()
0146 {
0147   if (!(fHistoActive || fNtupleActive)) {
0148     return;
0149   }
0150
0151   // Creating a tree mapped to a new hbook file.
0152   G4String nam = fHistName + "." + fHistType;
0153
0154   // Write histogram file
0155   if (!fManager->Write()) {
0156     G4ExceptionDescription message;
0157     message << "Histo::Save: FATAL ERROR writing ROOT file.";
0158     G4Exception("Histo::Save()", "Hadr02Code001", FatalException, message);
0159   }
0160   if (fVerbose > 0) {
0161     G4cout << "### Histo::Save: Histograms and Ntuples are saved" << G4endl;
0162   }
0163   if (fManager->CloseFile() && fVerbose > 0) {
0164     G4cout << "                 File is closed" << G4endl;
0165   }
0166   fManager->Clear();
0167 }
0168
0169 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0170
0171 void Histo::Add1D(const G4String& id, const G4String& name, G4int nb, G4double x1, G4double x2,
0172                   G4double u)
0173 {
0174   if (fVerbose > 0) {
0175     G4cout << "Histo::Add1D: New histogram will be booked: #" << id << "  <" << name << "  " << nb
0176            << "  " << x1 << "  " << x2 << "  " << u << G4endl;
0177   }
0178   ++fNHisto;
0179   x1 /= u;
0180   x2 /= u;
0181   fActive.push_back(fDefaultAct);
0182   fBins.push_back(nb);
0183   fXmin.push_back(x1);
0184   fXmax.push_back(x2);
0185   fUnit.push_back(u);
0186   fIds.push_back(id);
0187   fTitles.push_back(name);
0188   fHisto.push_back(-1);
0189 }
0190
0191 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0192
0193 void Histo::SetHisto1D(G4int i, G4int nb, G4double x1, G4double x2, G4double u)
0194 {
0195   if (i >= 0 && i < fNHisto) {
0196     if (fVerbose > 0) {
0197       G4cout << "Histo::SetHisto1D: #" << i << "  " << nb << "  " << x1 << "  " << x2 << "  " << u
0198              << G4endl;
0199     }
0200     fBins[i] = nb;
0201     fXmin[i] = x1;
0202     fXmax[i] = x2;
0203     fUnit[i] = u;
0204     fActive[i] = true;
0205     fHistoActive = true;
0206   }
0207   else {
0208     G4cout << "Histo::SetHisto1D: WARNING! wrong histogram index " << i << G4endl;
0209   }
0210 }
0211
0212 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0213
0214 void Histo::Activate(G4int i, G4bool val)
0215 {
0216   if (fVerbose > 1) {
0217     G4cout << "Histo::Activate: Histogram: #" << i << "   " << val << G4endl;
0218   }
0219   if (i >= 0 && i < fNHisto) {
0220     fActive[i] = val;
0221     if (val) {
0222       fHistoActive = true;
0223     }
0224   }
0225 }
0226
0227 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0228
0229 void Histo::Fill(G4int i, G4double x, G4double w)
0230 {
0231   if (!fHistoActive) {
0232     return;
0233   }
0234   if (fVerbose > 1) {
0235     G4cout << "Histo::Fill: Histogram: #" << i << " at x= " << x << "  weight= " << w << G4endl;
0236   }
0237   if (i >= 0 && i < fNHisto) {
0238     if (fActive[i]) {
0239       fManager->FillH1(fHisto[i], x / fUnit[i], w);
0240     }
0241   }
0242   else {
0243     G4cout << "Histo::Fill: WARNING! wrong histogram index " << i << G4endl;
0244   }
0245 }
0246
0247 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0248
0249 void Histo::ScaleH1(G4int i, G4double x)
0250 {
0251   if (!fHistoActive) {
0252     return;
0253   }
0254   if (fVerbose > 0) {
0255     G4cout << "Histo::Scale: Histogram: #" << i << " by factor " << x << G4endl;
0256   }
0257   if (i >= 0 && i < fNHisto) {
0258     if (fActive[i]) {
0259       if (fHistType == "root")
0260         dynamic_cast<G4RootAnalysisManager*>(fManager)->GetH1(fHisto[i])->scale(x);
0261       if (fHistType == "xml")
0262         dynamic_cast<G4XmlAnalysisManager*>(fManager)->GetH1(fHisto[i])->scale(x);
0263     }
0264   }
0265   else {
0266     G4cout << "Histo::Scale: WARNING! wrong histogram index " << i << G4endl;
0267   }
0268 }
0269
0270 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0271
0272 void Histo::AddTuple(const G4String& w1)
0273 {
0274   fTupleTitle = w1;
0275 }
0276
0277 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0278
0279 void Histo::AddTupleI(const G4String& w1)
0280 {
0281   fNtupleActive = true;
0282   fNtupleI.push_back(w1);
0283   fTupleI.push_back(-1);
0284 }
0285
0286 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0287
0288 void Histo::AddTupleF(const G4String& w1)
0289 {
0290   fNtupleActive = true;
0291   fNtupleF.push_back(w1);
0292   fTupleF.push_back(-1);
0293 }
0294
0295 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0296
0297 void Histo::AddTupleD(const G4String& w1)
0298 {
0299   fNtupleActive = true;
0300   fNtupleD.push_back(w1);
0301   fTupleD.push_back(-1);
0302 }
0303
0304 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0305
0306 void Histo::FillTupleI(G4int i, G4int x)
0307 {
0308   if (!fNtupleActive) {
0309     return;
0310   }
0311   G4int n = fNtupleI.size();
0312   if (i >= 0 && i < n) {
0313     if (fVerbose > 1) {
0314       G4cout << "Histo::FillTupleI: i= " << i << "  id= " << fTupleI[i] << "   <" << fNtupleI[i]
0315              << "> = " << x << G4endl;
0316     }
0317     fManager->FillNtupleIColumn(fTupleI[i], x);
0318   }
0319   else {
0320     G4cout << "Histo::FillTupleI: WARNING! wrong ntuple index " << i << G4endl;
0321   }
0322 }
0323
0324 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0325
0326 void Histo::FillTupleF(G4int i, G4float x)
0327 {
0328   if (!fNtupleActive) {
0329     return;
0330   }
0331   G4int n = fNtupleF.size();
0332   if (i >= 0 && i < n) {
0333     if (fVerbose > 1) {
0334       G4cout << "Histo::FillTupleF: i= " << i << "  id= " << fTupleF[i] << "   <" << fNtupleF[i]
0335              << "> = " << x << G4endl;
0336     }
0337     fManager->FillNtupleFColumn(fTupleF[i], x);
0338   }
0339   else {
0340     G4cout << "Histo::FillTupleF: WARNING! wrong ntuple index " << i << G4endl;
0341   }
0342 }
0343
0344 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0345
0346 void Histo::FillTupleD(G4int i, G4double x)
0347 {
0348   if (!fNtupleActive) {
0349     return;
0350   }
0351   G4int n = fNtupleD.size();
0352   if (i >= 0 && i < n) {
0353     if (fVerbose > 1) {
0354       G4cout << "Histo::FillTupleD: i= " << i << "  id= " << fTupleD[i] << "   <" << fNtupleD[i]
0355              << "> = " << x << G4endl;
0356     }
0357     fManager->FillNtupleDColumn(fTupleD[i], x);
0358   }
0359   else {
0360     G4cout << "Histo::FillTupleD: WARNING! wrong ntuple index " << i << G4endl;
0361   }
0362 }
0363
0364 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0365
0366 void Histo::AddRow()
0367 {
0368   if (!fNtupleActive) {
0369     return;
0370   }
0371   fManager->AddNtupleRow();
0372 }
0373
0374 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0375
0376 void Histo::SetFileName(const G4String& nam)
0377 {
0378   fHistName = nam;
0379   fHistoActive = true;
0380 }
0381
0382 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0383
0384 void Histo::SetFileType(const G4String& nam)
0385 {
0386   if (nam == "root" || nam == "ROOT") {
0387     fHistType = "root";
0388   }
0389   else if (nam == "xml" || nam == "XML") {
0390     fHistType = "xml";
0391   }
0392   else {
0393     G4cout << "Histo::SetFileType: Sorry, format for output file: " << nam
0394            << " not supported. Use \"root\" or \"xml\"" << G4endl;
0395   }
0396 }
0397
0398 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......