/Users/jmonk/Physics/ForIA/ForIA/IHistogrammer.hh

Go to the documentation of this file.

#ifndef FORIA_IHISTOGRAMMER_HH
#define FORIA_IHISTOGRAMMER_HH

#include <string>
#include <vector>
#include <stdexcept>
#include <ostream>
#include <iostream>

namespace ForIA{
 
  using std::string;
  using std::vector;
  using std::runtime_error;
  
  class IHistogrammer {
    
  public:
    
    virtual ~IHistogrammer(){};
    
    virtual const string &outputName()const =0;
    
    void bookHistogram1D(const string &name, const string &title, 
                         int nBins, double xMin, double xMax);
    
    void bookHistogram1D(const string &name, const string &title, 
                         int nBins, double xMin, double xMax, bool divideBinWidths);

    void bookHistogram1D(const string &path, const string &name, const string &title, 
                                 int nBins, double xMin, double xMax);
    
    virtual void bookHistogram1D(const string &path, const string &name, const string &title, 
                                 int nBins, double xMin, double xMax, bool divideBinWidths)=0;
    
    void bookHistogram1D(const string &name, const string &title, const vector<double> &bins);   
    
    void bookHistogram1D(const string &name, const string &title, const vector<double> &bins, bool divideBinWidths);
 
    void bookHistogram1D(const string &path, const string &name, const string &title, 
                         const vector<double> &bins);
    
    virtual void bookHistogram1D(const string &path, const string &name, const string &title, 
                                 const vector<double> &bins, bool divideBinWidths)=0;
    

    void bookProfile1D(const string &name, const string &title,
                       int nBins, double xMin, double xMax);

    virtual void bookProfile1D(const string &path, const string &name, const string &title,
                       int nBins, double xMin, double xMax)=0;
    
    void bookHistogram2D(const string &name, const string &title, 
                         int nBinsX, double xMin, double xMax,
                         int nBinsY, double yMin, double yMax);
    
    void bookHistogram2D(const string &name, const string &title, 
                         int nBinsX, double xMin, double xMax,
                         int nBinsY, double yMin, double yMax,
                         bool divideBinWidths);

    void bookHistogram2D(const string &path, const string &name, const string &title, 
                                 int nBinsX, double xMin, double xMax,
                                 int nBinsY, double yMin, double yMax);
    
    virtual void bookHistogram2D(const string &path, const string &name, const string &title, 
                                 int nBinsX, double xMin, double xMax,
                                 int nBinsY, double yMin, double yMax,
                                 bool divideBinWidths)=0;
    
    void bookHistogram2D(const string &name, const string &title, 
                         const vector<double>& xbins, const vector<double> &ybins);

    void bookHistogram2D(const string &name, const string &title, 
                         const vector<double>& xbins, const vector<double> &ybins,
                         bool divideBinWidths);

    void bookHistogram2D(const string &path, const string &name, const string &title,
                         const vector<double> &xbins, const vector<double> &ybins);
    
    virtual void bookHistogram2D(const string &path, const string &name, const string &title,
                                 const vector<double> &xbins, const vector<double> &ybins,
                                 bool divideBinWidths)=0;
    
    void bookHistogram3D(const string &name, const string &title,
                         int nBinsX, double xMin, double xMax,
                         int nBinsY, double yMin, double yMax,
                         int nBinsZ, double zMin, double zMax);
    
    void bookHistogram3D(const string &name, const string &title,
                         int nBinsX, double xMin, double xMax,
                         int nBinsY, double yMin, double yMax,
                         int nBinsZ, double zMin, double zMax,
                         bool divideBinWidths);
    
    void bookHistogram3D(const string &path, const string &name, const string &title,
                         int nBinsX, double xMin, double xMax,
                         int nBinsY, double yMin, double yMax,
                         int nBinsZ, double zMin, double zMax);
    
    virtual void bookHistogram3D(const string &path, const string &name, const string &title,
                                 int nBinsX, double xMin, double xMax,
                                 int nBinsY, double yMin, double yMax,
                                 int nBinsZ, double zMin, double zMax,
                                 bool divideBinWidths) = 0;
    
    
    //virtual bool bookProfile1D(const string &name, const string &title, int nBns, double xMin, double xMax)=0;
    
    //virtual bool bookProfile1D(const string &path, const string &name, const string &title, int nBns, double xMin, double xMax)=0;    
    
    virtual void fillHistogram1D(const string &path, const string &name, double value, double weight)=0;
    
    void fillHistogram1D(const string &name, double value, double weight);
    
    virtual void fillProfile1D(const string &path, const string &name, double xVal, double yVal, double weight)=0;
    
    void fillProfile1D(const string &name, double xVal, double yVal, double weight);
    
    virtual void fillHistogram2D(const string &path, const string &name, double xVal, double yVal, double weight)=0;
    
    void fillHistogram2D(const string &name, double xVal, double yVal, double weight);
    
    virtual void fillHistogram3D(const string &path, const string &name, double xVal, double yVal, double zVal, double weight) = 0;
    
    void fillHistogram3D(const string &name, double xVal, double yVal, double zVal, double weight);
    
    virtual void finalise()=0;
    
    virtual void normaliseHistogram1D(const string &path, const string &name, double norm=1.) = 0;
    
    void normaliseHistogram1D(const string &name, double norm=1.);
    
    virtual void scaleHistogram1D(const string &path, const string &name, double scale=1.)=0;
    
    void scaleHistogram1D(const string &name, double scale=1.);
    
    virtual void normaliseHistogram2D(const string &path, const string &name, double norm=1.) = 0;
    
    void normaliseHistogram2D(const string &name, double norm = 1.);
    
    virtual void scaleHistogram2D(const string &path, const string &name, double scale=1.)=0;
    
    void scaleHistogram2D(const string &name, double scale=1.);
    
    virtual void showHistograms(std::ostream &out)const = 0;
    
  private:
    
  };
  
  class NoSuchHistogramException: public runtime_error{
  public:
    NoSuchHistogramException(const string &path, const string & name): 
    runtime_error(name + ": No such histogram exists at " + path){};
    
    NoSuchHistogramException(const string &path, const string & name, const IHistogrammer *histogrammer): 
    runtime_error(name + ": No such histogram exists at " + path){
      
      std::cout<<"Existing histograms are:"<<std::endl;
      histogrammer->showHistograms(std::cout);
      
    };
    
  };
  
  class DuplicateHistogramException: public runtime_error{
  public:
    DuplicateHistogramException(const string &path, const string &name):
    runtime_error(name + ": Histogram already exists at " + path){}
  };
  
}

#endif