![]() |
MaCh3 2.2.1
Reference Guide
|
Functions | |
virtual M3::int_t | SampleHandlerBase::GetNsamples () |
virtual std::string | SampleHandlerBase::GetTitle () const |
virtual std::string | SampleHandlerBase::GetSampleName (int Sample) const =0 |
virtual double | SampleHandlerBase::GetSampleLikelihood (const int isample) |
MaCh3Modes * | SampleHandlerBase::GetMaCh3Modes () const |
Return pointer to MaCh3 modes. | |
virtual double | SampleHandlerBase::GetLikelihood ()=0 |
unsigned int | SampleHandlerBase::GetNEvents () const |
virtual int | SampleHandlerBase::GetNMCSamples () |
virtual int | SampleHandlerBase::GetNOscChannels () |
double | SampleHandlerBase::GetTestStatLLH (double data, double mc) const |
Calculate test statistic for a single bin using Poisson. | |
double | SampleHandlerBase::GetTestStatLLH (const double data, const double mc, const double w2) const |
Calculate test statistic for a single bin. Calculation depends on setting of fTestStatistic. Data and mc -> 0 cut-offs are defined in M3::LOW_MC_BOUND. | |
void | SampleHandlerBase::SetTestStatistic (TestStatistic testStat) |
Set the test statistic to be used when calculating the binned likelihoods. | |
int | SampleHandlerFD::GetNDim () const |
DB Function to differentiate 1D or 2D binning. | |
std::string | SampleHandlerFD::GetSampleName (int iSample=0) const override |
std::string | SampleHandlerFD::GetTitle () const override |
std::string | SampleHandlerFD::GetXBinVarName () |
std::string | SampleHandlerFD::GetYBinVarName () |
TH1 * | SampleHandlerFD::GetMCHist (const int Dimension) |
Get MC histogram. | |
TH1 * | SampleHandlerFD::GetW2Hist (const int Dimension) |
Get W2 histogram. | |
TH1 * | SampleHandlerFD::GetDataHist (const int Dimension) |
Get Data histogram. | |
int | SampleHandlerFD::GetNOscChannels () override |
std::string | SampleHandlerFD::GetFlavourName (const int iChannel) |
TH1 * | SampleHandlerFD::Get1DVarHist (const std::string &ProjectionVar, const std::vector< KinematicCut > &EventSelectionVec=std::vector< KinematicCut >(), int WeightStyle=0, TAxis *Axis=nullptr, const std::vector< KinematicCut > &SubEventSelectionVec=std::vector< KinematicCut >()) |
void | SampleHandlerFD::Fill1DSubEventHist (TH1D *_h1DVar, const std::string &ProjectionVar, const std::vector< KinematicCut > &SubEventSelectionVec=std::vector< KinematicCut >(), int WeightStyle=0) |
TH1 * | SampleHandlerFD::Get1DVarHistByModeAndChannel (const std::string &ProjectionVar_Str, int kModeToFill=-1, int kChannelToFill=-1, int WeightStyle=0, TAxis *Axis=nullptr) |
TH2 * | SampleHandlerFD::Get2DVarHistByModeAndChannel (const std::string &ProjectionVar_StrX, const std::string &ProjectionVar_StrY, int kModeToFill=-1, int kChannelToFill=-1, int WeightStyle=0, TAxis *AxisX=nullptr, TAxis *AxisY=nullptr) |
TH1 * | SampleHandlerFD::GetModeHist1D (int s, int m, int style=0) |
TH2 * | SampleHandlerFD::GetModeHist2D (int s, int m, int style=0) |
std::vector< TH1 * > | SampleHandlerFD::ReturnHistsBySelection1D (std::string KinematicProjection, int Selection1, int Selection2=-1, int WeightStyle=0, TAxis *Axis=0) |
std::vector< TH2 * > | SampleHandlerFD::ReturnHistsBySelection2D (std::string KinematicProjectionX, std::string KinematicProjectionY, int Selection1, int Selection2=-1, int WeightStyle=0, TAxis *XAxis=0, TAxis *YAxis=0) |
THStack * | SampleHandlerFD::ReturnStackedHistBySelection1D (std::string KinematicProjection, int Selection1, int Selection2=-1, int WeightStyle=0, TAxis *Axis=0) |
TLegend * | SampleHandlerFD::ReturnStackHistLegend () |
int | SampleHandlerFD::ReturnKinematicParameterFromString (const std::string &KinematicStr) const |
ETA function to generically convert a string from xsec cov to a kinematic type. | |
std::string | SampleHandlerFD::ReturnStringFromKinematicParameter (const int KinematicVariable) const |
ETA function to generically convert a kinematic type from xsec cov to a string. | |
Group of functions to get various parameters, names, and values.
void SampleHandlerFD::Fill1DSubEventHist | ( | TH1D * | _h1DVar, |
const std::string & | ProjectionVar, | ||
const std::vector< KinematicCut > & | SubEventSelectionVec = std::vector< KinematicCut >() , |
||
int | WeightStyle = 0 |
||
) |
Definition at line 1553 of file SampleHandlerFD.cpp.
TH1 * SampleHandlerFD::Get1DVarHist | ( | const std::string & | ProjectionVar, |
const std::vector< KinematicCut > & | EventSelectionVec = std::vector< KinematicCut >() , |
||
int | WeightStyle = 0 , |
||
TAxis * | Axis = nullptr , |
||
const std::vector< KinematicCut > & | SubEventSelectionVec = std::vector< KinematicCut >() |
||
) |
Definition at line 1500 of file SampleHandlerFD.cpp.
TH1 * SampleHandlerFD::Get1DVarHistByModeAndChannel | ( | const std::string & | ProjectionVar_Str, |
int | kModeToFill = -1 , |
||
int | kChannelToFill = -1 , |
||
int | WeightStyle = 0 , |
||
TAxis * | Axis = nullptr |
||
) |
Definition at line 1790 of file SampleHandlerFD.cpp.
TH2 * SampleHandlerFD::Get2DVarHistByModeAndChannel | ( | const std::string & | ProjectionVar_StrX, |
const std::string & | ProjectionVar_StrY, | ||
int | kModeToFill = -1 , |
||
int | kChannelToFill = -1 , |
||
int | WeightStyle = 0 , |
||
TAxis * | AxisX = nullptr , |
||
TAxis * | AxisY = nullptr |
||
) |
Definition at line 1840 of file SampleHandlerFD.cpp.
TH1 * SampleHandlerFD::GetDataHist | ( | const int | Dimension | ) |
Get Data histogram.
Definition at line 1136 of file SampleHandlerFD.cpp.
|
inline |
Definition at line 83 of file SampleHandlerFD.h.
|
pure virtual |
Implemented in PySampleHandlerBase, and SampleHandlerFD.
|
inline |
TH1 * SampleHandlerFD::GetMCHist | ( | const int | Dimension | ) |
Get MC histogram.
Definition at line 1121 of file SampleHandlerFD.cpp.
|
inline |
Definition at line 111 of file SampleHandlerFD.h.
|
inline |
Definition at line 115 of file SampleHandlerFD.h.
|
inline |
DB Function to differentiate 1D or 2D binning.
Definition at line 31 of file SampleHandlerFD.h.
|
inline |
Definition at line 60 of file SampleHandlerBase.h.
|
inlinevirtual |
Definition at line 62 of file SampleHandlerBase.h.
|
inlinevirtual |
Reimplemented in SampleHandlerFD.
Definition at line 64 of file SampleHandlerBase.h.
|
inlineoverridevirtual |
|
inlinevirtual |
Definition at line 40 of file SampleHandlerBase.h.
|
inlinevirtual |
Definition at line 46 of file SampleHandlerBase.h.
|
overridevirtual |
Implements SampleHandlerBase.
Definition at line 1341 of file SampleHandlerFD.cpp.
|
pure virtual |
Implemented in PySampleHandlerBase, and SampleHandlerFD.
double SampleHandlerBase::GetTestStatLLH | ( | const double | data, |
const double | mc, | ||
const double | w2 | ||
) | const |
Calculate test statistic for a single bin. Calculation depends on setting of fTestStatistic. Data and mc -> 0 cut-offs are defined in M3::LOW_MC_BOUND.
Implemented fTestStatistic are kPoisson (with Stirling's approx.), kBarlowBeeston (arXiv:1103.0354), kDembinskiAbdelmotteleb (arXiv:2206.12346), kIceCube (arxiv:1901.04645), and kPearson. Test statistics require mc > 0, therefore low mc and data values are treated with cut-offs based on M3::LOW_MC_BOUND = .00001 by default. For kPoisson, kBarlowBeeston, kDembinskiAbdelmotteleb, kPearson: data > LOW_MC_BOUND & mc <= LOW_MC_BOUND: returns GetTestStatLLH(data, LOW_MC_BOUND, w2), with Poisson(data,LOW_MC_BOUND) limit for mc->0, w2->0. mc < data <= LOW_MC_BOUND: returns 0 (as if any data <= LOW_MC_BOUND were effectively consistent with 0 data count), with a limit of 0 for mc->0. data = 0: returns mc (or mc/2. for kPearson), with a limit of 0 for mc->0. For kIceCube: mc < data returns the lower of IceCube(data,mc,w2) and Poisson(data,mc) penalties, with a Poisson(data,LOW_MC_BOUND) limit for mc->0, w2->0.
data | is data |
mc | is mc |
w2 | is is Sum(w_{i}^2) (sum of weights squared), which is sigma^2_{MC stats} |
Definition at line 36 of file SampleHandlerBase.cpp.
double SampleHandlerBase::GetTestStatLLH | ( | double | data, |
double | mc | ||
) | const |
Calculate test statistic for a single bin using Poisson.
data | is data |
mc | is mc |
Definition at line 18 of file SampleHandlerBase.cpp.
|
inlinevirtual |
Reimplemented in SampleHandlerFD.
Definition at line 42 of file SampleHandlerBase.h.
|
inlineoverridevirtual |
Reimplemented from SampleHandlerBase.
Definition at line 35 of file SampleHandlerFD.h.
TH1 * SampleHandlerFD::GetW2Hist | ( | const int | Dimension | ) |
Get W2 histogram.
Definition at line 1094 of file SampleHandlerFD.cpp.
|
inline |
Definition at line 38 of file SampleHandlerFD.h.
|
inline |
Definition at line 40 of file SampleHandlerFD.h.
std::vector< TH1 * > SampleHandlerFD::ReturnHistsBySelection1D | ( | std::string | KinematicProjection, |
int | Selection1, | ||
int | Selection2 = -1 , |
||
int | WeightStyle = 0 , |
||
TAxis * | Axis = 0 |
||
) |
Definition at line 2030 of file SampleHandlerFD.cpp.
std::vector< TH2 * > SampleHandlerFD::ReturnHistsBySelection2D | ( | std::string | KinematicProjectionX, |
std::string | KinematicProjectionY, | ||
int | Selection1, | ||
int | Selection2 = -1 , |
||
int | WeightStyle = 0 , |
||
TAxis * | XAxis = 0 , |
||
TAxis * | YAxis = 0 |
||
) |
Definition at line 2066 of file SampleHandlerFD.cpp.
int SampleHandlerFD::ReturnKinematicParameterFromString | ( | const std::string & | KinematicStr | ) | const |
ETA function to generically convert a string from xsec cov to a kinematic type.
Definition at line 1689 of file SampleHandlerFD.cpp.
THStack * SampleHandlerFD::ReturnStackedHistBySelection1D | ( | std::string | KinematicProjection, |
int | Selection1, | ||
int | Selection2 = -1 , |
||
int | WeightStyle = 0 , |
||
TAxis * | Axis = 0 |
||
) |
Definition at line 2095 of file SampleHandlerFD.cpp.
|
inline |
Definition at line 126 of file SampleHandlerFD.h.
std::string SampleHandlerFD::ReturnStringFromKinematicParameter | ( | const int | KinematicVariable | ) | const |
ETA function to generically convert a kinematic type from xsec cov to a string.
Definition at line 1701 of file SampleHandlerFD.cpp.
|
inline |
Set the test statistic to be used when calculating the binned likelihoods.
testStat | The test statistic to use. |
Definition at line 99 of file SampleHandlerBase.h.