HistoStats.h

Go to the documentation of this file.

#ifndef GAUDIUTILS_HISTOSTATS_H
#define GAUDIUTILS_HISTOSTATS_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL
// ============================================================================
#include <utility>
// ============================================================================
// Gaudi
// ============================================================================
#include "GaudiKernel/Kernel.h"
// ============================================================================
// forward declarations
// ============================================================================
namespace AIDA { class IHistogram1D ; }
// ============================================================================
namespace Gaudi
{
  namespace Utils
  {
    // ========================================================================
    class GAUDI_API HistoStats
    {
    public :
      // ======================================================================
      static double moment
      ( const AIDA::IHistogram1D* histo     ,
        const unsigned int        order     ,
        const double              value = 0 ) ;
      // ======================================================================
      static double momentErr
      ( const AIDA::IHistogram1D* histo ,
        const unsigned int        order ) ;
      // ======================================================================
      static double centralMoment
      ( const AIDA::IHistogram1D* histo ,
        const unsigned int        order ) ;
      // ======================================================================
      static double centralMomentErr
      ( const AIDA::IHistogram1D* histo ,
        const unsigned int        order ) ;
      // ======================================================================
      static double skewness
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double skewnessErr
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double kurtosis
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double kurtosisErr
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double mean
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double meanErr
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double rms
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double rmsErr
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double nEff
      ( const AIDA::IHistogram1D* histo     ) ;
      // ======================================================================
      static double sumBinHeightErr
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double sumAllBinHeightErr
      ( const AIDA::IHistogram1D* histo ) ;
      // ======================================================================
      static double overflowEntriesFrac 
      ( const AIDA::IHistogram1D* histo     ) ;
      static double underflowEntriesFrac
      ( const AIDA::IHistogram1D* histo     ) ;
      static double overflowEntriesFracErr 
      ( const AIDA::IHistogram1D* histo     ) ;
      static double underflowEntriesFracErr  
      ( const AIDA::IHistogram1D* histo     ) ;
      // ======================================================================
      static double overflowIntegralFrac
      ( const AIDA::IHistogram1D* histo     ) ;
      static double underflowIntegralFrac
      ( const AIDA::IHistogram1D* histo     ) ;
      static double overflowIntegralFracErr 
      ( const AIDA::IHistogram1D* histo     ) ;
      static double underflowIntegralFracErr 
      ( const AIDA::IHistogram1D* histo     ) ;
      // ======================================================================
      static long   nEntries 
      ( const AIDA::IHistogram1D* histo , 
        const int                 imax  ) ;
      static long   nEntries 
      ( const AIDA::IHistogram1D* histo , 
        const int                 imin  ,  //     minimal bin number (included) 
        const int                 imax  ) ;// maximal bin number (not included) 
      // ======================================================================
      static double nEntriesFrac 
      ( const AIDA::IHistogram1D* histo , 
        const int                 imax  ) ;
      static double nEntriesFrac 
      ( const AIDA::IHistogram1D* histo , 
        const int                 imin  ,  //     minimal bin number (included) 
        const int                 imax  ) ;// maximal bin number (not included) 
      // ======================================================================
      static double nEntriesFracErr
      ( const AIDA::IHistogram1D* histo , 
        const int                 imax  ) ;
      static double nEntriesFracErr
      ( const AIDA::IHistogram1D* histo , 
        const int                 imin  ,  //     minimal bin number (included) 
        const int                 imax  ) ;// maximal bin number (not included) 
      // ======================================================================
    } ;
    // ========================================================================
  } // end of namespace Gaudi::Utils
  // ==========================================================================
} // end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIUTILS_HISTOSTATS_H
// ============================================================================