The Gaudi Framework  v29r0 (ff2e7097)
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
17 {
18  class IHistogram1D;
19 }
20 // ============================================================================
21 namespace Gaudi
22 {
23  namespace Utils
24  {
25  // ========================================================================
32  class GAUDI_API HistoStats
33  {
34  public:
35  // ======================================================================
42  static double moment( const AIDA::IHistogram1D* histo, const unsigned int order, const double value = 0 );
43  // ======================================================================
50  static double momentErr( const AIDA::IHistogram1D* histo, const unsigned int order );
51  // ======================================================================
58  static double centralMoment( const AIDA::IHistogram1D* histo, const unsigned int order );
59  // ======================================================================
68  static double centralMomentErr( const AIDA::IHistogram1D* histo, const unsigned int order );
69  // ======================================================================
71  static double skewness( const AIDA::IHistogram1D* histo );
72  // ======================================================================
74  static double skewnessErr( const AIDA::IHistogram1D* histo );
75  // ======================================================================
77  static double kurtosis( const AIDA::IHistogram1D* histo );
78  // ======================================================================
80  static double kurtosisErr( const AIDA::IHistogram1D* histo );
81  // ======================================================================
83  static double mean( const AIDA::IHistogram1D* histo );
84  // ======================================================================
86  static double meanErr( const AIDA::IHistogram1D* histo );
87  // ======================================================================
89  static double rms( const AIDA::IHistogram1D* histo );
90  // ======================================================================
92  static double rmsErr( const AIDA::IHistogram1D* histo );
93  // ======================================================================
95  static double nEff( const AIDA::IHistogram1D* histo );
96  // ======================================================================
98  static double sumBinHeightErr( const AIDA::IHistogram1D* histo );
99  // ======================================================================
101  static double sumAllBinHeightErr( const AIDA::IHistogram1D* histo );
102  // ======================================================================
104  static double overflowEntriesFrac( const AIDA::IHistogram1D* histo );
106  static double underflowEntriesFrac( const AIDA::IHistogram1D* histo );
108  static double overflowEntriesFracErr( const AIDA::IHistogram1D* histo );
110  static double underflowEntriesFracErr( const AIDA::IHistogram1D* histo );
111  // ======================================================================
113  static double overflowIntegralFrac( const AIDA::IHistogram1D* histo );
115  static double underflowIntegralFrac( const AIDA::IHistogram1D* histo );
117  static double overflowIntegralFracErr( const AIDA::IHistogram1D* histo );
119  static double underflowIntegralFracErr( const AIDA::IHistogram1D* histo );
120  // ======================================================================
128  static long nEntries( const AIDA::IHistogram1D* histo, const int imax );
136  static long nEntries( const AIDA::IHistogram1D* histo,
137  const int imin, // minimal bin number (included)
138  const int imax ); // maximal bin number (not included)
139  // ======================================================================
147  static double nEntriesFrac( const AIDA::IHistogram1D* histo, const int imax );
155  static double nEntriesFrac( const AIDA::IHistogram1D* histo, const int imin, const int imax );
156  // ======================================================================
164  static double nEntriesFracErr( const AIDA::IHistogram1D* histo, const int imax );
172  static double nEntriesFracErr( const AIDA::IHistogram1D* histo, const int imin, const int imax );
173  // ======================================================================
174  };
175  // ========================================================================
176  } // end of namespace Gaudi::Utils
177  // ==========================================================================
178 } // end of namespace Gaudi
179 // ============================================================================
180 // The END
181 // ============================================================================
182 #endif // GAUDIUTILS_HISTOSTATS_H
183 // ============================================================================
Kernel.h
AIDA
GaudiKernel.
Definition: Fill.h:10
Gaudi::Utils::HistoStats
The collection of trivial functions to access the statistical information for the histograms...
Definition: HistoStats.h:32
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:110
Gaudi
Helper functions to set/get the application return code.
Definition: __init__.py:1