This module dumps a tree and a set of histograms of ECL PID-related info used for validation, starting from an input file w/ particle-gun-generated charged stable particles (and antiparticles). More...

#include <ECLChargedPIDDataAnalysisValidationModule.h>

Inheritance diagram for ECLChargedPIDDataAnalysisValidationModule:

[legend]

Collaboration diagram for ECLChargedPIDDataAnalysisValidationModule:

[legend]

Public Types
enum	EModulePropFlags { c_Input = 1 , c_Output = 2 , c_ParallelProcessingCertified = 4 , c_HistogramManager = 8 , c_InternalSerializer = 16 , c_TerminateInAllProcesses = 32 , c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...

typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	ECLChargedPIDDataAnalysisValidationModule ()
	Constructor of the module.

virtual	~ECLChargedPIDDataAnalysisValidationModule ()
	Destructor of the module.

virtual void	initialize () override
	Initializes the module.

virtual void	beginRun () override
	Called once before a new run begins.

virtual void	event () override
	Called once for each event.

virtual void	endRun () override
	Called once when a run ends.

virtual void	terminate () override
	Termination action.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules. More...

const std::string &	getName () const
	Returns the name of the module. More...

const std::string &	getType () const
	Returns the type of the module (i.e. More...

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module. More...

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties. More...

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level. More...

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module. More...

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module. More...

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module. More...

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true. More...

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More...

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished. More...

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module. More...

bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter. More...

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module. More...

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module. More...

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters. More...

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python. More...

virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side. More...

virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

void	setDescription (const std::string &description)
	Sets the description of the module. More...

void	setType (const std::string &type)
	Set the module type. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module. More...

void	setReturnValue (int value)
	Sets the return value for this module as integer. More...

void	setReturnValue (bool value)
	Sets the return value for this module as bool. More...

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
void	dumpPIDVars (TTree *sampleTree, const Const::ChargedStable &sigHypo, const int sigCharge, const Const::ChargedStable &bkgHypo, bool mergeSigCharge=false)
	Dump PID vars.

void	dumpPIDEfficiencyFakeRate (TTree *sampleTree, const Const::ChargedStable &sampleHypo, const int sampleCharge, const Const::ChargedStable &sigHypo, bool mergeSampleCharge=false)
	Dump PID efficiency / fake rate vs clusterTheta, clusterPhi, p... More...

void	dumpTrkClusMatchingEfficiency (TTree *sampleTree, const Const::ChargedStable &sampleHypo, const int sampleCharge, bool mergeSampleCharge=false)
	Dump track-to-ECL-cluster matching efficiency vs clusterTheta, clusterPhi, pt.... More...

bool	isValidChargedPdg (const int pdg) const
	Check if the input pdgId is that of a valid charged stable particle.

void	paintUnderOverflow (TH1F *h)
	Draw u/oflow content on top of first/last visible bin.

std::list< ModulePtr >	getModules () const override
	no submodules, return empty list

std::string	getPathString () const override
	return the module name.

void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects. More...

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary. More...

Private Attributes
std::vector< int >	m_inputPdgIdList
	The pdgId list of the charged stable particles of interest. More...

std::vector< unsigned int >	m_mergeChargeOfPdgIds
	The (unsigned) pdgId list of the charged stable particles for which particle and antiparticle should be merged together in the plots. More...

std::map< Const::ChargedStable, bool >	m_mergeChargeFlagByHypo
	A map to tell for each charged stable particle hypothesis whether particle and antiparticle should be merged together in the plots.

std::set< int >	m_inputPdgIdSet
	The pdgId set of the charged stable particles of interest. More...

std::vector< TFile * >	m_outputFile = std::vector<TFile*>(c_chargedStableHypos)
	Output `ROOT::TFile` that contains the info to plot. More...

std::string	m_outputFileName
	Base name of the output `ROOT::TFile`. More...

bool	m_saveValidationTree
	Save the `TTree` in the output file alongside the histograms. More...

std::vector< TTree * >	m_tree = std::vector<TTree*>(c_chargedStableHypos)
	A `ROOT::TTree` filled with the info to make control plots. More...

std::vector< float >	m_p = std::vector<float>(c_chargedStableHypos)
	Track momentum in [GeV/c]. More...

std::vector< float >	m_pt = std::vector<float>(c_chargedStableHypos)
	Track transverse momentum in [GeV/c]. More...

std::vector< float >	m_trkTheta = std::vector<float>(c_chargedStableHypos)
	Track polar angle in [rad]. More...

std::vector< float >	m_trkPhi = std::vector<float>(c_chargedStableHypos)
	Track azimuthal angle in [rad]. More...

std::vector< float >	m_clusterTheta = std::vector<float>(c_chargedStableHypos)
	Cluster polar angle in [rad]. More...

std::vector< float >	m_clusterReg = std::vector<float>(c_chargedStableHypos)
	Cluster ECL region. More...

std::vector< float >	m_clusterPhi = std::vector<float>(c_chargedStableHypos)
	Cluster azimuthal angle in [rad]. More...

std::vector< float >	m_trackClusterMatch = std::vector<float>(c_chargedStableHypos)
	Flag for track-cluster matching condition. More...

std::vector< float >	m_logl_sig = std::vector<float>(c_chargedStableHypos)
	Log-likelihood for the "signal" particle hypothesis. More...

std::vector< float >	m_logl_bkg = std::vector<float>(c_chargedStableHypos)
	Log-likelihood for the "background" particle hypothesis. More...

std::vector< float >	m_deltalogl_sig_bkg = std::vector<float>(c_chargedStableHypos)
	Delta Log-likelihood "signal" vs. More...

std::vector< std::vector< float > >	m_pids_glob
	List of global PIDs, defined by the likelihood ratio: More...

std::vector< float >	m_p_binedges = {0.0, 0.5, 0.75, 1.0, 3.0, 5.0}
	Binning w/ variable bin size for track momentum (in [GeV/c]). More...

std::vector< float >	m_th_binedges = {0.0, 0.2164208, 0.385, 0.561996, 1.13, 1.57, 1.88, 2.2462387, 2.47, 2.7070057, 3.1415926}
	Binning w/ variable bin size for track polar angle (in [rad]). More...

StoreArray< MCParticle >	m_MCParticles
	MCParticles.

std::string	m_name
	The name of the module, saved as a string (user-modifiable)

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Static Private Attributes
static constexpr float	c_PID = 0.5
	Definition of the PID cut threshold to compute the efficiency. More...

static constexpr unsigned int	c_chargedStableHypos = 2 * Const::ChargedStable::c_SetSize
	The maximal number of charged stable particle hypotheses. More...

Detailed Description

This module dumps a tree and a set of histograms of ECL PID-related info used for validation, starting from an input file w/ particle-gun-generated charged stable particles (and antiparticles).

Definition at line 36 of file ECLChargedPIDDataAnalysisValidationModule.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags

inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input	This module is an input module (reads data).
c_Output	This module is an output module (writes data).
c_ParallelProcessingCertified	This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
c_HistogramManager	This module is used to manage histograms accumulated by other modules.
c_InternalSerializer	This module is an internal serializer/deserializer for parallel processing.
c_TerminateInAllProcesses	When using parallel processing, call this module's terminate() function in all processes(). This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
c_DontCollectStatistics	No statistics is collected for this module.

Definition at line 77 of file Module.h.

Member Function Documentation

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ dumpPIDEfficiencyFakeRate()

void dumpPIDEfficiencyFakeRate	(	TTree *	sampleTree,
		const Const::ChargedStable &	sampleHypo,
		const int	sampleCharge,
		const Const::ChargedStable &	sigHypo,
		bool	mergeSampleCharge = `false`
	)

private

Dump PID efficiency / fake rate vs clusterTheta, clusterPhi, p...

for a fixed cut on PID as previously initialised.

Parameters

[in]	sampleTree	the `TTree` of the charged particle under consideration.
[in]	sampleHypo	the `Const::ChargedStable` hypothesis corresponding to the charged particle under consideration.
[in]	sampleCharge	the charge (+/- 1) of the charged particle under consideration.
[in]	sigHypo	the `Const::ChargedStable` "signal" hypothesis to test.
[in]	mergeSampleCharge	if true, will specify in the plot legend that we are looking at a sample made of +/- charges.

If sampleHypo == sigHypo, will be measuring an efficiency, otherwise a fake rate.

Definition at line 421 of file ECLChargedPIDDataAnalysisValidationModule.cc.

 {
  
   // The ratio type: EFFICIENCY || FAKE RATE
   const std::string ratioType = (sampleHypo == sigHypo) ? "Efficiency" : "FakeRate";
  
   // Get the *signed* pdgId of the input sample particle.
   const int sampleHypoPdgId = sampleHypo.getPDGCode() * sampleCharge;
  
   // Get the idx and pdgId of the "signal" hypothesis to test.
   const auto sigHypoIdx = sigHypo.getIndex();
   const auto sigHypoPdgId = sigHypo.getPDGCode();
  
   // Access the "signal" hypothesis's PID component in the sample's
   // TTree vector branch of global PID values via the idx.
   TString pidSigCut = TString::Format("pids_glob[%i] > %f", sigHypoIdx, c_PID);
  
   // Histograms of p, clusterReg, clusterPhi... for "pass" (N, numerator) and "all" (D, denominator) events.
   TString h_p_N_name = TString::Format("h_p_N_%i", sigHypoPdgId);
   TString h_p_D_name = TString::Format("h_p_D_%i", sigHypoPdgId);
   TH1F* h_p_N = new TH1F(h_p_N_name.Data(), "h_p_N", 10, 0.0, 5.0);
   TH1F* h_p_D = new TH1F(h_p_D_name.Data(), "h_p_D", 10, 0.0, 5.0);
  
   TString h_th_N_name = TString::Format("h_th_N_%i", sigHypoPdgId);
   TString h_th_D_name = TString::Format("h_th_D_%i", sigHypoPdgId);
   TH1F* h_th_N = new TH1F(h_th_N_name.Data(), "h_th_N", m_th_binedges.size() - 1, m_th_binedges.data());
   TH1F* h_th_D = new TH1F(h_th_D_name.Data(), "h_th_D", m_th_binedges.size() - 1, m_th_binedges.data());
  
   TString h_eclreg_N_name = TString::Format("h_eclreg_N_%i", sigHypoPdgId);
   TString h_eclreg_D_name = TString::Format("h_eclreg_D_%i", sigHypoPdgId);
   TH1F* h_eclreg_N = new TH1F(h_eclreg_N_name.Data(), "h_eclreg_N", 5, -0.5, 4.5);
   TH1F* h_eclreg_D = new TH1F(h_eclreg_D_name.Data(), "h_eclreg_D", 5, -0.5, 4.5);
  
   TString h_phi_N_name = TString::Format("h_phi_N_%i", sigHypoPdgId);
   TString h_phi_D_name = TString::Format("h_phi_D_%i", sigHypoPdgId);
   TH1F* h_phi_N = new TH1F(h_phi_N_name.Data(), "h_phi_N", 5, -3.14159, 3.14159);
   TH1F* h_phi_D = new TH1F(h_phi_D_name.Data(), "h_phi_D", 5, -3.14159, 3.14159);
  
   // Fill the histograms from the sample's TTree.
  
   sampleTree->Project(h_p_N_name.Data(), "p", pidSigCut.Data());
   sampleTree->Project(h_p_D_name.Data(), "p");
  
   sampleTree->Project(h_th_N_name.Data(), "clusterTheta", pidSigCut.Data());
   sampleTree->Project(h_th_D_name.Data(), "clusterTheta");
  
   sampleTree->Project(h_eclreg_N_name.Data(), "clusterReg", pidSigCut.Data());
   sampleTree->Project(h_eclreg_D_name.Data(), "clusterReg");
   paintUnderOverflow(h_eclreg_N);
   paintUnderOverflow(h_eclreg_D);
  
   sampleTree->Project(h_phi_N_name.Data(), "clusterPhi", pidSigCut.Data());
   sampleTree->Project(h_phi_D_name.Data(), "clusterPhi");
  
   // Compute the efficiency/fake rate.
  
   TString pid_glob_ratio_p_name = TString::Format("pid_glob_%i_%s__VS_p", sigHypoPdgId, ratioType.c_str());
   TString pid_glob_ratio_th_name = TString::Format("pid_glob_%i_%s__VS_th", sigHypoPdgId, ratioType.c_str());
   TString pid_glob_ratio_eclreg_name = TString::Format("pid_glob_%i_%s__VS_eclreg", sigHypoPdgId, ratioType.c_str());
   TString pid_glob_ratio_phi_name = TString::Format("pid_glob_%i_%s__VS_phi", sigHypoPdgId, ratioType.c_str());
  
   // MetaOptions string.
   std::string metaopts("pvalue-warn=0.01,pvalue-error=0.001,nostats");
   std::string shifteropt("");
   // Electron plots should be visible to the shifter by default.
   if (sampleHypo == Const::electron || sigHypo == Const::electron) {
     shifteropt = "shifter,";
   }
  
   auto pdgIdDesc = (!mergeSampleCharge) ? std::to_string(sampleHypoPdgId) : std::to_string(std::abs(
                      sampleHypoPdgId)) + " and -" + std::to_string(std::abs(sampleHypoPdgId));
  
   if (TEfficiency::CheckConsistency(*h_p_N, *h_p_D)) {
  
     TEfficiency* t_pid_glob_ratio_p = new TEfficiency(*h_p_N, *h_p_D);
     t_pid_glob_ratio_p->SetName(pid_glob_ratio_p_name.Data());
     t_pid_glob_ratio_p->SetTitle(TString::Format("%s;p [GeV/c];#varepsilon/f", pid_glob_ratio_p_name.Data()).Data());
  
     t_pid_glob_ratio_p->SetConfidenceLevel(0.683);
     t_pid_glob_ratio_p->SetStatisticOption(TEfficiency::kBUniform);
     t_pid_glob_ratio_p->SetPosteriorMode();
  
     t_pid_glob_ratio_p->GetListOfFunctions()->Add(new TNamed("Description",
                                                              TString::Format("Sample PDG = %s ; %s of ECL global PID(%i) > %.2f as a function of $p_{trk}$.",
                                                                  pdgIdDesc.c_str(),
                                                                  ratioType.c_str(),
                                                                  sigHypoPdgId,
                                                                  c_PID).Data()));
     t_pid_glob_ratio_p->GetListOfFunctions()->Add(new TNamed("Check",
                                                              "Shape should be consistent. Obviously, check for decreasing efficiency / increasing fake rate."));
     t_pid_glob_ratio_p->GetListOfFunctions()->Add(new TNamed("Contact", "Marco Milesi. marco.milesi@desy.de"));
     t_pid_glob_ratio_p->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
  
     t_pid_glob_ratio_p->Write();
  
     delete t_pid_glob_ratio_p;
  
   }
   if (TEfficiency::CheckConsistency(*h_th_N, *h_th_D)) {
  
     TEfficiency* t_pid_glob_ratio_th = new TEfficiency(*h_th_N, *h_th_D);
     t_pid_glob_ratio_th->SetName(pid_glob_ratio_th_name.Data());
     t_pid_glob_ratio_th->SetTitle(TString::Format("%s;#theta_{cluster} [rad];#varepsilon/f", pid_glob_ratio_th_name.Data()).Data());
  
     t_pid_glob_ratio_th->SetConfidenceLevel(0.683);
     t_pid_glob_ratio_th->SetStatisticOption(TEfficiency::kBUniform);
     t_pid_glob_ratio_th->SetPosteriorMode();
  
     t_pid_glob_ratio_th->GetListOfFunctions()->Add(new TNamed("Description",
                                                               TString::Format("Sample PDG = %s ; %s of ECL global PID(%i) > %.2f as a function of $\\theta_{cluster}$.",
                                                                   pdgIdDesc.c_str(),
                                                                   ratioType.c_str(),
                                                                   sigHypoPdgId,
                                                                   c_PID).Data()));
     t_pid_glob_ratio_th->GetListOfFunctions()->Add(new TNamed("Check",
                                                               "Shape should be consistent. Obviously, check for decreasing efficiency / increasing fake rate."));
     t_pid_glob_ratio_th->GetListOfFunctions()->Add(new TNamed("Contact", "Marco Milesi. marco.milesi@desy.de"));
     t_pid_glob_ratio_th->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
  
     t_pid_glob_ratio_th->Write();
  
     delete t_pid_glob_ratio_th;
   }
   if (TEfficiency::CheckConsistency(*h_eclreg_N, *h_eclreg_D)) {
  
     TEfficiency* t_pid_glob_ratio_eclreg = new TEfficiency(*h_eclreg_N, *h_eclreg_D);
     t_pid_glob_ratio_eclreg->SetName(pid_glob_ratio_eclreg_name.Data());
     t_pid_glob_ratio_eclreg->SetTitle(TString::Format("%s;ECL Region;#varepsilon/f", pid_glob_ratio_eclreg_name.Data()).Data());
  
     t_pid_glob_ratio_eclreg->SetConfidenceLevel(0.683);
     t_pid_glob_ratio_eclreg->SetStatisticOption(TEfficiency::kBUniform);
     t_pid_glob_ratio_eclreg->SetPosteriorMode();
  
     t_pid_glob_ratio_eclreg->GetListOfFunctions()->Add(new TNamed("Description",
                                                        TString::Format("Sample PDG = %s ; %s of ECL global PID(%i) > %.2f as a function of ECL cluster region ($\\theta_{cluster}$). Regions are labelled: 0 (outside ECL acceptance), 1 (ECL FWD), 2 (ECL Barrel), 3 (ECL BWD), 4 (ECL FWD/BWD gaps).",
                                                            pdgIdDesc.c_str(),
                                                            ratioType.c_str(),
                                                            sigHypoPdgId,
                                                            c_PID).Data()));
     t_pid_glob_ratio_eclreg->GetListOfFunctions()->Add(new TNamed("Check",
                                                        "Shape should be consistent. Obviously, check for decreasing efficiency / increasing fake rate."));
     t_pid_glob_ratio_eclreg->GetListOfFunctions()->Add(new TNamed("Contact", "Marco Milesi. marco.milesi@desy.de"));
     t_pid_glob_ratio_eclreg->GetListOfFunctions()->Add(new TNamed("MetaOptions", metaopts.c_str()));
  
     t_pid_glob_ratio_eclreg->Write();
  
     delete t_pid_glob_ratio_eclreg;
  
   }
   if (TEfficiency::CheckConsistency(*h_phi_N, *h_phi_D)) {
  
     TEfficiency* t_pid_glob_ratio_phi = new TEfficiency(*h_phi_N, *h_phi_D);
     t_pid_glob_ratio_phi->SetName(pid_glob_ratio_phi_name.Data());
     t_pid_glob_ratio_phi->SetTitle(TString::Format("%s;#phi_{cluster} [rad];#varepsilon/f", pid_glob_ratio_phi_name.Data()).Data());
  
     t_pid_glob_ratio_phi->SetConfidenceLevel(0.683);
     t_pid_glob_ratio_phi->SetStatisticOption(TEfficiency::kBUniform);
     t_pid_glob_ratio_phi->SetPosteriorMode();
  
     t_pid_glob_ratio_phi->GetListOfFunctions()->Add(new TNamed("Description",
                                                                TString::Format("Sample PDG = %s ; %s of ECL global PID(%i) > %.2f as a function of $\\phi_{cluster}$.",
                                                                    pdgIdDesc.c_str(),
                                                                    ratioType.c_str(),
                                                                    sigHypoPdgId,
                                                                    c_PID).Data()));
     t_pid_glob_ratio_phi->GetListOfFunctions()->Add(new TNamed("Check",
                                                                "Shape should be consistent. Obviously, check for decreasing efficiency / increasing fake rate."));
     t_pid_glob_ratio_phi->GetListOfFunctions()->Add(new TNamed("Contact", "Marco Milesi. marco.milesi@desy.de"));
     t_pid_glob_ratio_phi->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
  
     t_pid_glob_ratio_phi->Write();
  
     delete t_pid_glob_ratio_phi;
   }
  
   delete h_p_N;
   delete h_p_D;
   delete h_th_N;
   delete h_th_D;
   delete h_eclreg_N;
   delete h_eclreg_D;
   delete h_phi_N;
   delete h_phi_D;
  
 }

◆ dumpTrkClusMatchingEfficiency()

void dumpTrkClusMatchingEfficiency	(	TTree *	sampleTree,
		const Const::ChargedStable &	sampleHypo,
		const int	sampleCharge,
		bool	mergeSampleCharge = `false`
	)

private

Dump track-to-ECL-cluster matching efficiency vs clusterTheta, clusterPhi, pt....

Parameters

[in]	sampleTree	the `TTree` of the charged particle under consideration.
[in]	sampleHypo	the `Const::ChargedStable` hypothesis corresponding to the charged particle under consideration.
[in]	sampleCharge	the charge of the charged particle under consideration.
[in]	mergeSampleCharge	if true, will specify in the plot legend that we are looking at a sample made of +/- charges.

Definition at line 609 of file ECLChargedPIDDataAnalysisValidationModule.cc.

◆ evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns: True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

Definition at line 113 of file Module.cc.

◆ getFileNames()

virtual std::vector<std::string> getFileNames ( bool outputFiles )

inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const

inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns: A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

Returns true if all specified property flags are available in this module.

Parameters

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

◆ if_false()

void if_false	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is false.
afterConditionPath	What to do after executing 'path'.

Definition at line 85 of file Module.cc.

◆ if_true()

void if_true	(	const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters

path	Shared pointer to the Path which will be executed if the return value is true.
afterConditionPath	What to do after executing 'path'.

Definition at line 90 of file Module.cc.

◆ if_value()

void if_value	(	const std::string &	expression,
		const std::shared_ptr< Path > &	path,
		EAfterConditionPath	afterConditionPath = `EAfterConditionPath::c_End`
	)

inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

logLevel	The log level (one of LogConfig::ELogLevel)
logInfo	What kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

Note: The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

◆ setParamPython()

void setParamPython	(	const std::string &	name,
		const boost::python::object &	pyObj
	)

privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters

name	The unique name of the parameter.
pyObj	The object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict & dictionary )

privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

◆ setType()

void setType ( const std::string & type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

Member Data Documentation

◆ c_chargedStableHypos

constexpr unsigned int c_chargedStableHypos = 2 * Const::ChargedStable::c_SetSize

staticconstexprprivate

The maximal number of charged stable particle hypotheses.

This includes particles and antiparticles.

Definition at line 87 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ c_PID

constexpr float c_PID = 0.5

staticconstexprprivate

Definition of the PID cut threshold to compute the efficiency.

The chosen value is arbitrary.

Definition at line 81 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_clusterPhi

std::vector<float> m_clusterPhi = std::vector<float>(c_chargedStableHypos)

private

Cluster azimuthal angle in [rad].

Use the most energetic ECL cluster associated to the MC-matched reconstructed track w/ highest momentum. A NaN value is stored if no matching is found.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 202 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_clusterReg

std::vector<float> m_clusterReg = std::vector<float>(c_chargedStableHypos)

private

Cluster ECL region.

Use the most energetic ECL cluster associated to the MC-matched reconstructed track w/ highest momentum. A NaN value is stored if no matching is found.

Book one int for each charged stable particle (and antiparticle) candidate.

Definition at line 192 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_clusterTheta

std::vector<float> m_clusterTheta = std::vector<float>(c_chargedStableHypos)

private

Cluster polar angle in [rad].

Use the most energetic ECL cluster associated to the MC-matched reconstructed track w/ highest momentum. A NaN value is stored if no matching is found.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 182 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_deltalogl_sig_bkg

std::vector<float> m_deltalogl_sig_bkg = std::vector<float>(c_chargedStableHypos)

private

Delta Log-likelihood "signal" vs.

"background".

$\Delta log(\mathcal{L}) = log(\mathcal{L}_{bkg}) - log(\mathcal{L}_{sig}).$

Here, "signal" refers to the charged stable particle under exam. The "background" hypothesis is defined according to the charged stable particle under exam:

chargedStableBkg = (chargedStable != Const::pion) ? Const::pion : Const::kaon.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 245 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_inputPdgIdList

std::vector<int> m_inputPdgIdList

private

The pdgId list of the charged stable particles of interest.

This is a configurable parameter.

Definition at line 93 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_inputPdgIdSet

std::set<int> m_inputPdgIdSet

private

The pdgId set of the charged stable particles of interest.

Using std::set ensures its elements are unique.

Definition at line 110 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_logl_bkg

std::vector<float> m_logl_bkg = std::vector<float>(c_chargedStableHypos)

private

Log-likelihood for the "background" particle hypothesis.

The "background" hypothesis is defined according to the charged stable particle under exam:

chargedStableBkg = (chargedStable != Const::pion) ? Const::pion : Const::kaon.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 229 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_logl_sig

std::vector<float> m_logl_sig = std::vector<float>(c_chargedStableHypos)

private

Log-likelihood for the "signal" particle hypothesis.

Here, "signal" refers to the charged stable particle under exam.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 218 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_mergeChargeOfPdgIds

std::vector<unsigned int> m_mergeChargeOfPdgIds

private

The (unsigned) pdgId list of the charged stable particles for which particle and antiparticle should be merged together in the plots.

This is a configurable parameter.

Definition at line 99 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_outputFile

std::vector<TFile*> m_outputFile = std::vector<TFile*>(c_chargedStableHypos)

private

Output ROOT::TFile that contains the info to plot.

Book one TFile for each charged stable particle (and antiparticle) candidate.

Definition at line 117 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_outputFileName

std::string m_outputFileName

private

Base name of the output ROOT::TFile.

This is a configurable parameter.

Definition at line 123 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_p

std::vector<float> m_p = std::vector<float>(c_chargedStableHypos)

private

Track momentum in [GeV/c].

Use the MC-matched reconstructed track w/ highest momentum.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 145 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_p_binedges

std::vector<float> m_p_binedges = {0.0, 0.5, 0.75, 1.0, 3.0, 5.0}

private

Binning w/ variable bin size for track momentum (in [GeV/c]).

It should match the binning used for parametrisation of the PID likelihood.

Definition at line 265 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_pids_glob

std::vector<std::vector<float> > m_pids_glob

private

Initial value:

= std::vector<std::vector<float>>(c_chargedStableHypos,

std::vector<float>(Const::ChargedStable::c_SetSize))

Belle2::Const::ChargedStable::c_SetSize

static const unsigned int c_SetSize

Number of elements (for use in array bounds etc.)

Definition: Const.h:606

Belle2::ECLChargedPIDDataAnalysisValidationModule::c_chargedStableHypos

static constexpr unsigned int c_chargedStableHypos

The maximal number of charged stable particle hypotheses.

Definition: ECLChargedPIDDataAnalysisValidationModule.h:87

List of global PIDs, defined by the likelihood ratio:

$PID_{i} = \frac{\mathcal{L}_{i}}{\sum_{j}\mathcal{L}_{j}},$

where represents each charged stable particle hypothesis as defined in Const::chargedStableSet.

Book one std::vector<float> for each charged stable particle (and antiparticle) candidate.

Definition at line 258 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_pt

std::vector<float> m_pt = std::vector<float>(c_chargedStableHypos)

private

Track transverse momentum in [GeV/c].

Use the MC-matched reconstructed track w/ highest momentum.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 154 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_saveValidationTree

bool m_saveValidationTree

private

Save the TTree in the output file alongside the histograms.

This is a configurable parameter.

Definition at line 129 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_th_binedges

std::vector<float> m_th_binedges = {0.0, 0.2164208, 0.385, 0.561996, 1.13, 1.57, 1.88, 2.2462387, 2.47, 2.7070057, 3.1415926}

private

Binning w/ variable bin size for track polar angle (in [rad]).

It follows the ECL geometry (although ECL gaps are not accounted for).

Definition at line 271 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_trackClusterMatch

std::vector<float> m_trackClusterMatch = std::vector<float>(c_chargedStableHypos)

private

Flag for track-cluster matching condition.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 209 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_tree

std::vector<TTree*> m_tree = std::vector<TTree*>(c_chargedStableHypos)

private

A ROOT::TTree filled with the info to make control plots.

Book one TTree for each charged stable particle (and antiparticle) candidate.

Definition at line 136 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_trkPhi

std::vector<float> m_trkPhi = std::vector<float>(c_chargedStableHypos)

private

Track azimuthal angle in [rad].

Use the MC-matched reconstructed track w/ highest momentum.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 172 of file ECLChargedPIDDataAnalysisValidationModule.h.

◆ m_trkTheta

std::vector<float> m_trkTheta = std::vector<float>(c_chargedStableHypos)

private

Track polar angle in [rad].

Use the MC-matched reconstructed track w/ highest momentum.

Book one float for each charged stable particle (and antiparticle) candidate.

Definition at line 163 of file ECLChargedPIDDataAnalysisValidationModule.h.

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

ecl/modules/eclChargedPIDDataAnalysisExpert/include/ECLChargedPIDDataAnalysisValidationModule.h
ecl/modules/eclChargedPIDDataAnalysisExpert/src/ECLChargedPIDDataAnalysisValidationModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ dumpPIDEfficiencyFakeRate()

◆ dumpTrkClusMatchingEfficiency()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

Member Data Documentation

◆ c_chargedStableHypos

◆ c_PID

◆ m_clusterPhi

◆ m_clusterReg

◆ m_clusterTheta

◆ m_deltalogl_sig_bkg

◆ m_inputPdgIdList

◆ m_inputPdgIdSet

◆ m_logl_bkg

◆ m_logl_sig

◆ m_mergeChargeOfPdgIds

◆ m_outputFile

◆ m_outputFileName

◆ m_p

◆ m_p_binedges

◆ m_pids_glob

◆ m_pt

◆ m_saveValidationTree

◆ m_th_binedges

◆ m_trackClusterMatch

◆ m_tree

◆ m_trkPhi

◆ m_trkTheta