HistoTool.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 GAUDIALG_HISTOTOOL_H
#define GAUDIALG_HISTOTOOL_H 1
// ============================================================================
// Include files
// ============================================================================
// Gaudi
// ============================================================================
#include "GaudiAlg/GaudiHistoTool.h"
#include "GaudiAlg/IHistoTool.h"
// ============================================================================
 
class HistoTool : virtual public GaudiHistoTool, virtual public IHistoTool {
public:
  typedef IHistoTool::HistoID HistoID;
 
  HistoTool( const std::string& type, const std::string& name, const IInterface* parent );
 
public:
  // ================================= 1D Histograms ========================================
 
  // fill the histogram (book on demand)
  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 override
 
  {
    return GaudiHistoTool::plot1D( value, title, low, high, bins, weight );
  };
 
  // fill the histogram with forced ID assignement (book on demand)
  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 override {
    return GaudiHistoTool::plot1D( value, ID, title, low, high, bins, weight );
  };
 
  // ================================= 2D Histograms ========================================
 
  // fill the histogram (book on demand)
  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 override {
    return GaudiHistoTool::plot2D( valueX, valueY, title, lowX, highX, lowY, highY, binsX, binsY, weight );
  };
 
  // fill the histogram (book on demand)
  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 override {
    return GaudiHistoTool::plot2D( valueX, valueY, ID, title, lowX, highX, lowY, highY, binsX, binsY, weight );
  };
 
  // ================================= 3D Histograms ========================================
 
  // fill the histogram (book on demand)
  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 override {
    return GaudiHistoTool::plot3D( valueX, valueY, valueZ, title, lowX, highX, lowY, highY, lowZ, highZ, binsX, binsY,
                                   binsZ, weight );
  };
 
  // fill the histogram (book on demand)
  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 override {
    return GaudiHistoTool::plot3D( valueX, valueY, valueZ, ID, title, lowX, highX, lowY, highY, lowZ, highZ, binsX,
                                   binsY, binsZ, weight );
  };
 
public:
  // book the 1D histogram
  AIDA::IHistogram1D* book1D( const std::string& title, const double low = 0, const double high = 100,
                              const unsigned long bins = 100 ) const override {
    return GaudiHistoTool::book1D( title, low, high, bins );
  };
 
  // book the 2D histogram
  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 override {
    return GaudiHistoTool::book2D( title, lowX, highX, binsX, lowY, highY, binsY );
  }
 
  // book the 3D histogram
  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 override {
    return GaudiHistoTool::book3D( title, lowX, highX, binsX, lowY, highY, binsY, lowZ, highZ, binsZ );
  }
 
  // book the 1D histogram with forced ID
  AIDA::IHistogram1D* book1D( const HistoID& ID, const std::string& title = "", const double low = 0,
                              const double high = 100, const unsigned long bins = 100 ) const override {
    return GaudiHistoTool::book1D( ID, title, low, high, bins );
  };
 
  // book the 2D histogram with forced ID
  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 override {
    return GaudiHistoTool::book2D( ID, title, lowX, highX, binsX, lowY, highY, binsY );
  }
 
  // book the 3D histogram with forced ID
  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 override {
    return GaudiHistoTool::book3D( ID, title, lowX, highX, binsX, lowY, highY, binsY, lowZ, highZ, binsZ );
  }
 
  // fill the histo with the value and weight
  AIDA::IHistogram1D* fill( AIDA::IHistogram1D* histo, const double value, const double weight,
                            const std::string& title = "" ) const override {
    return GaudiHistoTool::fill( histo, value, weight, title );
  };
 
  // fill the 2D histo with the value and weight
  AIDA::IHistogram2D* fill( AIDA::IHistogram2D* histo, const double valueX, const double valueY, const double weight,
                            const std::string& title = "" ) const override {
    return GaudiHistoTool::fill( histo, valueX, valueY, weight, title );
  };
 
  // fill the 3D histo with the value and weight
  AIDA::IHistogram3D* fill( AIDA::IHistogram3D* histo, const double valueX, const double valueY, const double valueZ,
                            const double weight, const std::string& title = "" ) const override {
    return GaudiHistoTool::fill( histo, valueX, valueY, valueZ, weight, title );
  };
 
  // access the EXISTING 1D histogram by title
  AIDA::IHistogram1D* histo1D( const std::string& title ) const override { return GaudiHistoTool::histo1D( title ); }
 
  // access the EXISTING 1D histogram by ID
  AIDA::IHistogram1D* histo1D( const HistoID& ID ) const override { return GaudiHistoTool::histo1D( ID ); }
 
  // access the EXISTING 2D histogram by title
  AIDA::IHistogram2D* histo2D( const std::string& title ) const override { return GaudiHistoTool::histo2D( title ); }
 
  // access the EXISTING 2D histogram by ID
  AIDA::IHistogram2D* histo2D( const HistoID& ID ) const override { return GaudiHistoTool::histo2D( ID ); }
 
  // access the EXISTING 3D histogram by title
  AIDA::IHistogram3D* histo3D( const std::string& title ) const override { return GaudiHistoTool::histo3D( title ); }
 
  // access the EXISTING 3D histogram by ID
  AIDA::IHistogram3D* histo3D( const HistoID& ID ) const override { return GaudiHistoTool::histo3D( ID ); }
 
  // check the existence AND validity of the histogram with given title
  bool histoExists( const std::string& title ) const override { return GaudiHistoTool::histoExists( title ); }
 
  // check the existence AND validity of the histogram with given title
  bool histoExists( const HistoID& ID ) const override { return GaudiHistoTool::histoExists( ID ); }
 
  HistoTool()                   = delete;
  HistoTool( const HistoTool& ) = delete;
  HistoTool& operator=( const HistoTool& ) = delete;
};
 
#endif // GAUDIALG_HISTOTOOL_H