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
	Get name for Sample Handler. More...

std::string	GetSampleTitle (const int iSample) const override
	Get fancy title for specified samples. More...

int	GetNOscChannels (const int iSample) const override
	Get number of oscillation channels for a single sample. More...

void	Reweight () override
	main routine modifying MC prediction based on proposed parameter values More...

double	GetSampleLikelihood (const int iSample) const override
	Get likelihood (-logL) for a single sample. More...

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
	Return likelihood (-logL) for all samples. More...

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
	Build a 1D histogram for a given variable, optionally filtered by mode and channel. More...

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
	Build a 2D histogram for given variables, optionally filtered by mode and channel. More...

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
	Return 1D projection of MC into given 1D variable (doesn't have to be variable used in the fit) More...

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
	Build a 2D projection of MC events into specified variables. More...

int	GetNDim (const int Sample) const override
	DB Get what dimensionality binning for given sample has. More...

std::string	GetFlavourName (const int iSample, const int iChannel) const override
	Get the flavour name for a given sample and oscillation channel. More...

	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 ()
	returns total number of samples More...

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

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

unsigned int	GetNEvents () const
	Return total number of events. More...

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 20 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 77 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

Return 1D projection of MC into given 1D variable (doesn't have to be variable used in the fit)

Parameters

iSample	Index of the sample.
ProjectionVar	name of variable
EventSelectionVec	Vector of additional cuts like cut on interaction mode
WeightStyle	Alow to modify weight for example if equal to 1 all weights are set to 1
SubEventSelectionVec	Vector of additional cuts for sub event (particle, ring etc.)

Implements SampleHandlerInterface.

Definition at line 183 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

Build a 1D histogram for a given variable, optionally filtered by mode and channel.

Parameters

iSample	Index of the sample.
ProjectionVar_Str	Name of the variable to project onto.
kModeToFill	Interaction mode to select (-1 means all modes).
kChannelToFill	Oscillation channel to select (-1 means all channels).
WeightStyle	Weighting scheme (e.g. 0 = nominal weights, 1 = unit weights).

Implements SampleHandlerInterface.

Definition at line 155 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

Build a 2D projection of MC events into specified variables.

Parameters

iSample	Index of the sample.
ProjectionVarX	Name of the variable for the X axis.
ProjectionVarY	Name of the variable for the Y axis.
EventSelectionVec	Vector of event-level selection cuts.
WeightStyle	Weighting scheme (e.g. 0 = nominal weights, 1 = unit weights).
SubEventSelectionVec	Vector of sub-event selection cuts.

Implements SampleHandlerInterface.

Definition at line 196 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

Build a 2D histogram for given variables, optionally filtered by mode and channel.

Parameters

iSample	Index of the sample.
ProjectionVar_StrX	Name of the variable for the X axis.
ProjectionVar_StrY	Name of the variable for the Y axis.
kModeToFill	Interaction mode to select (-1 means all modes).
kChannelToFill	Oscillation channel to select (-1 means all channels).
WeightStyle	Weighting scheme (e.g. 0 = nominal weights, 1 = unit weights).

Implements SampleHandlerInterface.

Definition at line 168 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.

Parameters

Sample Sample enumerator

Implements SampleHandlerInterface.

Definition at line 118 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

Get the flavour name for a given sample and oscillation channel.

Parameters

iSample	Index of the sample.
iChannel	Index of the oscillation channel within the sample.

Implements SampleHandlerInterface.

Definition at line 220 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 97 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

Return likelihood (-logL) for all samples.

Implements SampleHandlerInterface.

Definition at line 145 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.

Parameters

Sample Sample enumerator

Implements SampleHandlerInterface.

Definition at line 127 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

Get name for Sample Handler.

Implements SampleHandlerInterface.

Definition at line 26 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 Get what dimensionality binning for given sample has.

Parameters

Sample Number of sample

Implements SampleHandlerInterface.

Definition at line 211 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

Get number of oscillation channels for a single sample.

Parameters

iSample Sample enumerator

Implements SampleHandlerInterface.

Definition at line 45 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

Get likelihood (-logL) for a single sample.

Parameters

iSample Sample enumerator

Implements SampleHandlerInterface.

Definition at line 66 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

Get fancy title for specified samples.

Parameters

iSample Sample enumerator

Implements SampleHandlerInterface.

Definition at line 35 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.

Parameters

Sample Sample enumerator

Implements SampleHandlerInterface.

Definition at line 136 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 87 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.

Parameters

iSample	Index of the sample.
KinematicParameter	name of variable

Implements SampleHandlerInterface.

Definition at line 108 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

main routine modifying MC prediction based on proposed parameter values

Implements SampleHandlerInterface.

Definition at line 55 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 38 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()