PlottingUtils.hpp

Go to the documentation of this file.

#ifndef PLOTTINGUTILS_H
#define PLOTTINGUTILS_H
 
#include <TCanvas.h>
#include <TF1.h>
#include <TGaxis.h>
#include <TGraph.h>
#include <TGraphErrors.h>
#include <TH1.h>
#include <TH2.h>
#include <TLatex.h>
#include <TLegend.h>
#include <TMath.h>
#include <TPad.h>
#include <TROOT.h>
#include <TRandom3.h>
#include <TStyle.h>
#include <TSystem.h>
#include <iostream>
#include <vector>

enum class PlotSaveOptions {
  kLINEAR, 
  kLOG,    
  kBOTH    
};

enum class PlotSaveFormat {
  kPNG, 
  kPDF  
};

class PlottingUtils {
public:
  static void
  SetStylePreferences(PlotSaveFormat save_format = PlotSaveFormat::kPNG);

  static void ConfigureAndDrawGraph(TGraph *graph, Int_t color,
                                    const TString title = "");

  static void ConfigureAndDrawHistogram(TH1 *hist, Int_t color,
                                        const TString title = "");

  static void ConfigureAndDraw2DHistogram(TH2 *hist, TCanvas *canvas,
                                          const TString title = "");

  static void ConfigureGraph(TGraph *graph, Int_t color,
                             const TString title = "");

  static void ConfigureGraph(TGraphErrors *graph, Int_t color,
                             const TString title = "");

  static void ConfigureHistogram(TH1 *hist, Int_t color,
                                 const TString title = "");

  static void Configure2DHistogram(TH2 *hist, TCanvas *canvas,
                                   const TString title = "");

  static TCanvas *GetConfiguredCanvas(Bool_t logy = kFALSE);

  static TCanvas *GetConfiguredCanvasWithSideLegend(TPad *&plot,
                                                    TPad *&legend_pad,
                                                    Int_t legend_width_px = 600,
                                                    Int_t plot_height_px = 800,
                                                    Bool_t logy = kFALSE);

  static void SplitPadForPanel(TVirtualPad *pad, Int_t panel_height_px,
                               TPad *&upper, TPad *&lower);

  static void SaveFigure(TCanvas *canvas, TString output_filename,
                         TString output_subdirectory = "",
                         PlotSaveOptions save_options = PlotSaveOptions::kBOTH);

  static void SetPlotsBaseDir(const TString &dir);

  static TString GetPlotsBaseDir();

  static void
  PlotFitWithResiduals(TH1 *hist, TGraph *total_graph,
                       const std::vector<TGraph *> &component_graphs,
                       Float_t fit_range_low, Float_t fit_range_high,
                       const TString &output_name,
                       const TString &output_subdirectory = "fits",
                       const TString &label = "", Bool_t logy = kTRUE);

  static TLegend *AddLegend(Double_t x1 = 0.7, Double_t x2 = 0.9,
                            Double_t y1 = 0.7, Double_t y2 = 0.9);

  static Double_t TextWidthPx(const TString &text, Double_t size_px = 30.0,
                              Int_t font = 43);

  static Double_t LegendWidthPx(const std::vector<TString> &labels,
                                const TString &header = "",
                                Double_t size_px = 30.0, Double_t margin = 0.25,
                                Double_t padding_px = 15.0);

  static Double_t FigureScale(TVirtualPad *pad,
                              Int_t reference_width_px = 1200);

  static void ScaleFigure(TVirtualPad *pad, Int_t reference_width_px = 1200,
                          Int_t reference_height_px = 800);

  static void ScalePad(TVirtualPad *pad, Double_t scale,
                       Int_t reference_width_px = 1200,
                       Int_t reference_height_px = 800);

  static void ScaleAxisFontsToPad(TH1 *frame, TVirtualPad *pad,
                                  Double_t scale = 1.0,
                                  Int_t reference_width_px = 1200,
                                  Int_t reference_height_px = 800);

  static void ScaleLegend(TLegend *legend, Double_t scale);

  static void ScaleText(TText *text, TVirtualPad *pad, Double_t scale,
                        Int_t reference_height_px = 800);

  static TLatex *DrawTitle(TVirtualPad *pad, const TString &title,
                           Double_t scale = 1.0);

  static void ScaleLine(TAttLine *line, Double_t scale);

  static void ScaleMarker(TAttMarker *marker, Double_t scale);

  static TLatex *AddText(const TString label, Double_t x = 0.9,
                         Double_t y = 0.85, Double_t angle = 0);

  static std::vector<Int_t> GetDefaultColors();

  static TString GetRandomName();

  static Width_t GetLineWidth() { return line_width_; };
 
private:
  static PlotSaveFormat save_format_;
  static Bool_t preferences_set_;
  static Width_t line_width_;
  static TString plots_base_dir_;
  static void SetTurboPalette();
  static void WarnIfNotConfigured(const TString method_name);
  static void PlotPullHistogram(TGraph *residuals, const TString &output_name,
                                const TString &output_subdirectory);
};
 
#endif