PlotBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// -------------------------------------------------------------
// Base class for Plot Collections
//
// author: Felix Socher <felix.socher@cern.ch>
// -------------------------------------------------------------
#ifndef TRKVALHISTUTILS_PLOTBASE_H
#define TRKVALHISTUTILS_PLOTBASE_H
 
#include <string>
#include <string_view>
#include <utility> //for std::pair
#include <vector>
//should be possible to fwd-declare TH1F, TH2F, TH3F, TProfile, TProfile2D TTree .. why isn't this done?
#include "TH1F.h"
#include "TH1D.h"
#include "TH2F.h"
#include "TH3F.h"
#include "TProfile.h"
#include "TProfile2D.h"
#include "TTree.h"
#include "TEfficiency.h"
 
 
//fwd-declares
class TEfficiency;
 
typedef std::pair<TH1*, std::string> HistData;
typedef std::pair<TTree*, std::string> TreeData;
typedef std::pair<TEfficiency*, std::string> EfficiencyData;
 
class PlotBase {
public:
  PlotBase(PlotBase *parent, std::string_view  sDir);
  virtual ~PlotBase(){}
  void initialize();
  void finalize();
  void setDetailLevel(int iDetailLevel);
  void RegisterSubPlot(PlotBase* pPlotBase){m_vSubNodes.push_back(pPlotBase);}

  std::vector<HistData> retrieveBookedHistograms();
  std::vector<TreeData> retrieveBookedTrees();
  std::vector<EfficiencyData> retrieveBookedEfficiencies();

  TH1D* Book1D(std::string_view  name, std::string_view  labels, int nBins, float start, float end, bool prependDir = true);
  TH1D* Book1D(std::string_view  name, TH1* refHist, std::string_view  labels, bool prependDir = true);

  TH2F* Book2D(std::string_view  name, std::string_view  labels, int nBinsX, float startX, float endX, int nBinsY, float startY, float endY, bool prependDir = true);
  TH2F* Book2D(std::string_view  name, TH2* refHist, std::string_view  labels, bool prependDir = true);
  TH2F* Book2D(std::string_view  name, std::string_view  labels, int nBinsX, Double_t* binsX, int nBinsY, Double_t startY, Double_t endY, bool prependDir = true);

  TH3F* Book3D(std::string_view  name, std::string_view  labels, int nBinsX, float startX, float endX, int nBinsY, float startY, float endY, int nBinsZ, float startZ, float endZ, bool prependDir = true);
  TH3F* Book3D(std::string_view  name, TH3* refHist, std::string_view  labels, bool prependDir = true);

  TProfile* BookTProfile(std::string_view name, std::string_view  labels, int nBinsX, float startX, float endX, float startY=-1, float endY=-1, bool prependDir = true, bool useRMS=false);
  TProfile* BookTProfile(std::string_view name, std::string_view  labels, int nBinsX, float* binsX, bool prependDir = true);
  TProfile* BookTProfileRangeY(std::string_view name, std::string_view  labels, int nBinsX, double* binsX, double startY, double endY, bool prependDir = true); //cannot overload, conflicts with previous definitions
  TProfile2D * BookTProfile2D(std::string_view name, std::string_view  labels, const int nBinsX, const double xlo, const double xhi, const int nBinsY, const double ylo, const double yhi, bool prependDir=true, bool useRMS=false);
  TProfile2D * BookTProfile2D(std::string_view name, std::string_view labels, const int nBinsX, double* binsX, const int nBinsY, double* binsY, bool prependDir=true, bool useRMS=false);
  TEfficiency * BookTEfficiency(std::string_view name, std::string_view  labels, const int nBinsX, const float xlo, const float xhi, const bool prependDir = true);
  TEfficiency * BookTEfficiency(std::string_view name, std::string_view  labels, const int nBinsX, const float xlo, const float xhi, const int nBinsy, const float ylo, const float yhi, const bool prependDir = true);
  TTree* BookTree(std::string_view  name, bool prependDir = true);
  
  const std::string& getDirectory(){return m_sDirectory;}
 
private:
  virtual void initializePlots(){;}
  virtual void finalizePlots(){;}
  static std::string constructPrefix(std::string dir, bool prependDir);
 
protected:
  std::vector<PlotBase*> m_vSubNodes;
  std::vector<HistData>  m_vBookedHistograms;
  std::vector<TreeData>  m_vBookedTrees;
  std::vector<EfficiencyData>  m_vBookedEfficiencies;
  std::string m_sDirectory;
  int m_iDetailLevel;
};
 
#endif