HistoTableFormat.h

Go to the documentation of this file.

// $Id: HistoTableFormat.h,v 1.3 2007/11/16 15:29:02 hmd Exp $
// ============================================================================
#ifndef GAUDIUTILS_HISTOTABLEFORMAT_H
#define GAUDIUTILS_HISTOTABLEFORMAT_H 1
// ============================================================================
// Include files
// ============================================================================
#include "GaudiKernel/Kernel.h"
// ============================================================================
// forward declarations
// ============================================================================
namespace AIDA
{
  class IHistogram1D   ;
  class IBaseHistogram ;
}
// ============================================================================
namespace Gaudi
{
  namespace Utils
  {
    // ========================================================================
    namespace Histos
    {
      // ======================================================================
      namespace Formats
      {
        // ====================================================================
        enum Format
          {
            Default = 0 , // default format
            Old         , // "OLD"-line format: title,integral,#ent,mean,rms
            Full        , // FULL format: the first 15 positions
            FullStat    , // Full statistical info (3-15)
            Stat        , // title,#ent,mean,rms,skewness&kurtosis
            StatOnly    , // #entries,mean,rms,skewness&kurtosis
            Stat1       , // #entries,mean+-,rms+-,skewness+-&kurtosis+-
            ShapeOnly   , // mean,rms,skewness,kurtosis,underflow&overflow fractions
            Shape       , // as ShapeOnly but with errors 
            LineTitle   , // line-format : title,mean,rms,skewness&kurtosis
            LineOnly    , // line-format : mean,rms,skewness&kurtosis
            PathTitle     // "PathTitle" : path & title
          } ;
        // ====================================================================
        GAUDI_API std::string format ( const int ID = Default ) ;
        // ====================================================================
        GAUDI_API std::string header ( const int ID = Default ) ;
        // ====================================================================
      } // end of namespace Gaudi::Utils::Histos::Formats
      // ======================================================================
      GAUDI_API std::string path ( const AIDA::IBaseHistogram* aida ) ;
      // ======================================================================
      GAUDI_API std::string format
      ( const AIDA::IHistogram1D* histo  ,
        const std::string&        fmt    ) ;
      // ======================================================================
      GAUDI_API std::string format
      ( const AIDA::IHistogram1D* histo  ,
        const std::string&        ID     ,
        const std::string&        fmt1   ,
        const std::string&        fmt2   ) ;
      // ========================================================================
      template <class HISTO, class STREAM, class TERMINATOR>
      inline STREAM& printList
      ( HISTO              first  ,
        HISTO              last   ,
        const std::string& fmt    ,
        STREAM&            stream ,
        TERMINATOR         term   )
      {
        for ( ; first != last ; ++first )
        { stream << format   ( *first , fmt ) << term ; }  // print table rows
        return stream ;                                    // RETURN
      }
      // ======================================================================
      template <class LIST, class STREAM, class TERMINATOR>
      inline STREAM& printList
      ( const LIST&        histos ,
        const std::string& fmt    ,
        STREAM&            stream ,
        TERMINATOR         term   )
      {
        return printList
          ( histos.begin () , histos.end  () , fmt , stream , term ) ;
      }
      // ======================================================================
      template <class HISTO, class STREAM, class TERMINATOR>
      inline STREAM& printMap
      ( HISTO              begin  ,
        HISTO              end    ,
        const std::string& fmt1   ,
        const std::string& fmt2   ,
        STREAM&            stream ,
        TERMINATOR         term   )
      {
        for ( ; begin != end ; ++begin )
        {
          stream << format
            ( begin -> second , // the histogram
              begin -> first  , // the key
              fmt1  ,  fmt2   ) << term ;
        }
        return stream ;
      }
      // ======================================================================
      template <class MAP, class STREAM, class TERMINATOR>
      inline STREAM& printMap
      ( const MAP&         histos ,
        const std::string& fmt1   ,
        const std::string& fmt2   ,
        STREAM&            stream ,
        TERMINATOR         term   )
      {
        return printMap
          ( histos.begin () , histos.end() , fmt1 , fmt2 , stream , term ) ;
      }
      // ======================================================================
      GAUDI_API std::string format
      ( const std::string& val1 ,
        const std::string& val2 ,
        const std::string& fmt  ) ;
      // ======================================================================
      // ========================================================================
      class GAUDI_API Table
      {
      public:
        Table  ( const int ID  = 0 ) ;
        Table
        ( const std::string& format      ,
          const std::string& header = "" ,
          const std::string& footer = "" ) ;
      public:
        // ======================================================================
        template <class HISTO, class STREAM, class TERMINATOR>
        STREAM& printList
        ( HISTO              first  ,
          HISTO              last   ,
          STREAM&            stream ,
          TERMINATOR         term   ) const
        {
          if ( !header().empty() ) { stream << header () << term ; }
          Gaudi::Utils::Histos::printList ( first , last , format() , stream , term ) ;
          if ( !footer().empty() ) { stream << footer () << term ; }
          return stream ;
        }
        // ======================================================================
      public:
        template <class HISTO, class STREAM, class TERMINATOR>
        STREAM& printMap
        ( HISTO              first  ,
          HISTO              last   ,
          const std::string& fmt    ,
          const std::string& hval   ,
          STREAM&            stream ,
          TERMINATOR         term   ) const
        {
          if ( !hval.empty() || !header().empty() )
          { stream << Gaudi::Utils::Histos::format ( hval , header() , fmt ) << term ; }
          return Gaudi::Utils::Histos::printMap
            ( first , last , fmt , format() , stream , term ) ;
        }
        // ======================================================================
      public:
        // ======================================================================
        const std::string& header () const { return m_header ; }
        // ======================================================================
        const std::string& footer () const { return m_footer ; }
        // ======================================================================
        const std::string& format () const { return m_format ; }
        // ======================================================================
      public:
        // ======================================================================
        void setHeader ( const std::string& v ) { m_header = v ; }
        // ======================================================================
        void setFooter ( const std::string& v ) { m_footer = v ; }
        // ======================================================================
        void setFormat ( const std::string& v ) { m_format = v ; }
        // ======================================================================
      public :
        // ======================================================================
        std::string toString ( const AIDA::IHistogram1D* histo  ) const ;
        // ======================================================================
      public:
        // ======================================================================
        std::string toString
        ( const AIDA::IHistogram1D* histo  ,
          const std::string&        ID     ,
          const std::string&        fmt    ) const ;
        // ======================================================================
      public:
        // the table header
        std::string m_header ; 
        // the table footer
        std::string m_footer ; 
        // the default format
        std::string m_format ; 
        //
      } ;
    } // end of namespace Gaudi::Utils::Histos
  } // end of namespace Gaudi::Utils
} // end of namespace Gaudi
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIUTILS_HISTOTABLEFORMAT_H
// ============================================================================