GaudiHistos.h

Go to the documentation of this file.

// $Id: GaudiHistos.h,v 1.11 2008/10/27 19:22:20 marcocle Exp $
// ============================================================================
#ifndef GAUDIALG_GAUDIHISTOS_H
#define GAUDIALG_GAUDIHISTOS_H 1
// ============================================================================
/* @file GaudiHistos.h
 *
 *  Header file for class : GaudiHistos
 *
 *  @author Chris Jones   Christopher.Rob.Jones@cern.ch
 *  @author Vanya BELYAEV Ivan.Belyaev@itep.ru
 *  @date   2005-08-08
 */
// ============================================================================
// Include files#
// ============================================================================
// STD& STL
// ============================================================================
#include <limits>
#include <vector>
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/HistoProperty.h"
// ============================================================================
// GaudiAlg
// ============================================================================
#include "GaudiAlg/Maps.h"
#include "GaudiAlg/HbookName.h"
// ============================================================================
// Forward declarations
namespace AIDA
{
  class IHistogram1D;
  class IHistogram2D;
  class IHistogram3D;
  class IProfile1D;
  class IProfile2D;
}
// ============================================================================
template <class PBASE>
class GAUDI_API GaudiHistos: public PBASE
{
public:
  // ==========================================================================
  typedef GaudiAlg::HistoID                HistoID;
  // ==========================================================================
  typedef GaudiAlg::Histo1DMapNumericID    Histo1DMapNumID;
  typedef GaudiAlg::Histo1DMapLiteralID    Histo1DMapLitID;
  typedef GaudiAlg::Histo1DMapTitle        Histo1DMapTitle;
  // ==========================================================================
  typedef GaudiAlg::Histo2DMapNumericID    Histo2DMapNumID;
  typedef GaudiAlg::Histo2DMapLiteralID    Histo2DMapLitID;
  typedef GaudiAlg::Histo2DMapTitle        Histo2DMapTitle;
  // ==========================================================================
  typedef GaudiAlg::Histo3DMapNumericID    Histo3DMapNumID;
  typedef GaudiAlg::Histo3DMapLiteralID    Histo3DMapLitID;
  typedef GaudiAlg::Histo3DMapTitle        Histo3DMapTitle;
  // ==========================================================================
  typedef GaudiAlg::Profile1DMapNumericID  Profile1DMapNumID;
  typedef GaudiAlg::Profile1DMapLiteralID  Profile1DMapLitID;
  typedef GaudiAlg::Profile1DMapTitle      Profile1DMapTitle;
  // ==========================================================================
  typedef GaudiAlg::Profile2DMapNumericID  Profile2DMapNumID;
  typedef GaudiAlg::Profile2DMapLiteralID  Profile2DMapLitID;
  typedef GaudiAlg::Profile2DMapTitle      Profile2DMapTitle;
  // ==========================================================================
  typedef GaudiAlg::HistoBinEdges          HistoBinEdges;
  // ==========================================================================
public:
  // ==========================================================================
  // ================================= 1D Histograms ==========================
  // ================================= Fixed Binning ==========================
  // ==========================================================================
  AIDA::IHistogram1D*  plot1D
  ( const double        value        ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins   = 100 ,
    const double        weight = 1.0 ) const ;
  // ==========================================================================
  inline AIDA::IHistogram1D*  plot
  ( const double        value        ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins   = 100 ,
    const double        weight = 1.0 ) const
  {
    return plot1D ( value, title, low, high, bins, weight );
  }
  // ==========================================================================
  AIDA::IHistogram1D*  plot1D
  ( const double             value        ,
    const Gaudi::Histo1DDef& hdef         ,
    const double             weight = 1.0 ) const ;
  // ==========================================================================
  inline AIDA::IHistogram1D*  plot
  ( const double             value        ,
    const Gaudi::Histo1DDef& hdef         ,
    const double             weight = 1.0 ) const
  {
    return plot1D ( value, hdef, weight );
  }
  // ==========================================================================
  // ==========================================================================
  AIDA::IHistogram1D*  plot1D
  ( const double        value        ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins   = 100 ,
    const double        weight = 1.0 ) const ;
  // ==========================================================================
  inline AIDA::IHistogram1D*  plot
  ( const double        value        ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins   = 100 ,
    const double        weight = 1.0 ) const
  {
    return plot1D ( value, ID, title, low, high, bins, weight );
  }
  // ==========================================================================
  AIDA::IHistogram1D*  plot1D
  ( const double             value        ,
    const HistoID&           ID           ,
    const Gaudi::Histo1DDef& hdef         ,
    const double             weight = 1.0 ) const ;
  // ==========================================================================
  inline AIDA::IHistogram1D*  plot
  ( const double             value        ,
    const HistoID&           ID           ,
    const Gaudi::Histo1DDef& hdef         ,
    const double             weight = 1.0 ) const
  {
    return plot1D ( value, ID, hdef, weight );
  }
  template <class FUNCTION,class OBJECT>
  inline AIDA::IHistogram1D*   plot
  ( const FUNCTION&     func         ,
    OBJECT              first        ,
    OBJECT              last         ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins  = 100  ) const
  {
    AIDA::IHistogram1D* h(0);
    if ( produceHistos() )
    {
      // retrieve or book the histogram
      h = histo1D ( title ) ;
      if ( 0 == h )     { h = book1D  ( title , low , high , bins ); }
      // fill histogram
      while( first != last && 0 != h  )
      { h = fill ( h , func( *first ) , 1.0 , title  ) ; ++first ; }
    }
    return h ;
  }
  // ==========================================================================
  template <class FUNCTION,class OBJECT>
  inline AIDA::IHistogram1D*   plot
  ( const FUNCTION&     func         ,
    OBJECT              first        ,
    OBJECT              last         ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins  = 100  ) const
  {
    AIDA::IHistogram1D* h(0);
    if ( produceHistos() )
    {
      // retrieve or book the histogram
      h = histo1D ( ID ) ;
      if ( 0 == h )     { h = book1D  ( ID , title , low , high , bins ); }
      // fill histogram
      while( first != last && 0 != h )
      { h = fill( h , func( *first ) , 1.0 , title  ) ; ++first ; }
    }
    return h;
  }
  // ==========================================================================
  template <class FUNCTION,class OBJECT,class WEIGHT>
  inline AIDA::IHistogram1D*   plot
  ( const FUNCTION&     func         ,
    OBJECT              first        ,
    OBJECT              last         ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins         ,
    const WEIGHT&       weight       ) const
  {
    AIDA::IHistogram1D* h(0);
    if ( produceHistos() )
    {
      // retrieve or book the histogram
      h = histo1D ( title ) ;
      if ( 0 == h ) { h = book1D  ( title , low , high , bins ); }
      // fill histogram
      while ( first != last && 0 != h )
      { h = fill ( h                 ,
                   func   ( *first ) ,
                   weight ( *first ) , title  ) ; ++first ; }
    }
    return h;
  }
  // ==========================================================================
  template <class FUNCTION,class OBJECT,class WEIGHT>
  inline AIDA::IHistogram1D*   plot
  ( const FUNCTION&     func         ,
    OBJECT              first        ,
    OBJECT              last         ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        low          ,
    const double        high         ,
    const unsigned long bins         ,
    const WEIGHT&       weight       ) const
  {
    AIDA::IHistogram1D* h(0);
    if ( produceHistos() )
    {
      // retrieve or book the histogram
      h = histo1D ( ID ) ;
      if ( 0 == h ) { h = book1D  ( ID , title , low , high , bins ); }
      // fill histogram
      while( first != last && 0 != h )
      { h  = fill ( h                 ,
                    func   ( *first ) ,
                    weight ( *first ) , title  ) ; ++first ; }
    }
    return h ;
  }
  // ==========================================================================
  // ================================= 1D Histograms ==========================
  // =============================== Variable Binning =========================
  // ==========================================================================
  AIDA::IHistogram1D*  plot1D
  ( const double         value        ,
    const std::string&   title        ,
    const HistoBinEdges& edges        ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  // ==========================================================================
  AIDA::IHistogram1D*  plot1D
  ( const double         value        ,
    const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edges        ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  // ================================= 2D Histograms ==========================
  // ==========================================================================
  AIDA::IHistogram2D*  plot2D
  ( const double        valueX       ,
    const double        valueY       ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const double        lowY         ,
    const double        highY        ,
    const unsigned long binsX  = 50  ,
    const unsigned long binsY  = 50  ,
    const double        weight = 1.0 ) const;
  // ==========================================================================
  AIDA::IHistogram2D*  plot2D
  ( const double        valueX       ,
    const double        valueY       ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const double        lowY         ,
    const double        highY        ,
    const unsigned long binsX  = 50  ,
    const unsigned long binsY  = 50  ,
    const double        weight = 1.0 ) const;
  // ==========================================================================
  // ================================= 2D Histograms ==========================
  // =============================== Variable Binning =========================
  // ==========================================================================
  AIDA::IHistogram2D*  plot2D
  ( const double         valueX       ,
    const double         valueY       ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       ,
    const HistoBinEdges& edgesY       ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  AIDA::IHistogram2D*  plot2D
  ( const double         valueX       ,
    const double         valueY       ,
    const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       ,
    const HistoBinEdges& edgesY       ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  // ================================= 3D Histograms ==========================
  // ==========================================================================
  AIDA::IHistogram3D*  plot3D
  ( const double        valueX       ,
    const double        valueY       ,
    const double        valueZ       ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const double        lowY         ,
    const double        highY        ,
    const double        lowZ         ,
    const double        highZ        ,
    const unsigned long binsX  = 10  ,
    const unsigned long binsY  = 10  ,
    const unsigned long binsZ  = 10  ,
    const double        weight = 1.0 ) const;
  // ==========================================================================
  AIDA::IHistogram3D*  plot3D
  ( const double        valueX       ,
    const double        valueY       ,
    const double        valueZ       ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const double        lowY         ,
    const double        highY        ,
    const double        lowZ         ,
    const double        highZ        ,
    const unsigned long binsX  = 10  ,
    const unsigned long binsY  = 10  ,
    const unsigned long binsZ  = 10  ,
    const double        weight = 1.0 ) const;
  // ==========================================================================
  // ================================= 3D Histograms ==========================
  // =============================== Variable Binning =========================
  // ==========================================================================
  AIDA::IHistogram3D*  plot3D
  ( const double         valueX       ,
    const double         valueY       ,
    const double         valueZ       ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       ,
    const HistoBinEdges& edgesY       ,
    const HistoBinEdges& edgesZ       ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  // ==========================================================================
  AIDA::IHistogram3D*  plot3D
  ( const double         valueX       ,
    const double         valueY       ,
    const double         valueZ       ,
    const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       ,
    const HistoBinEdges& edgesY       ,
    const HistoBinEdges& edgesZ       ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  // ================================= 1D Profile =============================
  // ================================= Fixed binning ==========================
  // ==========================================================================
  AIDA::IProfile1D* profile1D
  ( const double        valueX       ,
    const double        valueY       ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const unsigned long binsX  = 100 ,
    const std::string&  opt    = ""  ,
    const double        lowY   = -std::numeric_limits<double>::max() ,
    const double        highY  =  std::numeric_limits<double>::max() ,
    const double        weight = 1.0 ) const ;
  // ==========================================================================
  AIDA::IProfile1D* profile1D
  ( const double        valueX       ,
    const double        valueY       ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const unsigned long binsX  = 100 ,
    const std::string&  opt    = ""  ,
    const double        lowY   = -std::numeric_limits<double>::max() ,
    const double        highY  =  std::numeric_limits<double>::max() ,
    const double        weight = 1.0 ) const;
  // ==========================================================================
  // ================================= 1D Profile =============================
  // ============================== Variable binning ==========================
  // ==========================================================================
  AIDA::IProfile1D* profile1D
  ( const double         valueX       ,
    const double         valueY       ,
    const std::string&   title        ,
    const HistoBinEdges& edges        ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  AIDA::IProfile1D* profile1D
  ( const double         valueX       ,
    const double         valueY       ,
    const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edges        ,
    const double         weight = 1.0 ) const;
  // ==========================================================================
  // ================================= 2D Profile =============================
  // ==========================================================================
  AIDA::IProfile2D* profile2D
  ( const double        valueX       ,
    const double        valueY       ,
    const double        valueZ       ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const double        lowY         ,
    const double        highY        ,
    const unsigned long binsX  = 50  ,
    const unsigned long binsY  = 50  ,
    const double        weight = 1.0 ) const;
  // ==========================================================================
  AIDA::IProfile2D* profile2D
  ( const double        valueX       ,
    const double        valueY       ,
    const double        valueZ       ,
    const HistoID&      ID           ,
    const std::string&  title        ,
    const double        lowX         ,
    const double        highX        ,
    const double        lowY         ,
    const double        highY        ,
    const unsigned long binsX  = 50  ,
    const unsigned long binsY  = 50  ,
    const double        weight = 1.0 ) const;
  // ==========================================================================
  // ================================= 2D Profile =============================
  // ============================== Variable binning ==========================
  // ==========================================================================
  AIDA::IProfile2D* profile2D
  ( const double         valueX       ,
    const double         valueY       ,
    const double         valueZ       ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       ,
    const HistoBinEdges& edgesY       ,
    const double         weight = 1.0 ) const ;
  // ==========================================================================
  AIDA::IProfile2D* profile2D
  ( const double         valueX       ,
    const double         valueY       ,
    const double         valueZ       ,
    const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       ,
    const HistoBinEdges& edgesY       ,
    const double         weight = 1.0 ) const;
  // ==========================================================================

public: // 1D Fixed

  // ==========================================================================
  AIDA::IHistogram1D*  book1D
  ( const std::string&  title        ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ) const ;
  // ==========================================================================
  inline AIDA::IHistogram1D*  book
  ( const std::string&  title        ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ) const
  {
    return book1D( title, low, high, bins );
  }
  // ==========================================================================
  AIDA::IHistogram1D*  book
  ( const Gaudi::Histo1DDef& hdef ) const ;
  // ==========================================================================
  AIDA::IHistogram1D*  book1D
  ( const HistoID&      ID           ,
    const std::string&  title        ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ) const ;
  // ==========================================================================
  inline AIDA::IHistogram1D*  book
  ( const HistoID&      ID           ,
    const std::string&  title        ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ) const
  {
    return book1D( ID, title, low, high, bins );
  }
  // ==========================================================================
  inline AIDA::IHistogram1D*  book
  ( const HistoID&           ID   ,
    const Gaudi::Histo1DDef& hdef ) const ;
  // ==========================================================================

public: // 1D Variable

  // ==========================================================================
  AIDA::IHistogram1D*  book1D
  ( const std::string&   title       ,
    const HistoBinEdges& edges       ) const ;
  // ==========================================================================
  AIDA::IHistogram1D*  book1D
  ( const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edges        ) const ;
  // ==========================================================================

public: // 2D Fixed

  // ==========================================================================
  AIDA::IHistogram2D*  book2D
  ( const std::string&  title         ,
    const double        lowX    =   0 ,
    const double        highX   = 100 ,
    const unsigned long binsX   =  50 ,
    const double        lowY    =   0 ,
    const double        highY   = 100 ,
    const unsigned long binsY   =  50 ) const ;
  // ==========================================================================
  AIDA::IHistogram2D*  book2D
  ( const HistoID&      ID            ,
    const std::string&  title         ,
    const double        lowX    =   0 ,
    const double        highX   = 100 ,
    const unsigned long binsX   =  50 ,
    const double        lowY    =   0 ,
    const double        highY   = 100 ,
    const unsigned long binsY   =  50 ) const ;
  // ==========================================================================

public: // 2D Variable

  // ==========================================================================
  AIDA::IHistogram2D * book2D
  ( const std::string&   title    ,
    const HistoBinEdges& edgesX   , 
    const HistoBinEdges& edgesY   ) const ;
  // ==========================================================================
  AIDA::IHistogram2D * book2D
  ( const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       , 
    const HistoBinEdges& edgesY       ) const ;
  // ==========================================================================

public: // 3D Fixed

  // ==========================================================================
  AIDA::IHistogram3D*  book3D
  ( const std::string&  title         ,
    const double        lowX    =   0 ,
    const double        highX   = 100 ,
    const unsigned long binsX   =  10 ,
    const double        lowY    =   0 ,
    const double        highY   = 100 ,
    const unsigned long binsY   =  10 ,
    const double        lowZ    =   0 ,
    const double        highZ   = 100 ,
    const unsigned long binsZ   =  10 ) const ;
  // ==========================================================================
  AIDA::IHistogram3D*  book3D
  ( const HistoID&      ID            ,
    const std::string&  title         ,
    const double        lowX    =   0 ,
    const double        highX   = 100 ,
    const unsigned long binsX   =  10 ,
    const double        lowY    =   0 ,
    const double        highY   = 100 ,
    const unsigned long binsY   =  10 ,
    const double        lowZ    =   0 ,
    const double        highZ   = 100 ,
    const unsigned long binsZ   =  10 ) const ;
  // ==========================================================================

public: // 3D Variable

  // ==========================================================================
  AIDA::IHistogram3D * book3D
  ( const std::string&   title    ,
    const HistoBinEdges& edgesX   ,  
    const HistoBinEdges& edgesY   , 
    const HistoBinEdges& edgesZ   ) const ;
  // ==========================================================================
  AIDA::IHistogram3D * book3D
  ( const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edgesX       , 
    const HistoBinEdges& edgesY       ,
    const HistoBinEdges& edgesZ       ) const ;
  // ==========================================================================

public: // 1D Fixed Profiles

  // ==========================================================================
  AIDA::IProfile1D*  bookProfile1D
  ( const std::string&  title        ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ,
    const std::string&  opt    = ""  ,
    const double        lowY   = -std::numeric_limits<double>::max() ,
    const double        highY  =  std::numeric_limits<double>::max() ) const;
  // ==========================================================================
  AIDA::IProfile1D*  bookProfile1D
  ( const HistoID&      ID           ,
    const std::string&  title        ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ,
    const std::string&  opt    = ""  ,
    const double        lowY   = -std::numeric_limits<double>::max() ,
    const double        highY  =  std::numeric_limits<double>::max() ) const;
 // ==========================================================================

public: // 1D Variable Profiles

  // ==========================================================================
  AIDA::IProfile1D*  bookProfile1D
  ( const std::string&  title        ,
    const HistoBinEdges&        edges        ) const;
  // ==========================================================================
  AIDA::IProfile1D*  bookProfile1D
  ( const HistoID&       ID           ,
    const std::string&   title        ,
    const HistoBinEdges& edges        ) const;
 // ==========================================================================

public: // 2D Profiles

  // ==========================================================================
  AIDA::IProfile2D*  bookProfile2D
  ( const std::string&  title         ,
    const double        lowX    =   0 ,
    const double        highX   = 100 ,
    const unsigned long binsX   =  50 ,
    const double        lowY    =   0 ,
    const double        highY   = 100 ,
    const unsigned long binsY   =  50 ) const ;
  // ==========================================================================
  AIDA::IProfile2D*  bookProfile2D
  ( const HistoID&      ID            ,
    const std::string&  title         ,
    const double        lowX    =   0 ,
    const double        highX   = 100 ,
    const unsigned long binsX   =  50 ,
    const double        lowY    =   0 ,
    const double        highY   = 100 ,
    const unsigned long binsY   =  50 ) const ;
  // ==========================================================================

public: // 2D Profiles

  // ==========================================================================
  AIDA::IProfile2D*  bookProfile2D
  ( const std::string&   title         ,
    const HistoBinEdges& edgesX,
    const HistoBinEdges& edgesY ) const ;
  // ==========================================================================
  AIDA::IProfile2D*  bookProfile2D
  ( const HistoID&       ID            ,
    const std::string&   title         ,
    const HistoBinEdges& edgesX,
    const HistoBinEdges& edgesY  ) const ;
  // ==========================================================================

public:

  // ==========================================================================
  AIDA::IHistogram1D* fill
  ( AIDA::IHistogram1D* histo  ,
    const double        value  ,
    const double        weight ,
    const std::string&  title  = "" ) const ;
  // ==========================================================================
  AIDA::IHistogram2D* fill
  ( AIDA::IHistogram2D* histo  ,
    const double        valueX ,
    const double        valueY ,
    const double        weight ,
    const std::string&  title  = "" ) const ;
  // ==========================================================================
  AIDA::IHistogram3D* fill
  ( AIDA::IHistogram3D* histo  ,
    const double        valueX ,
    const double        valueY ,
    const double        valueZ ,
    const double        weight ,
    const std::string&  title  = "" ) const ;
  // ==========================================================================
  AIDA::IProfile1D* fill
  ( AIDA::IProfile1D*   histo  ,
    const double        valueX ,
    const double        valueY ,
    const double        weight ,
    const std::string&  title  = "" ) const ;
  // ==========================================================================
  AIDA::IProfile2D* fill
  ( AIDA::IProfile2D*   histo  ,
    const double        valueX ,
    const double        valueY ,
    const double        valueZ ,
    const double        weight ,
    const std::string&  title  = "" ) const ;
  // ==========================================================================
public:
  // ==========================================================================
  inline AIDA::IHistogram1D* histo1D ( const std::string& title  )  const
  {
    Histo1DMapTitle::const_iterator found = histo1DMapTitle().find( title ) ;
    return ( histo1DMapTitle().end() == found ? 0 : found->second );
  }
  // ==========================================================================
  inline AIDA::IHistogram1D* histo ( const std::string& title  )  const
  {
    return histo1D( title );
  }
  // ==========================================================================
  inline AIDA::IHistogram2D* histo2D ( const std::string& title  )  const
  {
    Histo2DMapTitle::const_iterator found = histo2DMapTitle().find( title ) ;
    return ( histo2DMapTitle().end() == found ? 0 : found->second );
  }
  // ==========================================================================
  inline AIDA::IHistogram3D* histo3D ( const std::string& title  )  const
  {
    Histo3DMapTitle::const_iterator found = histo3DMapTitle().find( title ) ;
    return ( histo3DMapTitle().end() == found ? 0 : found->second );
  }
  // ==========================================================================
  inline AIDA::IProfile1D* profile1D ( const std::string& title  )  const
  {
    Profile1DMapTitle::const_iterator found = profile1DMapTitle().find( title ) ;
    return ( profile1DMapTitle().end() == found ? 0 : found->second );
  }
  // ==========================================================================
  inline AIDA::IProfile2D* profile2D ( const std::string& title  )  const
  {
    Profile2DMapTitle::const_iterator found = profile2DMapTitle().find( title ) ;
    return ( profile2DMapTitle().end() == found ? 0 : found->second );
  }
  // ==========================================================================
public:
  // ==========================================================================
  AIDA::IHistogram1D* histo1D ( const HistoID&     ID     )  const;
  // ==========================================================================
  inline AIDA::IHistogram1D* histo ( const HistoID&     ID     )  const
  {
    return histo1D( ID );
  }
  // ==========================================================================
  AIDA::IHistogram2D* histo2D ( const HistoID&     ID     )  const;
  // ==========================================================================
  AIDA::IHistogram3D* histo3D ( const HistoID&     ID     )  const;
  // ==========================================================================
  AIDA::IProfile1D* profile1D ( const HistoID&     ID  )  const;
  // ==========================================================================
  AIDA::IProfile2D* profile2D ( const HistoID&     ID  )  const;
  // ==========================================================================
public:
  // ==========================================================================
  inline bool histoExists ( const std::string& title  )  const
  {
    return
      ( 0 != histo     ( title ) ||
        0 != histo2D   ( title ) ||
        0 != histo3D   ( title ) ||
        0 != profile1D ( title ) ||
        0 != profile2D ( title ) );
  }
  // ==========================================================================
  inline bool histoExists ( const HistoID&     ID     )  const
  {
    return
      ( 0 != histo     ( ID ) ||
        0 != histo2D   ( ID ) ||
        0 != histo3D   ( ID ) ||
        0 != profile1D ( ID ) ||
        0 != profile2D ( ID ) );
  }
  unsigned int totalNumberOfHistos() const;
  // ==========================================================================
public: // trivial & non-trivial accessors
  // ==========================================================================
  inline bool               produceHistos () const { return m_produceHistos ; }
  inline bool               fullDetail    () const { return m_fullDetail    ; }
  inline bool               checkForNaN   () const { return m_checkForNaN   ; }
  inline bool               splitHistoDir () const { return m_splitHistoDir ; }
  inline HistoID::NumericID histoOffSet   () const { return m_histoOffSet ; }
  inline const std::string& histoTopDir   () const { return m_histoTopDir   ; }
  inline const std::string& histoDir      () const { return m_histoDir      ; }
  inline std::string histoPath () const
  {
    const std::string path = histoTopDir() + histoDir();
    return ( splitHistoDir() ? dirHbookName(path) : path );
  }
  inline bool histosPrint () const  { return m_histosPrint ; }
  inline bool useNumericAutoIDs() const { return m_useNumericAutoIDs; }
  // ==========================================================================
  int printHistos ( const MSG::Level level = MSG::ALWAYS ) const ;
  // ==========================================================================
  const Histo1DMapTitle & histo1DMapTitle() const { return m_histo1DMapTitle; }
  // ==========================================================================
  const Histo1DMapNumID & histo1DMapNumID () const { return m_histo1DMapNumID; }
  // ==========================================================================
  const Histo1DMapLitID & histo1DMapLitID () const { return m_histo1DMapLitID; }
  // ==========================================================================
  const Histo2DMapTitle & histo2DMapTitle() const { return m_histo2DMapTitle ; }
  // ==========================================================================
  const Histo2DMapNumID & histo2DMapNumID () const { return m_histo2DMapNumID; }
  // ==========================================================================
  const Histo2DMapLitID & histo2DMapLitID () const { return m_histo2DMapLitID; }
  // ==========================================================================
  const Histo3DMapTitle & histo3DMapTitle () const { return m_histo3DMapTitle ; }
  // ==========================================================================
  const Histo3DMapNumID & histo3DMapNumID () const { return m_histo3DMapNumID; }
  // ==========================================================================
  const Histo3DMapLitID & histo3DMapLitID () const { return m_histo3DMapLitID; }
  // ==========================================================================
  const Profile1DMapTitle & profile1DMapTitle() const { return m_profile1DMapTitle; }
  // ==========================================================================
  const Profile1DMapNumID & profile1DMapNumID () const { return m_profile1DMapNumID; }
  // ==========================================================================
  const Profile1DMapLitID & profile1DMapLitID () const { return m_profile1DMapLitID; }
  // ==========================================================================
  const Profile2DMapTitle & profile2DMapTitle() const { return m_profile2DMapTitle; }
  // ==========================================================================
  const Profile2DMapNumID & profile2DMapNumID () const { return m_profile2DMapNumID; }
  // ==========================================================================
  const Profile2DMapLitID & profile2DMapLitID () const { return m_profile2DMapLitID; }
  // ==========================================================================
public: // trivial setters
  // ==========================================================================
  inline void setProduceHistos ( const bool         val ) { m_produceHistos = val ; }
  inline void setFullDetail    ( const bool         val ) { m_fullDetail    = val ; }
  inline void setCheckForNaN   ( const bool         val ) { m_checkForNaN   = val ; }
  inline void setSplitHistoDir ( const bool         val ) { m_splitHistoDir = val ; }
  inline void setHistoOffSet   ( const HistoID::NumericID val )
  { m_histoOffSet   = val ; }
  // ==========================================================================
  inline void setHistoTopDir   ( const std::string& val ) { m_histoTopDir   = val ; }
  // ==========================================================================
  inline void setHistoDir      ( const std::string& val ) { m_histoDir      = val ; }
  // ==========================================================================
public:
  // ==========================================================================
  GaudiHistos ( const std::string & name,
                ISvcLocator * pSvcLocator );
  // ==========================================================================
  GaudiHistos ( const std::string& type   ,
                const std::string& name   ,
                const IInterface*  parent );
  // ==========================================================================
  virtual ~GaudiHistos();
  // ==========================================================================
protected:
  // ==========================================================================
  virtual StatusCode initialize ();
  // ==========================================================================
  virtual StatusCode finalize   ();
  // ==========================================================================
private:
  // ==========================================================================
  bool noHistos() const;
  // ===========================================unsigned===============================
  void initGaudiHistosConstructor();
  // ==========================================================================
  void monitorHisto( const AIDA::IBaseHistogram* hist,
                     const HistoID& ID ) const;
  // ==========================================================================
  void newHistoID( const std::string & title,
                   HistoID& ID ) const;
  // ==========================================================================
  void stringSearchReplace( std::string & title,
                            const std::string & A,
                            const std::string & B ) const;
  // ==========================================================================
protected:
  // ==========================================================================
  std::string convertTitleToID( const std::string & title ) const;
  // ==========================================================================
private:
  // ==========================================================================
  void printHistoHandler ( Property& /* theProp */ ) ;          // "HistoPrint"
  // ==========================================================================
private:
  // ==========================================================================
  bool        m_produceHistos ;
  bool        m_fullDetail;
  bool        m_checkForNaN   ;
  bool        m_splitHistoDir ;
  HistoID::NumericID     m_histoOffSet ;
  std::string m_histoTopDir   ;
  std::string m_histoDir      ;
  bool        m_histosPrint   ;
  bool        m_declareMoniHists;
  // ==========================================================================
  mutable Histo1DMapTitle     m_histo1DMapTitle ;
  mutable Histo1DMapNumID     m_histo1DMapNumID ;
  mutable Histo1DMapLitID     m_histo1DMapLitID ;
  // ==========================================================================
  mutable Histo2DMapTitle     m_histo2DMapTitle ;
  mutable Histo2DMapNumID     m_histo2DMapNumID ;
  mutable Histo2DMapLitID     m_histo2DMapLitID ;
  // ==========================================================================
  mutable Histo3DMapTitle     m_histo3DMapTitle ;
  mutable Histo3DMapNumID     m_histo3DMapNumID ;
  mutable Histo3DMapLitID     m_histo3DMapLitID ;
  // ==========================================================================
  mutable Profile1DMapTitle   m_profile1DMapTitle ;
  mutable Profile1DMapNumID   m_profile1DMapNumID ;
  mutable Profile1DMapLitID   m_profile1DMapLitID ;
  // ==========================================================================
  mutable Profile2DMapTitle   m_profile2DMapTitle ;
  mutable Profile2DMapNumID   m_profile2DMapNumID ;
  mutable Profile2DMapLitID   m_profile2DMapLitID ;
  // ==========================================================================
  std::string  m_histo1DTableFormat      ;
  std::string  m_histo1DTableFormatShort ;
  std::string  m_histo1DTableHeader      ;
  bool        m_useNumericAutoIDs;
  std::map<std::string,std::string> m_idReplaceInfo;
  // ==========================================================================
};
// ============================================================================
// The END
// ============================================================================
#endif // GAUDIALG_GAUDIHISTOS_H
// ============================================================================