Geant4  10.02.p01
G4VH3Manager.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: G4VH3Manager.hh 70604 2013-06-03 11:27:06Z ihrivnac $
27 
28 // Base class for H3 manager.
29 //
30 // Author: Ivana Hrivnacova, 24/07/2014 (ivana@ipno.in2p3.fr)
31 
32 #ifndef G4VH3Manager_h
33 #define G4VH3Manager_h 1
34 
35 #include "globals.hh"
36 
37 #include <vector>
38 #include <memory>
39 
40 class G4HnManager;
41 
43 {
44  // Disable using the object managers outside G4VAnalysisManager
45  friend class G4VAnalysisManager;
46  friend class G4VAnalysisReader;
47 
48  public:
50  virtual ~G4VH3Manager() {}
51 
52  // deleted copy constructor & assignment operator
53  G4VH3Manager(const G4VH3Manager& rhs) = delete;
54  G4VH3Manager& operator=(const G4VH3Manager& rhs) = delete;
55 
56  protected:
57  // Methods for handling histograms
58  virtual G4int CreateH3(const G4String& name, const G4String& title,
59  G4int nxbins, G4double xmin, G4double xmax,
60  G4int nybins, G4double ymin, G4double ymax,
61  G4int nzbins, G4double zmin, G4double zmax,
62  const G4String& xunitName = "none",
63  const G4String& yunitName = "none",
64  const G4String& zunitName = "none",
65  const G4String& xfcnName = "none",
66  const G4String& yfcnName = "none",
67  const G4String& zfcnName = "none",
68  const G4String& xbinScheme = "linear",
69  const G4String& ybinScheme = "linear",
70  const G4String& zbinScheme = "linear") = 0;
71 
72  virtual G4int CreateH3(const G4String& name, const G4String& title,
73  const std::vector<G4double>& xedges,
74  const std::vector<G4double>& yedges,
75  const std::vector<G4double>& zedges,
76  const G4String& xunitName = "none",
77  const G4String& yunitName = "none",
78  const G4String& zunitName = "none",
79  const G4String& xfcnName = "none",
80  const G4String& yfcnName = "none",
81  const G4String& zfcnName = "none") = 0;
82 
83  virtual G4bool SetH3(G4int id,
84  G4int nxbins, G4double xmin, G4double xmax,
85  G4int nzbins, G4double zmin, G4double zmax,
86  G4int nybins, G4double ymin, G4double ymax,
87  const G4String& xunitName = "none",
88  const G4String& yunitName = "none",
89  const G4String& zunitName = "none",
90  const G4String& xfcnName = "none",
91  const G4String& yfcnName = "none",
92  const G4String& zfcnName = "none",
93  const G4String& xbinScheme = "linear",
94  const G4String& ybinScheme = "linear",
95  const G4String& zbinScheme = "linear") = 0;
96 
97  virtual G4bool SetH3(G4int id,
98  const std::vector<G4double>& xedges,
99  const std::vector<G4double>& yedges,
100  const std::vector<G4double>& zedges,
101  const G4String& xunitName = "none",
102  const G4String& yunitName = "none",
103  const G4String& zunitName = "none",
104  const G4String& xfcnName = "none",
105  const G4String& yfcnName = "none",
106  const G4String& zfcnName = "none") = 0;
107 
108  virtual G4bool ScaleH3(G4int id, G4double factor) = 0;
109 
110  // Methods to fill histograms
111  virtual G4bool FillH3(G4int id,
112  G4double xvalue, G4double yvalue, G4double zvalue,
113  G4double weight = 1.0) = 0;
114 
115  // Access methods
116  virtual G4int GetH3Id(const G4String& name, G4bool warn = true) const = 0;
117 
118  // Access to H3 parameters
119  virtual G4int GetH3Nxbins(G4int id) const = 0;
120  virtual G4double GetH3Xmin(G4int id) const = 0;
121  virtual G4double GetH3Xmax(G4int id) const = 0;
122  virtual G4double GetH3XWidth(G4int id) const = 0;
123  virtual G4int GetH3Nybins(G4int id) const = 0;
124  virtual G4double GetH3Ymin(G4int id) const = 0;
125  virtual G4double GetH3Ymax(G4int id) const = 0;
126  virtual G4double GetH3YWidth(G4int id) const = 0;
127  virtual G4int GetH3Nzbins(G4int id) const = 0;
128  virtual G4double GetH3Zmin(G4int id) const = 0;
129  virtual G4double GetH3Zmax(G4int id) const = 0;
130  virtual G4double GetH3ZWidth(G4int id) const = 0;
131 
132  // Setters for attributes for plotting
133  virtual G4bool SetH3Title(G4int id, const G4String& title) = 0;
134  virtual G4bool SetH3XAxisTitle(G4int id, const G4String& title) = 0;
135  virtual G4bool SetH3YAxisTitle(G4int id, const G4String& title) = 0;
136  virtual G4bool SetH3ZAxisTitle(G4int id, const G4String& title) = 0;
137 
138  // Access attributes for plotting
139  virtual G4String GetH3Title(G4int id) const = 0;
140  virtual G4String GetH3XAxisTitle(G4int id) const = 0;
141  virtual G4String GetH3YAxisTitle(G4int id) const = 0;
142  virtual G4String GetH3ZAxisTitle(G4int id) const = 0;
143 
144  // Methods to manipulate histograms
145  virtual G4bool WriteOnAscii(std::ofstream& output) = 0;
146 
147  // Access to Hn manager
148  virtual std::shared_ptr<G4HnManager> GetHnManager() = 0;
149 };
150 
151 #endif
152 
virtual G4double GetH3Ymin(G4int id) const =0
virtual G4double GetH3Xmax(G4int id) const =0
virtual G4bool SetH3(G4int id, G4int nxbins, G4double xmin, G4double xmax, G4int nzbins, G4double zmin, G4double zmax, G4int nybins, G4double ymin, G4double ymax, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &zunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &zfcnName="none", const G4String &xbinScheme="linear", const G4String &ybinScheme="linear", const G4String &zbinScheme="linear")=0
virtual G4bool ScaleH3(G4int id, G4double factor)=0
virtual G4double GetH3ZWidth(G4int id) const =0
G4String name
Definition: TRTMaterials.hh:40
virtual G4bool SetH3ZAxisTitle(G4int id, const G4String &title)=0
virtual G4int GetH3Nybins(G4int id) const =0
virtual G4String GetH3ZAxisTitle(G4int id) const =0
virtual G4int GetH3Nzbins(G4int id) const =0
virtual G4int CreateH3(const G4String &name, const G4String &title, G4int nxbins, G4double xmin, G4double xmax, G4int nybins, G4double ymin, G4double ymax, G4int nzbins, G4double zmin, G4double zmax, const G4String &xunitName="none", const G4String &yunitName="none", const G4String &zunitName="none", const G4String &xfcnName="none", const G4String &yfcnName="none", const G4String &zfcnName="none", const G4String &xbinScheme="linear", const G4String &ybinScheme="linear", const G4String &zbinScheme="linear")=0
virtual std::shared_ptr< G4HnManager > GetHnManager()=0
int G4int
Definition: G4Types.hh:78
virtual G4int GetH3Id(const G4String &name, G4bool warn=true) const =0
virtual G4bool SetH3XAxisTitle(G4int id, const G4String &title)=0
virtual G4bool SetH3Title(G4int id, const G4String &title)=0
bool G4bool
Definition: G4Types.hh:79
virtual ~G4VH3Manager()
Definition: G4VH3Manager.hh:50
virtual G4double GetH3Zmax(G4int id) const =0
virtual G4double GetH3Ymax(G4int id) const =0
virtual G4String GetH3XAxisTitle(G4int id) const =0
virtual G4int GetH3Nxbins(G4int id) const =0
virtual G4double GetH3Zmin(G4int id) const =0
static const G4double factor
virtual G4bool WriteOnAscii(std::ofstream &output)=0
virtual G4double GetH3Xmin(G4int id) const =0
virtual G4double GetH3XWidth(G4int id) const =0
virtual G4bool FillH3(G4int id, G4double xvalue, G4double yvalue, G4double zvalue, G4double weight=1.0)=0
virtual G4double GetH3YWidth(G4int id) const =0
virtual G4String GetH3Title(G4int id) const =0
virtual G4String GetH3YAxisTitle(G4int id) const =0
double G4double
Definition: G4Types.hh:76
virtual G4bool SetH3YAxisTitle(G4int id, const G4String &title)=0
G4VH3Manager & operator=(const G4VH3Manager &rhs)=delete