IHistoTool.h

Go to the documentation of this file.

#ifndef GAUDIALG_IHISTOTOOL_H
#define GAUDIALG_IHISTOTOOL_H 1
// ============================================================================
// Include files
// ============================================================================
// from STL
// ============================================================================
#include <string>
// ============================================================================
// from Gaudi
// ============================================================================
#include "GaudiKernel/IAlgTool.h"
#include "GaudiAlg/HistoID.h"
// ============================================================================

namespace AIDA
{
  class IHistogram1D;
  class IHistogram2D;
  class IHistogram3D;
}

class GAUDI_API IHistoTool: virtual public IAlgTool
{
public:
  DeclareInterfaceID(IHistoTool,2,0);

  typedef Histos::HistoID       HistoID       ;

public:

  // ================================= 1D Histograms ========================================

  virtual 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  = 0 ;

  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 );
  }

  virtual 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 = 0 ;

  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 );
  };

  // ================================= 2D Histograms ========================================

  virtual 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 = 0;

  virtual 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 = 0;

  // ================================= 3D Histograms ========================================

  virtual 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 = 0;

  virtual 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 = 0;

public:

  virtual AIDA::IHistogram1D*  book1D
  ( const std::string&  title        ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ) const = 0 ;

  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 );
  }

  virtual 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 = 0;

  virtual 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 = 0;

  virtual AIDA::IHistogram1D*  book1D
  ( const HistoID&      ID           ,
    const std::string&  title  = ""  ,
    const double        low    =   0 ,
    const double        high   = 100 ,
    const unsigned long bins   = 100 ) const = 0 ;

  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 );
  }

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

  virtual 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 = 0;

  virtual AIDA::IHistogram1D* fill
  ( AIDA::IHistogram1D* histo  ,
    const double        value  ,
    const double        weight ,
    const std::string&  title  = "") const = 0 ;

  virtual AIDA::IHistogram2D* fill
  ( AIDA::IHistogram2D* histo  ,
    const double        valueX ,
    const double        valueY ,
    const double        weight ,
    const std::string&  title  = "" ) const = 0 ;

  virtual AIDA::IHistogram3D* fill
  ( AIDA::IHistogram3D* histo  ,
    const double        valueX ,
    const double        valueY ,
    const double        valueZ ,
    const double        weight ,
    const std::string&  title  = "" ) const = 0 ;

  virtual AIDA::IHistogram1D*  histo1D ( const std::string& title  )  const = 0 ;

  AIDA::IHistogram1D* histo ( const std::string& title  )  const
  {
    return histo1D( title );
  };

  virtual AIDA::IHistogram2D* histo2D ( const std::string& title  )  const = 0;


  virtual AIDA::IHistogram3D* histo3D ( const std::string& title  )  const = 0;

  virtual AIDA::IHistogram1D*  histo1D ( const HistoID&     ID     )  const = 0 ;

  AIDA::IHistogram1D* histo ( const HistoID&     ID     )  const
  {
    return histo1D( ID );
  };

  virtual AIDA::IHistogram2D* histo2D ( const HistoID&     ID     )  const = 0;

  virtual AIDA::IHistogram3D* histo3D ( const HistoID&     ID     )  const = 0;

  virtual bool histoExists ( const std::string& title  )  const = 0 ;

  virtual bool histoExists ( const HistoID&     ID     )  const = 0 ;

public:  // non-virtual methods

  template <class FUNCTION,class OBJECT>
  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
  {
    // retrieve or book the histogram
    AIDA::IHistogram1D* h = histo1D ( title ) ;
    if ( !h  )      { h = book1D  ( title , low , high , bins ); }
    while ( first != last && h  )
    { h = fill ( h , func( *first ) , 1.0 , title  ) ; ++first ; }
    return h ;
  }

  template <class FUNCTION,class OBJECT>
  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
  {
    // retrieve or book the histogram
    AIDA::IHistogram1D* h = histo1D ( ID ) ;
    if ( !h ) { h = book1D  ( ID , title , low , high , bins ); }
    while ( first != last && h )
    { h = fill( h , func( *first ) , 1.0 , title  ) ; ++first ; }
    return h ;
  }

  template <class FUNCTION,class OBJECT,class WEIGHT>
  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
  {
    // retrieve or book the histogram
    AIDA::IHistogram1D* h = histo1D ( title ) ;
    if ( !h     ) { h = book1D  ( title , low , high , bins ); }
    while( first != last && h )
    { h = fill ( h                 ,
                 func   ( *first ) ,
                 weight ( *first ) , title  ) ; ++first ; }
    return h ;
  }

  template <class FUNCTION,class OBJECT,class WEIGHT>
  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
  {
    // retrieve or book the histogram
    AIDA::IHistogram1D* h = histo1D ( ID ) ;
    if ( !h     ) { h = book1D  ( ID , title , low , high , bins ); }
    while( first != last && h )
    { h  = fill ( h                 ,
                  func   ( *first ) ,
                  weight ( *first ) , title  ) ; ++first ; }
    return h ;
  }

protected:

  ~IHistoTool() override = default;

};

#endif // GAUDIALG_IHISTOTOOL_H