EW: As SampleHandlerBase is an abstract base class we have to do some gymnastics to get it to get it into python. More...

Inheritance diagram for PySampleHandlerBase:

[legend]

Collaboration diagram for PySampleHandlerBase:

[legend]

Public Member Functions
std::string	GetName () const override

std::string	GetSampleTitle (const int iSample) const override

int	GetNOscChannels (const int iSample) const override

void	Reweight () override

double	GetSampleLikelihood (const int iSample) const override

void	CleanMemoryBeforeFit () override
	Allow to clean not used memory before fit starts. More...

void	PrintRates (const bool DataOnly=false) override
	Helper function to print rates for the samples with LLH. More...

std::string	GetKinVarName (const int iSample, const int Dimension) const override
	Return Kinematic Variable name for specified sample and dimension for example "Reconstructed_Neutrino_Energy". More...

std::vector< double >	ReturnKinematicParameterBinning (const int Sample, const std::string &KinematicParameter) const override
	Return the binning used to draw a kinematic parameter. More...

TH1 *	GetDataHist (const int Sample) override
	Get Data histogram. More...

TH1 *	GetMCHist (const int Sample) override
	Get MC histogram. More...

TH1 *	GetW2Hist (const int Sample) override
	Get W2 histogram. More...

double	GetLikelihood () const override

TH1 *	Get1DVarHistByModeAndChannel (const int iSample, const std::string &ProjectionVar_Str, int kModeToFill=-1, int kChannelToFill=-1, int WeightStyle=0, TAxis *Axis=nullptr) override

TH2 *	Get2DVarHistByModeAndChannel (const int iSample, 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) override

TH1 *	Get1DVarHist (const int iSample, const std::string &ProjectionVar, const std::vector< KinematicCut > &EventSelectionVec={}, int WeightStyle=0, TAxis *Axis=nullptr, const std::vector< KinematicCut > &SubEventSelectionVec={}) override

TH2 *	Get2DVarHist (const int iSample, const std::string &ProjectionVarX, const std::string &ProjectionVarY, const std::vector< KinematicCut > &EventSelectionVec={}, int WeightStyle=0, TAxis AxisX=nullptr, TAxis AxisY=nullptr, const std::vector< KinematicCut > &SubEventSelectionVec={}) override

int	GetNDim (const int Sample) const override
	DB Function to differentiate 1D or 2D binning. More...

std::string	GetFlavourName (const int iSample, const int iChannel) const override

	SampleHandlerBase ()
	The main constructor. More...

Public Member Functions inherited from SampleHandlerBase
	SampleHandlerBase ()
	The main constructor. More...

virtual	~SampleHandlerBase ()
	destructor More...

virtual M3::int_t	GetNsamples ()

virtual void	SaveAdditionalInfo (TDirectory *Dir)
	Store additional info in a chan. More...

MaCh3Modes *	GetMaCh3Modes () const
	Return pointer to MaCh3 modes. More...

unsigned int	GetNEvents () const

double	GetPoissonLLH (const double data, const double mc) const
	Calculate test statistic for a single bin using Poisson. More...

double	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. More...

void	SetTestStatistic (TestStatistic testStat)
	Set the test statistic to be used when calculating the binned likelihoods. More...

TestStatistic	GetTestStatistic () const
	Get the test statistic used when calculating the binned likelihoods. More...

Additional Inherited Members
Protected Member Functions inherited from SampleHandlerBase
void	QuietPlease ()
	CW: Redirect std::cout to silence some experiment specific libraries. More...

void	NowTalk ()
	CW: Redirect std::cout to silence some experiment specific libraries. More...

template<typename T >
bool	MatchCondition (const std::vector< T > &allowedValues, const T &value)
	check if event is affected by following conditions, for example pdg, or modes etc More...

Protected Attributes inherited from SampleHandlerBase
TestStatistic	fTestStatistic
	Test statistic tells what kind of likelihood sample is using. More...

std::streambuf *	buf
	Keep the cout buffer. More...

std::streambuf *	errbuf
	Keep the cerr buffer. More...

M3::int_t	nSamples
	Contains how many samples we've got. More...

unsigned int	nEvents
	Number of MC events are there. More...

std::unique_ptr< MaCh3Modes >	Modes
	Holds information about used Generator and MaCh3 modes. More...

Detailed Description

EW: As SampleHandlerBase is an abstract base class we have to do some gymnastics to get it to get it into python.

Definition at line 10 of file samples.cpp.

Member Function Documentation

◆ CleanMemoryBeforeFit()

void PySampleHandlerBase::CleanMemoryBeforeFit ( )

inlineoverridevirtual

Allow to clean not used memory before fit starts.

Implements SampleHandlerBase.

Definition at line 67 of file samples.cpp.

                                          {
         PYBIND11_OVERRIDE_PURE_NAME(
             void,                  /* Return type */
             SampleHandlerBase,     /* Parent class */
             "clean_memory_before_fit",
             CleanMemoryBeforeFit   /* Name of function in C++ (must match Python name) */
         );
     }

◆ Get1DVarHist()

TH1* PySampleHandlerBase::Get1DVarHist	(	const int	iSample,
		const std::string &	ProjectionVar,
		const std::vector< KinematicCut > &	EventSelectionVec = `{}`,
		int	WeightStyle = `0`,
		TAxis *	Axis = `nullptr`,
		const std::vector< KinematicCut > &	SubEventSelectionVec = `{}`
	)

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 187 of file samples.cpp.

                                                                          {},
                       int WeightStyle = 0,
                       TAxis *Axis = nullptr,
                       const std::vector<KinematicCut> &SubEventSelectionVec = {}) override {
         PYBIND11_OVERRIDE_PURE(
             TH1*,                     /* Return type */
             SampleHandlerBase,        /* Parent class */
             Get1DVarHist,             /* Name of function in C++ */
             iSample,
             ProjectionVar,
             EventSelectionVec,
             WeightStyle,
             Axis,
             SubEventSelectionVec
         );
     }

◆ Get1DVarHistByModeAndChannel()

TH1* PySampleHandlerBase::Get1DVarHistByModeAndChannel	(	const int	iSample,
		const std::string &	ProjectionVar_Str,
		int	kModeToFill = `-1`,
		int	kChannelToFill = `-1`,
		int	WeightStyle = `0`,
		TAxis *	Axis = `nullptr`
	)

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 145 of file samples.cpp.

                                                                       {
         PYBIND11_OVERRIDE_PURE(
             TH1*,                     /* Return type */
             SampleHandlerBase,        /* Parent class */
             Get1DVarHistByModeAndChannel, /* Name of function in C++ */
             iSample,
             ProjectionVar_Str,
             kModeToFill,
             kChannelToFill,
             WeightStyle,
             Axis
         );
     }

◆ Get2DVarHist()

TH2* PySampleHandlerBase::Get2DVarHist	(	const int	iSample,
		const std::string &	ProjectionVarX,
		const std::string &	ProjectionVarY,
		const std::vector< KinematicCut > &	EventSelectionVec = `{}`,
		int	WeightStyle = `0`,
		TAxis *	AxisX = `nullptr`,
		TAxis *	AxisY = `nullptr`,
		const std::vector< KinematicCut > &	SubEventSelectionVec = `{}`
	)

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 206 of file samples.cpp.

                                                                          {},
                       int WeightStyle = 0,
                       TAxis* AxisX = nullptr,
                       TAxis* AxisY = nullptr,
                       const std::vector<KinematicCut>& SubEventSelectionVec = {}) override {
         PYBIND11_OVERRIDE_PURE(
             TH2*,                     /* Return type */
             SampleHandlerBase,        /* Parent class */
             Get2DVarHist,             /* Name of function in C++ */
             iSample,
             ProjectionVarX,
             ProjectionVarY,
             EventSelectionVec,
             WeightStyle,
             AxisX,
             AxisY,
             SubEventSelectionVec
         );
     }

◆ Get2DVarHistByModeAndChannel()

TH2* PySampleHandlerBase::Get2DVarHistByModeAndChannel	(	const int	iSample,
		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`
	)

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 164 of file samples.cpp.

                                                                        {
         PYBIND11_OVERRIDE_PURE(
             TH2*,                        /* Return type */
             SampleHandlerBase,           /* Parent class */
             Get2DVarHistByModeAndChannel, /* Name of function in C++ */
             iSample,
             ProjectionVar_StrX,
             ProjectionVar_StrY,
             kModeToFill,
             kChannelToFill,
             WeightStyle,
             AxisX,
             AxisY
         );
     }

◆ GetDataHist()

TH1* PySampleHandlerBase::GetDataHist ( const int Sample )

inlineoverridevirtual

Get Data histogram.

Implements SampleHandlerBase.

Definition at line 108 of file samples.cpp.

                                                 {
         PYBIND11_OVERRIDE_PURE(
             TH1*,                  /* Return type */
             SampleHandlerBase,     /* Parent class */
             GetDataHist,           /* Name of function in C++ (must match Python name) */
             Sample                 /* Argument(s) */
         );
     }

◆ GetFlavourName()

std::string PySampleHandlerBase::GetFlavourName	(	const int	iSample,
		const int	iChannel
	)		const

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 238 of file samples.cpp.

                                                                   {
         PYBIND11_OVERRIDE_PURE(
             std::string,              /* Return type */
             SampleHandlerBase,        /* Parent class */
             GetFlavourName,           /* Name of function in C++ */
             iSample,
             iChannel
         );
     }

◆ GetKinVarName()

std::string PySampleHandlerBase::GetKinVarName	(	const int	iSample,
		const int	Dimension
	)		const

inlineoverridevirtual

Return Kinematic Variable name for specified sample and dimension for example "Reconstructed_Neutrino_Energy".

Parameters

iSample	Sample index
Dimension	Dimension index

Implements SampleHandlerBase.

Definition at line 87 of file samples.cpp.

                                                                                     {
         PYBIND11_OVERRIDE_PURE(
             std::string,          /* Return type */
             SampleHandlerBase,    /* Parent class */
             GetKinVarName,        /* Name of function in C++ (must match Python name) */
             iSample,              /* Argument(s) */
             Dimension             /* Argument(s) */
         );
     }

◆ GetLikelihood()

double PySampleHandlerBase::GetLikelihood ( ) const

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 135 of file samples.cpp.

                                           {
         PYBIND11_OVERRIDE_PURE_NAME(
             double,            /* Return type */
             SampleHandlerBase, /* Parent class */
             "get_likelihood",  /* Python name*/
             GetLikelihood      /* Name of function in C++ (must match Python name) */
                                /* Argument(s) */
         );
     }

◆ GetMCHist()

TH1* PySampleHandlerBase::GetMCHist ( const int Sample )

inlineoverridevirtual

Get MC histogram.

Implements SampleHandlerBase.

Definition at line 117 of file samples.cpp.

                                               {
         PYBIND11_OVERRIDE_PURE(
             TH1*,                  /* Return type */
             SampleHandlerBase,     /* Parent class */
             GetMCHist,             /* Name of function in C++ (must match Python name) */
             Sample                 /* Argument(s) */
         );
     }

◆ GetName()

std::string PySampleHandlerBase::GetName ( ) const

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 16 of file samples.cpp.

                                        {
         PYBIND11_OVERRIDE_PURE(
             std::string,          /* Return type */
             SampleHandlerBase,    /* Parent class */
             GetName, /* Name of function in C++ (must match Python name) */
         );
     }

◆ GetNDim()

int PySampleHandlerBase::GetNDim ( const int Sample ) const

inlineoverridevirtual

DB Function to differentiate 1D or 2D binning.

Implements SampleHandlerBase.

Definition at line 229 of file samples.cpp.

                                                  {
         PYBIND11_OVERRIDE_PURE(
             int,                      /* Return type */
             SampleHandlerBase,        /* Parent class */
             GetNDim,                  /* Name of function in C++ */
             Sample
         );
     }

◆ GetNOscChannels()

int PySampleHandlerBase::GetNOscChannels ( const int iSample ) const

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 35 of file samples.cpp.

                                                           {
         PYBIND11_OVERRIDE_PURE(
             int,                  /* Return type */
             SampleHandlerBase,    /* Parent class */
             GetNOscChannels,      /* Name of function in C++ (must match Python name) */
             iSample               /* Argument(s) */
         );
     }

◆ GetSampleLikelihood()

double PySampleHandlerBase::GetSampleLikelihood ( const int iSample ) const

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 56 of file samples.cpp.

                                                                  {
         PYBIND11_OVERRIDE_PURE_NAME(
             double,                /* Return type */
             SampleHandlerBase,     /* Parent class */
             "get_sample_likelihood",
             GetSampleLikelihood,   /* Name of function in C++ (must match Python name) */
             iSample                /* Argument(s) */
         );
     }

◆ GetSampleTitle()

std::string PySampleHandlerBase::GetSampleTitle ( const int iSample ) const

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 25 of file samples.cpp.

                                                                {
         PYBIND11_OVERRIDE_PURE(
             std::string,          /* Return type */
             SampleHandlerBase,    /* Parent class */
             GetSampleTitle,       /* Name of function in C++ (must match Python name) */
             iSample               /* Argument(s) */
         );
     }

◆ GetW2Hist()

TH1* PySampleHandlerBase::GetW2Hist ( const int Sample )

inlineoverridevirtual

Get W2 histogram.

Implements SampleHandlerBase.

Definition at line 126 of file samples.cpp.

                                               {
         PYBIND11_OVERRIDE_PURE(
             TH1*,                  /* Return type */
             SampleHandlerBase,     /* Parent class */
             GetW2Hist,             /* Name of function in C++ (must match Python name) */
             Sample                 /* Argument(s) */
         );
     }

◆ PrintRates()

void PySampleHandlerBase::PrintRates ( const bool DataOnly = false )

inlineoverridevirtual

Helper function to print rates for the samples with LLH.

Parameters

DataOnly whether to print data only rates

Implements SampleHandlerBase.

Definition at line 77 of file samples.cpp.

                                                            {
         PYBIND11_OVERRIDE_PURE(
             void,                 /* Return type */
             SampleHandlerBase,    /* Parent class */
             PrintRates,           /* Name of function in C++ (must match Python name) */
             DataOnly              /* Argument(s) */
         );
     }

◆ ReturnKinematicParameterBinning()

std::vector<double> PySampleHandlerBase::ReturnKinematicParameterBinning	(	const int	Sample,
		const std::string &	KinematicParameter
	)		const

inlineoverridevirtual

Return the binning used to draw a kinematic parameter.

Implements SampleHandlerBase.

Definition at line 98 of file samples.cpp.

                                                                                                                              {
         PYBIND11_OVERRIDE_PURE(
             std::vector<double>,  /* Return type */
             SampleHandlerBase,    /* Parent class */
             GetKinVarName,        /* Name of function in C++ (must match Python name) */
             Sample,               /* Argument(s) */
             KinematicParameter    /* Argument(s) */
         );
     }

◆ Reweight()

void PySampleHandlerBase::Reweight ( )

inlineoverridevirtual

Implements SampleHandlerBase.

Definition at line 45 of file samples.cpp.

                              {
         PYBIND11_OVERRIDE_PURE_NAME(
             void,              /* Return type */
             SampleHandlerBase, /* Parent class */
             "reweight",
             Reweight           /* Name of function in C++ (must match Python name) */
         );
     }

◆ SampleHandlerBase()

SampleHandlerBase::SampleHandlerBase

The main constructor.

Definition at line 30 of file SampleHandlerBase.cpp.

                                      {
 // ***************************************************************************
   nEvents = 0;
   nSamples = 0;
 }

The documentation for this class was generated from the following file:

python/samples.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CleanMemoryBeforeFit()

◆ Get1DVarHist()

◆ Get1DVarHistByModeAndChannel()

◆ Get2DVarHist()

◆ Get2DVarHistByModeAndChannel()

◆ GetDataHist()

◆ GetFlavourName()

◆ GetKinVarName()

◆ GetLikelihood()

◆ GetMCHist()

◆ GetName()

◆ GetNDim()

◆ GetNOscChannels()

◆ GetSampleLikelihood()

◆ GetSampleTitle()

◆ GetW2Hist()

◆ PrintRates()

◆ ReturnKinematicParameterBinning()

◆ Reweight()

◆ SampleHandlerBase()