HistoStats.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2019 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#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;
  class IProfile1D;
} // namespace AIDA
// ============================================================================
namespace Gaudi {
  namespace Utils {
    // ========================================================================
    class GAUDI_API HistoStats {
    public: // 1D Histograms
      // ======================================================================
      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, const int imax );
      // ======================================================================
      static double nEntriesFracErr( const AIDA::IHistogram1D* histo, const int imax );
      static double nEntriesFracErr( const AIDA::IHistogram1D* histo, const int imin, const int imax );
      // ======================================================================
    public: // 1D Profile Histograms
      // ======================================================================
      static double moment( const AIDA::IProfile1D* histo, const unsigned int order, const double value = 0 );
      // ======================================================================
      static double momentErr( const AIDA::IProfile1D* histo, const unsigned int order );
      // ======================================================================
      static double centralMoment( const AIDA::IProfile1D* histo, const unsigned int order );
      // ======================================================================
      static double centralMomentErr( const AIDA::IProfile1D* histo, const unsigned int order );
      // ======================================================================
      static double skewness( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double skewnessErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double kurtosis( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double kurtosisErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double mean( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double meanErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double rms( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double rmsErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double sumBinHeightErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double sumAllBinHeightErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double nEff( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double overflowEntriesFrac( const AIDA::IProfile1D* histo );
      static double underflowEntriesFrac( const AIDA::IProfile1D* histo );
      static double overflowEntriesFracErr( const AIDA::IProfile1D* histo );
      static double underflowEntriesFracErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static double overflowIntegralFrac( const AIDA::IProfile1D* histo );
      static double underflowIntegralFrac( const AIDA::IProfile1D* histo );
      static double overflowIntegralFracErr( const AIDA::IProfile1D* histo );
      static double underflowIntegralFracErr( const AIDA::IProfile1D* histo );
      // ======================================================================
      static long nEntries( const AIDA::IProfile1D* histo, const int imax );
      static long nEntries( const AIDA::IProfile1D* histo,
                            const int               imin, // minimal bin number (included)
                            const int               imax );             // maximal bin number (not included)
      // ======================================================================
      static double nEntriesFrac( const AIDA::IProfile1D* histo, const int imax );
      static double nEntriesFrac( const AIDA::IProfile1D* histo, const int imin, const int imax );
      // ======================================================================
      static double nEntriesFracErr( const AIDA::IProfile1D* histo, const int imax );
      static double nEntriesFracErr( const AIDA::IProfile1D* histo, const int imin, const int imax );
      // ======================================================================
    };
    // ========================================================================
  } // namespace Utils
  // ==========================================================================
} // end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIUTILS_HISTOSTATS_H