PlotStack.h

Go to the documentation of this file.

/**
  @file   PlotStack.h

  Header of PlotStack class.

  @author Daniel Abercrombie <dabercro@mit.edu>
*/

#ifndef CROMBIETOOLS_PLOTTOOLS_PLOTSTACK_H
#define CROMBIETOOLS_PLOTTOOLS_PLOTSTACK_H

#include "HistHolder.h"
#include "PlotPreparer.h"

/**
   @ingroup plotgroup
   @class PlotStack
   Class used for making stack plots.
   Most easy way to use this class is through CrombieTools.PlotTools.PlotStack
   convenience functions and using an [MC Configuration](@ref formatmc).
   Many appearance flags must be set through this class's methods though.
*/

class PlotStack : public PlotPreparer
{
 public:
  PlotStack();
  virtual ~PlotStack();

  /// Copy this PlotStack for parallelization
  PlotStack* Copy        ();

  /// Merge a vector of histograms into a vector of HistHolders
  std::vector<HistHolder*>  MergeHistograms ( FileType type, std::vector<TH1D*> hists );

  /// Choose the binning of your plots and make then
  void MakeCanvas        ( TString FileBase, Int_t NumXBins, Double_t *XBins,
                           TString XLabel, TString YLabel = "", Bool_t logY = false );

  /// Binning with fixed width
  void MakeCanvas        ( TString FileBase, Int_t NumXBins, Double_t MinX, Double_t MaxX,
                           TString XLabel, TString YLabel = "", Bool_t logY = false );

  /// Make plots with the PlotPreparer
  void MakeCanvas        ( TString FileBase, TString XLabel, TString YLabel = "", Bool_t logY = false );

  /**
     Sets the legend entry that will be on the top of the stack.
     @param force should match a legend entry. It should have spaces instead of underscores
                  if matching an entry in an [MC Configuration](formatmc).
  */
  void SetForceTop       ( TString force )            { fForceTop = force;                        }
  /// Set the minimum fraction of background that shows up on the plot's legend separately
  void SetMinLegendFrac  ( Double_t frac )            { fMinLegendFrac = frac;                    }
  /// Set the minimum fraction of backgrounds that are not plotted or mentioned in linear scale
  void SetIgnoreInLinear ( Double_t ignore )          { fIgnoreInLinear = ignore;                 }
  /// Set the color of the "Others" legend entry
  void SetOthersColor    ( Color_t color )            { fOthersColor = color;                     }
  /// Set the line width of the stack plots
  void SetStackLineWidth ( Int_t width )              { fStackLineWidth = width;                  }

  /// This dumps out some raw values for you to check yields.
  void SetDebug          ( Bool_t debug )             { fDebug = debug;                           }
  /// Set the name of a .root file to dump the separate histograms used in the plots.
  void SetDumpFileName   ( TString dumpName )         { fDumpRootName = dumpName;                 }

  /// Set the suffix of dumped histograms
  void SetHistSuff       ( TString suff )             { fHistSuff = suff;                         }

  /**
     Insert a histogram from file into the stack plot.
     Most histograms in the stack plot are created from TTree::Draw() functions acting on trees.
     It is also possible to just insert a histogram generated by someone else into the stack plot.
     @param fileName is the name of the file containing the histogram.
     @param histName is the name of the TH1 inside the file.
     @param LegendEntry is the entry in the legend. It does not require underscores for spaces
                        like in the [MC Configurations](@ref formatmc).
  */
  void InsertTemplate    ( TString fileName, TString histName, TString LegendEntry )
                                                      { fTemplateFiles.push_back(fileName);
                                                        fTemplateHists.push_back(histName);
                                                        fTemplateEntries.push_back(LegendEntry);  }

  /// Use this to change the automatic sorting of backgrounds based on yields
  void SetSortBackground ( Bool_t doSort )            { fSortBackground = doSort;                 }

  /// Use this to change the automatic sorting of signals based on yields
  void SetSortSignal     ( Bool_t doSort )            { fSortSignal = doSort;                     }

  /// Use this to set whether the signal sits on top or not
  void SetAddSignal      ( Bool_t add )               { fAddSignal = add;                         }

  /// Use this to get a post-fit line
  void SetPostFitFile  ( TString file_name, TString region ) 
                                                    { fPostFitFile = file_name; fRegion = region; }

 private:
  TString               fForceTop = "";             ///< A legend entry that is on the top of backgrounds
  Double_t              fMinLegendFrac = 0.0;       ///< If a background contributes less than this, it's grouped in others
  Double_t              fIgnoreInLinear = 0.0;      ///< If background less than this, do not draw in linear-scale plot
  Int_t                 fStackLineWidth = 1;        ///< Line width of the histograms
  Color_t               fOthersColor = 0;           ///< Color of the "Others" legend entry

  std::vector<TString>  fTemplateFiles;             ///< Holds file name of the templates
  std::vector<TString>  fTemplateHists;             ///< Holds histogram name of the templates
  std::vector<TString>  fTemplateEntries;           ///< Holds legend entries of the templates

  Bool_t                fDebug = false;             ///< Dumps yield tests
  TString               fDumpRootName = "";         ///< File where each histogram in stack is dumped
  TString               fHistSuff = "";
  Bool_t                fSortBackground = true;     ///< Bool to sort the backgrounds
  Bool_t                fSortSignal = true;         ///< Bool to sort the signals
  Bool_t                fAddSignal = true;          ///< Bool to determine where the signal sits
  TString               fPostFitFile = "";          ///< Holds the location of post-fit plots
  TString               fRegion = "";               ///< Holds the region for post-fit plots

  /// Makes the canvas from histogram vectors. All other MakeCanvas pass through here.
  void   MakeCanvas   (TString FileBase, std::vector<TH1D*> DataHists, std::vector<TH1D*> MCHists, std::vector<TH1D*> SignalHists,
                       TString XLabel, TString YLabel, Bool_t logY);

  ClassDef(PlotStack, 1)
};

#endif