MaCh3  2.8.0
Reference Guide
HistogramUtils.h
Go to the documentation of this file.
1 #pragma once
2 
3 // MaCh3 includes
6 #include "Manager/YamlHelper.h"
7 #include "Manager/Random.h"
8 //KS: Joy of forward declaration https://gieseanw.wordpress.com/2018/02/25/the-joys-of-forward-declarations-results-from-the-real-world/
9 class TObject;
10 
14 
16 double OverflowIntegral(TH2Poly* poly);
17 
19 double NoOverflowIntegral(TH2Poly* poly);
20 
22 TH1D* PolyProjectionX(TObject* poly, const std::string& TempName, const std::vector<double>& xbins, const bool computeErrors = false);
24 TH1D* PolyProjectionY(TObject* poly, const std::string& TempName, const std::vector<double>& ybins, const bool computeErrors = false);
25 
27 TH2D* ConvertTH2PolyToTH2D(TH2Poly *poly, TH2D *TH2Dhist);
29 TH2Poly* ConvertTH2DtoTH2Poly(TH2D *TH2Dhist);
30 
32 TH2Poly* NormalisePoly(TH2Poly* Histogram);
33 
36 void NormaliseTH2Poly(TH2Poly* Histogram);
37 
39 TH2Poly* PolyScaleWidth(TH2Poly *Histogram, double scale);
40 
42 double PolyIntegralWidth(TH2Poly *Histogram);
43 
45 template<class HistType> HistType* RatioHists(HistType* NumHist, HistType* DenomHist);
46 
48 TH2Poly* RatioPolys(TH2Poly* NumPoly, TH2Poly* DenomPoly);
49 
54 TH2Poly* MakePolyHist(const std::string& name, const std::vector<double>& BinArray_x, const std::vector<double>& BinArray_y);
55 
59 void CheckTH2PolyFileVersion(TFile *file);
60 
62 void RemoveFitter(TH1D* hist, const std::string& name);
63 
65 void MakeFluctuatedHistogramStandard(TH1D *FluctHist, TH1D* PolyHist);
67 void MakeFluctuatedHistogramAlternative(TH1D *FluctHist, TH1D* PolyHist);
68 
70 void MakeFluctuatedHistogramStandard(TH2D *FluctHist, TH2D* PolyHist);
72 void MakeFluctuatedHistogramAlternative(TH2D *FluctHist, TH2D* PolyHist);
73 
75 void MakeFluctuatedHistogramStandard(TH2Poly *FluctHist, TH2Poly* PolyHist);
77 void MakeFluctuatedHistogramAlternative(TH2Poly *FluctHist, TH2Poly* PolyHist);
78 
80 int GetRandomPoly2(const TH2Poly* PolyHist);
81 
85 void FastViolinFill(TH2D* violin, TH1D* hist_1d);
86 
92 template <typename Derived, typename Base>
93 std::vector<std::unique_ptr<Base>>
94 CastVector(std::vector<std::unique_ptr<Derived>>&& inputVec) {
95  std::vector<std::unique_ptr<Base>> outputVec;
96  outputVec.reserve(inputVec.size());
97  for (auto& ptr : inputVec) {
98  outputVec.push_back(std::unique_ptr<Base>(std::move(ptr)));
99  }
100  return outputVec;
101 }
102 
104 inline std::string file_exists(std::string filename) {
105  std::ifstream infile(filename.c_str());
106  if (!infile.good()) {
107  MACH3LOG_ERROR("File {} does not exist", filename);
108  MACH3LOG_ERROR("Please try again");
109  throw MaCh3Exception(__FILE__ , __LINE__ );
110  }
111  return filename;
112 }
113 
116 double returnCherenkovThresholdMomentum(const int PDG);
117 
123 double CalculateQ2(double PLep, double PUpd, double EnuTrue, double InitialQ2 = 0.0);
124 
130 double CalculateEnu(double PLep, double cosTheta, double EB, bool neutrino);
131 
135 std::unique_ptr<TH1D> MakeSummaryFromSpectra(const TH2D* Spectra, const std::string& name);
136 
140 std::vector<double> BuildBinEdgesFromNode(YAML::Node const &bin_edges_node, bool &found_range_specifier);
141 
144 std::vector<double> BinRangeToBinEdges(YAML::Node const &bin_range);
145 
146 namespace M3 {
153 template <typename ObjectType>
154 std::unique_ptr<ObjectType> Clone(const ObjectType* obj, const std::string& name = "") {
155  std::string cloneName = name.empty() ? obj->GetName() : name;
156 
157  std::unique_ptr<ObjectType> Hist(static_cast<ObjectType*>(obj->Clone(cloneName.c_str())));
158  // Disable ROOT memory management because it causes lot of headache especially as smart pointers are much smarter
159  Hist->SetDirectory(nullptr);
160 
161  return Hist;
162 }
163 
174 TFile* Open(const std::string& Name, const std::string& Type, const std::string& File, const int Line);
175 
177 void ScaleHistogram(TH1* Sample_Hist, const double scale);
178 
180 void CheckBinningMatch(const TH1D* Hist1, const TH1D* Hist2, const std::string& File, const int Line);
182 void CheckBinningMatch(const TH2D* Hist1, const TH2D* Hist2, const std::string& File, const int Line);
184 void CheckBinningMatch(TH2Poly* Hist1, TH2Poly* Hist2, const std::string& File, const int Line);
186 YAML::Node PolyToYaml(TH2Poly* Hist, const std::string& YamlName, const std::string& File, const int Line);
187 
188 } //end M3
double CalculateQ2(double PLep, double PUpd, double EnuTrue, double InitialQ2=0.0)
Recalculate Q^2 after Eb shift. Takes in shifted lepton momentum, lepton angle, and true neutrino ene...
int GetRandomPoly2(const TH2Poly *PolyHist)
KS: ROOT developers were too lazy do develop getRanom2 for TH2Poly, this implementation is based on l...
void CheckTH2PolyFileVersion(TFile *file)
KS: ROOT changes something with binning when moving from ROOT 5 to ROOT 6. If you open ROOT5 produced...
TH2Poly * RatioPolys(TH2Poly *NumPoly, TH2Poly *DenomPoly)
Helper to make ratio of TH2Polys.
void MakeFluctuatedHistogramStandard(TH1D *FluctHist, TH1D *PolyHist)
Make Poisson fluctuation of TH1D hist using default fast method.
double CalculateEnu(double PLep, double cosTheta, double EB, bool neutrino)
Recalculate Enu after Eb shift. Takes in shifted lepton momentum, lepton angle, and binding energy ch...
void NormaliseTH2Poly(TH2Poly *Histogram)
Helper to Normalise histograms.
double returnCherenkovThresholdMomentum(const int PDG)
DB Get the Cherenkov momentum threshold in MeV.
double OverflowIntegral(TH2Poly *poly)
WP: Helper function for calculating unbinned Integral of TH2Poly i.e including overflow.
TH2D * ConvertTH2PolyToTH2D(TH2Poly *poly, TH2D *TH2Dhist)
KS: Convert TH2D to TH2Poly.
std::vector< double > BuildBinEdgesFromNode(YAML::Node const &bin_edges_node, bool &found_range_specifier)
Builds a single dimension's bin edges from YAML::Node.
void FastViolinFill(TH2D *violin, TH1D *hist_1d)
KS: Fill Violin histogram with entry from a toy.
TH2Poly * NormalisePoly(TH2Poly *Histogram)
WP: Helper to Normalise histograms.
TH1D * PolyProjectionY(TObject *poly, const std::string &TempName, const std::vector< double > &ybins, const bool computeErrors=false)
WP: Poly Projectors.
HistType * RatioHists(HistType *NumHist, HistType *DenomHist)
Helper to make ratio histograms.
std::vector< double > BinRangeToBinEdges(YAML::Node const &bin_range)
Converts a range (linspace/logspace) to a std::vector<double>
TH2Poly * PolyScaleWidth(TH2Poly *Histogram, double scale)
WP: Helper to scale th2poly analogous to th2d scale with option "width".
void RemoveFitter(TH1D *hist, const std::string &name)
KS: Remove fitted TF1 from hist to make comparison easier.
double PolyIntegralWidth(TH2Poly *Histogram)
WP: Helper to calc integral of th2poly analogous to th2d integra; with option "width".
std::vector< std::unique_ptr< Base > > CastVector(std::vector< std::unique_ptr< Derived >> &&inputVec)
Converts a vector of pointers from a derived type to a base type.
TH2Poly * ConvertTH2DtoTH2Poly(TH2D *TH2Dhist)
KS: Convert TH2Poly to TH2D.
double NoOverflowIntegral(TH2Poly *poly)
WP: Helper function for calculating binned Integral of TH2Poly i.e not including overflow.
TH1D * PolyProjectionX(TObject *poly, const std::string &TempName, const std::vector< double > &xbins, const bool computeErrors=false)
WP: Poly Projectors.
TH2Poly * MakePolyHist(const std::string &name, const std::vector< double > &BinArray_x, const std::vector< double > &BinArray_y)
WP: Helper function to create TH2Poly histogram with uniform binning.
std::unique_ptr< TH1D > MakeSummaryFromSpectra(const TH2D *Spectra, const std::string &name)
Build a 1D posterior-predictive summary from a violin spectrum.
void MakeFluctuatedHistogramAlternative(TH1D *FluctHist, TH1D *PolyHist)
Make Poisson fluctuation of TH1D hist using slow method which is only for cross-check.
std::string file_exists(std::string filename)
Helper to check if files exist or not.
#define MACH3LOG_ERROR
Definition: MaCh3Logger.h:37
Definitions of generic parameter structs and utility templates for MaCh3.
Utility functions for handling YAML nodes.
Custom exception class used throughout MaCh3.
Main namespace for MaCh3 software.
std::unique_ptr< ObjectType > Clone(const ObjectType *obj, const std::string &name="")
KS: Creates a copy of a ROOT-like object and wraps it in a smart pointer.
void CheckBinningMatch(const TH1D *Hist1, const TH1D *Hist2, const std::string &File, const int Line)
KS: Helper function check if data and MC binning matches.
void ScaleHistogram(TH1 *Sample_Hist, const double scale)
Scale histogram to get divided by bin width.
TFile * Open(const std::string &Name, const std::string &Type, const std::string &File, const int Line)
Opens a ROOT file with the given name and mode.
YAML::Node PolyToYaml(TH2Poly *Hist, const std::string &YamlName, const std::string &File, const int Line)
KS: Convert TH2Poly into yaml config accepted by MaCh3.