Geant4  10.02.p01
G4BaseHistoUtilities.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$
27 
28 // Utility functions using tools::histo::base_histo information.
29 //
30 // Author: Ivana Hrivnacova, 22/06/2015 (ivana@ipno.in2p3.fr)
31 
32 #ifndef G4BaseHistoUtilities_h
33 #define G4BaseHistoUtilities_h 1
34 
35 #include "globals.hh"
36 
37 #include "tools/histo/base_histo"
38 
39 namespace G4Analysis
40 {
41 
42 using G4ToolsBaseHisto
43  = tools::histo::base_histo<double, unsigned int, unsigned int, double, double>;
44 
45 // Access to data parameters
46 //
47 G4int GetNbins(const G4ToolsBaseHisto& baseHisto, G4int dimension);
48 G4double GetMin(const G4ToolsBaseHisto& baseHisto, G4int dimension);
49 G4double GetMax(const G4ToolsBaseHisto& baseHisto, G4int dimension);
50 G4double GetWidth(const G4ToolsBaseHisto& baseHisto, G4int dimension,
51  const G4String& hnType);
52 
53 // Attributes for plotting
54 //
55 
56 // Setters
57 G4bool SetTitle(G4ToolsBaseHisto& baseHisto, const G4String& title);
58 G4bool SetAxisTitle(G4ToolsBaseHisto& baseHisto, G4int dimension, const G4String& title);
59 
60 // Accessors
61 G4String GetTitle(const G4ToolsBaseHisto& baseHisto);
62 G4String GetAxisTitle(const G4ToolsBaseHisto& baseHisto, G4int dimension,
63  const G4String& hnType);
64 
65 }
66 
67 #endif
68 
G4double GetWidth(const G4ToolsBaseHisto &baseHisto, G4int dimension, const G4String &hnType)
G4String GetTitle(const G4ToolsBaseHisto &baseHisto)
G4String GetAxisTitle(const G4ToolsBaseHisto &baseHisto, G4int dimension, const G4String &hnType)
G4double GetMin(const G4ToolsBaseHisto &baseHisto, G4int dimension)
G4bool SetAxisTitle(G4ToolsBaseHisto &baseHisto, G4int dimension, const G4String &title)
tools::histo::base_histo< double, unsigned int, unsigned int, double, double > G4ToolsBaseHisto
int G4int
Definition: G4Types.hh:78
bool G4bool
Definition: G4Types.hh:79
G4bool SetTitle(G4ToolsBaseHisto &baseHisto, const G4String &title)
G4double GetMax(const G4ToolsBaseHisto &baseHisto, G4int dimension)
G4int GetNbins(const G4ToolsBaseHisto &baseHisto, G4int dimension)
double G4double
Definition: G4Types.hh:76