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

#include <python/samples.h>

Inheritance diagram for PySampleHandlerInterface:

[legend]

Collaboration diagram for PySampleHandlerInterface:

[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

std::unique_ptr< TH1 >	Get1DVarHistByModeAndChannel (const int iSample, const std::string &ProjectionVar_Str, const int kModeToFill=-1, const int kChannelToFill=-1, const int WeightStyle=0) override

std::unique_ptr< TH2 >	Get2DVarHistByModeAndChannel (const int iSample, const std::string &ProjectionVar_StrX, const std::string &ProjectionVar_StrY, const int kModeToFill=-1, const int kChannelToFill=-1, const int WeightStyle=0) override

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

std::unique_ptr< TH2 >	Get2DVarHist (const int iSample, const std::string &ProjectionVarX, const std::string &ProjectionVarY, const std::vector< KinematicCut > &EventSelectionVec={}, const int WeightStyle=0, 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

	SampleHandlerInterface ()
	The main constructor. More...

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

virtual	~SampleHandlerInterface ()
	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 SampleHandlerInterface
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 SampleHandlerInterface
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 100 of file samples.h.

Member Function Documentation

◆ CleanMemoryBeforeFit()

void PySampleHandlerInterface::CleanMemoryBeforeFit ( )

inlineoverridevirtual

Allow to clean not used memory before fit starts.

Implements SampleHandlerInterface.

Definition at line 157 of file samples.h.

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

◆ Get1DVarHist()

std::unique_ptr<TH1> PySampleHandlerInterface::Get1DVarHist	(	const int	iSample,
		const std::string &	ProjectionVar,
		const std::vector< KinematicCut > &	EventSelectionVec = `{}`,
		const int	WeightStyle = `0`,
		const std::vector< KinematicCut > &	SubEventSelectionVec = `{}`
	)

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 263 of file samples.h.

                                                                                          {},
                                       const int WeightStyle = 0,
                                       const std::vector<KinematicCut> &SubEventSelectionVec = {}) override {
       (void) iSample;
       (void) ProjectionVar;
       (void) EventSelectionVec;
       (void) WeightStyle;
       (void) SubEventSelectionVec;
       return nullptr;
     }

◆ Get1DVarHistByModeAndChannel()

std::unique_ptr<TH1> PySampleHandlerInterface::Get1DVarHistByModeAndChannel	(	const int	iSample,
		const std::string &	ProjectionVar_Str,
		const int	kModeToFill = `-1`,
		const int	kChannelToFill = `-1`,
		const int	WeightStyle = `0`
	)

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 235 of file samples.h.

                                                                                           {
         (void) iSample;
         (void) ProjectionVar_Str;
         (void) kModeToFill;
         (void) kChannelToFill;
         (void) WeightStyle;
         return nullptr;
     }

◆ Get2DVarHist()

std::unique_ptr<TH2> PySampleHandlerInterface::Get2DVarHist	(	const int	iSample,
		const std::string &	ProjectionVarX,
		const std::string &	ProjectionVarY,
		const std::vector< KinematicCut > &	EventSelectionVec = `{}`,
		const int	WeightStyle = `0`,
		const std::vector< KinematicCut > &	SubEventSelectionVec = `{}`
	)

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 276 of file samples.h.

                                                                                          {},
                                       const int WeightStyle = 0,
                                       const std::vector<KinematicCut>& SubEventSelectionVec = {}) override {
       (void) iSample;
       (void) ProjectionVarX;
       (void) ProjectionVarY;
       (void) EventSelectionVec;
       (void) WeightStyle;
       (void) SubEventSelectionVec;
       return nullptr;
     }

◆ Get2DVarHistByModeAndChannel()

std::unique_ptr<TH2> PySampleHandlerInterface::Get2DVarHistByModeAndChannel	(	const int	iSample,
		const std::string &	ProjectionVar_StrX,
		const std::string &	ProjectionVar_StrY,
		const int	kModeToFill = `-1`,
		const int	kChannelToFill = `-1`,
		const int	WeightStyle = `0`
	)

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 248 of file samples.h.

                                                                                           {
       (void) iSample;
       (void) ProjectionVar_StrX;
       (void) ProjectionVar_StrY;
       (void) kModeToFill;
       (void) kChannelToFill;
       (void) WeightStyle;
       return nullptr;
     }

◆ GetDataHist()

TH1* PySampleHandlerInterface::GetDataHist ( const int Sample )

inlineoverridevirtual

Get Data histogram.

Implements SampleHandlerInterface.

Definition at line 198 of file samples.h.

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

◆ GetFlavourName()

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

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 300 of file samples.h.

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

◆ GetKinVarName()

std::string PySampleHandlerInterface::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 SampleHandlerInterface.

Definition at line 177 of file samples.h.

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

◆ GetLikelihood()

double PySampleHandlerInterface::GetLikelihood ( ) const

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 225 of file samples.h.

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

◆ GetMCHist()

TH1* PySampleHandlerInterface::GetMCHist ( const int Sample )

inlineoverridevirtual

Get MC histogram.

Implements SampleHandlerInterface.

Definition at line 207 of file samples.h.

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

◆ GetName()

std::string PySampleHandlerInterface::GetName ( ) const

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 106 of file samples.h.

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

◆ GetNDim()

int PySampleHandlerInterface::GetNDim ( const int Sample ) const

inlineoverridevirtual

DB Function to differentiate 1D or 2D binning.

Implements SampleHandlerInterface.

Definition at line 291 of file samples.h.

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

◆ GetNOscChannels()

int PySampleHandlerInterface::GetNOscChannels ( const int iSample ) const

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 125 of file samples.h.

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

◆ GetSampleLikelihood()

double PySampleHandlerInterface::GetSampleLikelihood ( const int iSample ) const

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 146 of file samples.h.

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

◆ GetSampleTitle()

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

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 115 of file samples.h.

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

◆ GetW2Hist()

TH1* PySampleHandlerInterface::GetW2Hist ( const int Sample )

inlineoverridevirtual

Get W2 histogram.

Implements SampleHandlerInterface.

Definition at line 216 of file samples.h.

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

◆ PrintRates()

void PySampleHandlerInterface::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 SampleHandlerInterface.

Definition at line 167 of file samples.h.

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

◆ ReturnKinematicParameterBinning()

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

inlineoverridevirtual

Return the binning used to draw a kinematic parameter.

Implements SampleHandlerInterface.

Definition at line 188 of file samples.h.

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

◆ Reweight()

void PySampleHandlerInterface::Reweight ( )

inlineoverridevirtual

Implements SampleHandlerInterface.

Definition at line 135 of file samples.h.

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

◆ SampleHandlerInterface()

SampleHandlerInterface::SampleHandlerInterface

The main constructor.

Definition at line 33 of file SampleHandlerInterface.cpp.

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

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

python/samples.h

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()

◆ SampleHandlerInterface()