HistoStats.h
Go to the documentation of this file.
1 #ifndef GAUDIUTILS_HISTOSTATS_H
2 #define GAUDIUTILS_HISTOSTATS_H 1
3 // ============================================================================
4 // Include files
5 // ============================================================================
6 // STD & STL
7 // ============================================================================
8 #include <utility>
9 // ============================================================================
10 // Gaudi
11 // ============================================================================
12 #include "GaudiKernel/Kernel.h"
13 // ============================================================================
14 // forward declarations
15 // ============================================================================
16 namespace AIDA { class IHistogram1D ; }
17 // ============================================================================
18 namespace Gaudi
19 {
20  namespace Utils
21  {
22  // ========================================================================
29  class GAUDI_API HistoStats
30  {
31  public :
32  // ======================================================================
39  static double moment
40  ( const AIDA::IHistogram1D* histo ,
41  const unsigned int order ,
42  const double value = 0 ) ;
43  // ======================================================================
50  static double momentErr
51  ( const AIDA::IHistogram1D* histo ,
52  const unsigned int order ) ;
53  // ======================================================================
60  static double centralMoment
61  ( const AIDA::IHistogram1D* histo ,
62  const unsigned int order ) ;
63  // ======================================================================
72  static double centralMomentErr
73  ( const AIDA::IHistogram1D* histo ,
74  const unsigned int order ) ;
75  // ======================================================================
77  static double skewness
78  ( const AIDA::IHistogram1D* histo ) ;
79  // ======================================================================
81  static double skewnessErr
82  ( const AIDA::IHistogram1D* histo ) ;
83  // ======================================================================
85  static double kurtosis
86  ( const AIDA::IHistogram1D* histo ) ;
87  // ======================================================================
89  static double kurtosisErr
90  ( const AIDA::IHistogram1D* histo ) ;
91  // ======================================================================
93  static double mean
94  ( const AIDA::IHistogram1D* histo ) ;
95  // ======================================================================
97  static double meanErr
98  ( const AIDA::IHistogram1D* histo ) ;
99  // ======================================================================
101  static double rms
102  ( const AIDA::IHistogram1D* histo ) ;
103  // ======================================================================
105  static double rmsErr
106  ( const AIDA::IHistogram1D* histo ) ;
107  // ======================================================================
109  static double nEff
110  ( const AIDA::IHistogram1D* histo ) ;
111  // ======================================================================
113  static double sumBinHeightErr
114  ( const AIDA::IHistogram1D* histo ) ;
115  // ======================================================================
117  static double sumAllBinHeightErr
118  ( const AIDA::IHistogram1D* histo ) ;
119  // ======================================================================
121  static double overflowEntriesFrac
122  ( const AIDA::IHistogram1D* histo ) ;
124  static double underflowEntriesFrac
125  ( const AIDA::IHistogram1D* histo ) ;
127  static double overflowEntriesFracErr
128  ( const AIDA::IHistogram1D* histo ) ;
130  static double underflowEntriesFracErr
131  ( const AIDA::IHistogram1D* histo ) ;
132  // ======================================================================
134  static double overflowIntegralFrac
135  ( const AIDA::IHistogram1D* histo ) ;
137  static double underflowIntegralFrac
138  ( const AIDA::IHistogram1D* histo ) ;
140  static double overflowIntegralFracErr
141  ( const AIDA::IHistogram1D* histo ) ;
143  static double underflowIntegralFracErr
144  ( const AIDA::IHistogram1D* histo ) ;
145  // ======================================================================
153  static long nEntries
154  ( const AIDA::IHistogram1D* histo ,
155  const int imax ) ;
163  static long nEntries
164  ( const AIDA::IHistogram1D* histo ,
165  const int imin , // minimal bin number (included)
166  const int imax ) ;// maximal bin number (not included)
167  // ======================================================================
175  static double nEntriesFrac
176  ( const AIDA::IHistogram1D* histo ,
177  const int imax ) ;
185  static double nEntriesFrac
186  ( const AIDA::IHistogram1D* histo ,
187  const int imin , // minimal bin number (included)
188  const int imax ) ;// maximal bin number (not included)
189  // ======================================================================
197  static double nEntriesFracErr
198  ( const AIDA::IHistogram1D* histo ,
199  const int imax ) ;
207  static double nEntriesFracErr
208  ( const AIDA::IHistogram1D* histo ,
209  const int imin , // minimal bin number (included)
210  const int imax ) ;// maximal bin number (not included)
211  // ======================================================================
212  } ;
213  // ========================================================================
214  } // end of namespace Gaudi::Utils
215  // ==========================================================================
216 } // end of namespace Gaudi
217 // ============================================================================
218 // The END
219 // ============================================================================
220 #endif // GAUDIUTILS_HISTOSTATS_H
221 // ============================================================================
Kernel.h
AIDA
GaudiKernel.
Definition: Fill.h:8
dump_component_properties.value
list value
Definition: dump_component_properties.py:12
Gaudi::Utils::HistoStats
The collection of trivial functions to access the statistical information for the histograms...
Definition: HistoStats.h:29
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:107
Gaudi
Helper functions to set/get the application return code.
Definition: __init__.py:1