ECLChargedPIDDataAnalysisValidationModule Class Reference

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:

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.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
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.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
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.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
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.
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).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
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.
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.
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.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

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.
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.
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.
void	setType (const std::string &type)
	Set the module type.
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.
template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
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... for a fixed cut on PID as previously initialised.
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....
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.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Private Attributes
std::vector< int >	m_inputPdgIdList
	The pdgId list of the charged stable particles of interest.
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.
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.
std::vector< TFile * >	m_outputFile = std::vector<TFile*>(c_chargedStableHypos)
	Output ROOT::TFile that contains the info to plot.
std::string	m_outputFileName
	Base name of the output ROOT::TFile.
bool	m_saveValidationTree
	Save the TTree in the output file alongside the histograms.
std::vector< TTree * >	m_tree = std::vector<TTree*>(c_chargedStableHypos)
	A ROOT::TTree filled with the info to make control plots.
std::vector< float >	m_p = std::vector<float>(c_chargedStableHypos)
	Track momentum in [GeV/c].
std::vector< float >	m_pt = std::vector<float>(c_chargedStableHypos)
	Track transverse momentum in [GeV/c].
std::vector< float >	m_trkTheta = std::vector<float>(c_chargedStableHypos)
	Track polar angle in [rad].
std::vector< float >	m_trkPhi = std::vector<float>(c_chargedStableHypos)
	Track azimuthal angle in [rad].
std::vector< float >	m_clusterTheta = std::vector<float>(c_chargedStableHypos)
	Cluster polar angle in [rad].
std::vector< float >	m_clusterReg = std::vector<float>(c_chargedStableHypos)
	Cluster ECL region.
std::vector< float >	m_clusterPhi = std::vector<float>(c_chargedStableHypos)
	Cluster azimuthal angle in [rad].
std::vector< float >	m_trackClusterMatch = std::vector<float>(c_chargedStableHypos)
	Flag for track-cluster matching condition.
std::vector< float >	m_logl_sig = std::vector<float>(c_chargedStableHypos)
	Log-likelihood for the "signal" particle hypothesis.
std::vector< float >	m_logl_bkg = std::vector<float>(c_chargedStableHypos)
	Log-likelihood for the "background" particle hypothesis.
std::vector< float >	m_deltalogl_sig_bkg = std::vector<float>(c_chargedStableHypos)
	Delta Log-likelihood "signal" vs.
std::vector< std::vector< float > >	m_pids_glob
	List of global PIDs, defined by the likelihood ratio:
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]).
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]).
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.
static constexpr unsigned int	c_chargedStableHypos = 2 * Const::ChargedStable::c_SetSize
	The maximal number of charged stable particle hypotheses.

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 Typedef Documentation

EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath

inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.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.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

ECLChargedPIDDataAnalysisValidationModule()

ECLChargedPIDDataAnalysisValidationModule

(

)

Constructor of the module.

Definition at line 29 of file ECLChargedPIDDataAnalysisValidationModule.cc.

                                                                                     : Module()
{
  // Set module properties
  setDescription("This module dumps a set of histograms with ECL charged PID-related info used for validation, starting from an input file w/ particle-gun-generated charged stable particles (and antiparticles).");
 
  // Default charged stable pdgIds (particles & antiparticles)
  std::vector<int> defaultChargedPdgIds;
  for (const auto& hypo : Const::chargedStableSet) {
    defaultChargedPdgIds.push_back(hypo.getPDGCode());
    defaultChargedPdgIds.push_back(-hypo.getPDGCode());
  }
 
  addParam("inputPdgIdList", m_inputPdgIdList,
           "The list of (signed) pdgIds of the charged stable particles for which validation plots should be produced. Default is ALL charged stable particles.",
           defaultChargedPdgIds);
  addParam("mergeChargeOfPdgIds", m_mergeChargeOfPdgIds,
           "The list of (unsigned) pdgIds of the charged stable particles for which particle and antiparticle should be merged together in the plots. Default is no merging, meaning separate plots are generated for +/- charged particles for each input pdgId.",
           std::vector<unsigned int>());
  addParam("outputFileName", m_outputFileName,
           "The base name of the output file. The pdgId of the charged particle is appended to the name.",
           std::string("ECLChargedPid"));
  addParam("saveValidationTree", m_saveValidationTree,
           "If this flag is set to True, save also the validation TTree. Default is False.",
           bool(false));
}

~ECLChargedPIDDataAnalysisValidationModule()

~ECLChargedPIDDataAnalysisValidationModule ( )

virtual

Destructor of the module.

Definition at line 55 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

Called once before a new run begins.

Reimplemented from Module.

Definition at line 126 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
}

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.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

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.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

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.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

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 422 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", "Marcel Hohmann. mhohmann@student.unimelb.edu.au"));
    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", "Marcel Hohmann. mhohmann@student.unimelb.edu.au"));
    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", "Marcel Hohmann. mhohmann@student.unimelb.edu.au"));
    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", "Marcel Hohmann. mhohmann@student.unimelb.edu.au"));
    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;
 
}

dumpPIDVars()

void dumpPIDVars ( TTree *  sampleTree, const Const::ChargedStable &  sigHypo, const int  sigCharge, const Const::ChargedStable &  bkgHypo, bool  mergeSigCharge = false  )

private

Dump PID vars.

Definition at line 325 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
 
  // Get the idx and pdgId of the input sample particle.
  // This corresponds by construction to the "signal" hypothesis for the likelihood and DeltaLogL.
  const auto sigHypoIdx = sigHypo.getIndex();
  const auto sigHypoPdgId = sigHypo.getPDGCode();
 
  // Get the pdgId of the "background" hypothesis to test for DeltaLogL.
  const auto bkgHypoPdgId = bkgHypo.getPDGCode();
 
  // Access the "signal" hypothesis's PID component in the sample's
  // TTree vector branch of global PID values via the idx.
  TString pidSigBranch = TString::Format("pids_glob[%i]", sigHypoIdx);
 
  // Histogram of global PID distribution for the sample particle's signal hypo.
  TString h_pid_name = TString::Format("h_pid_sig_%i", sigHypoPdgId);
  TH1F* h_pid = new TH1F(h_pid_name.Data(), h_pid_name.Data(), 50, -0.5, 1.2);
  h_pid->GetXaxis()->SetTitle(TString::Format("Likelihood ratio (%i/ALL) (ECL)", sigHypoPdgId).Data());
 
  // Histogram of deltalogl.
  TString h_deltalogl_name = TString::Format("h_deltalogl_bkg_%i_sig_%i", bkgHypoPdgId, sigHypoPdgId);
  double deltalogl_min = -20.0;
  double deltalogl_max = 20.0;
  TH1F* h_deltalogl = new TH1F(h_deltalogl_name.Data(), h_deltalogl_name.Data(), 40, deltalogl_min, deltalogl_max);
  h_deltalogl->GetXaxis()->SetTitle(TString::Format("#Deltaln(L) (%i/%i) (ECL)", bkgHypoPdgId, sigHypoPdgId).Data());
 
  // Histogram of track-cluster match flag.
  TString h_trkclusmatch_name = TString::Format("h_trkclusmatch_sig_%i", sigHypoPdgId);
  TH1F* h_trkclusmatch = new TH1F(h_trkclusmatch_name.Data(), h_trkclusmatch_name.Data(), 4, -1.5, 2.5);
  h_trkclusmatch->GetXaxis()->SetTitle(TString::Format("Track-ECLCluster match (%i)", sigHypoPdgId).Data());
 
  // Dump histos from TTree.
  sampleTree->Project(h_pid_name.Data(), pidSigBranch.Data());
  sampleTree->Project(h_deltalogl_name.Data(), "deltalogl_sig_bkg");
  sampleTree->Project(h_trkclusmatch_name.Data(), "trackClusterMatch");
 
  // Make sure the plots show the u/oflow.
  paintUnderOverflow(h_pid);
  paintUnderOverflow(h_deltalogl);
  paintUnderOverflow(h_trkclusmatch);
 
  h_pid->SetOption("HIST");
  h_deltalogl->SetOption("HIST");
  h_trkclusmatch->SetOption("HIST");
 
  // MetaOptions string.
  std::string metaopts("pvalue-warn=0.1,pvalue-error=0.01");
  std::string shifteropt("");
  // Electron plots should be visible to the shifter by default.
  if (sigHypo == Const::electron) {
    shifteropt = "shifter,";
  }
 
  auto pdgIdDesc = (!mergeSigCharge) ? std::to_string(sigHypoPdgId * sigCharge) : std::to_string(
                     sigHypoPdgId) + " and -" + std::to_string(sigHypoPdgId);
 
  // Add histogram info.
  h_pid->GetListOfFunctions()->Add(new TNamed("Description",
                                              TString::Format("Sample PDG = %s ; ECL global PID(%i) distribution. U/O flow is added to first (last) bin.",
                                                              pdgIdDesc.c_str(),
                                                              sigHypoPdgId).Data()));
  h_pid->GetListOfFunctions()->Add(new TNamed("Check",
                                              "The more peaked at 1, the better. Non-zero O-flow indicates either failure of MC matching for reco tracks (unlikely), or failure of track-ECL-cluster matching (more likely). Both cases result in PID=nan."));
  h_pid->GetListOfFunctions()->Add(new TNamed("Contact", "Marcel Hohmann. mhohmann@student.unimelb.edu.au"));
  h_pid->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
 
  h_deltalogl->GetListOfFunctions()->Add(new TNamed("Description",
                                                    TString::Format("Sample PDG = %s ; ECL distribution of binary $\\Delta log(L)$ = log(L(%i)) - log(L(%i)). U/O flow is added to first (last) bin.",
                                                        pdgIdDesc.c_str(),
                                                        bkgHypoPdgId,
                                                        sigHypoPdgId).Data()));
  h_deltalogl->GetListOfFunctions()->Add(new TNamed("Check",
                                                    "Basic metric for signal/bkg separation. The more negative, the better separation is achieved. Non-zero U-flow indicates a non-normal PDF value (of sig OR bkg) for some p,clusterTheta range, which might be due to a non-optimal definition of the x-axis range of the PDF templates. Non-zero O-flow indicates either failure of MC matching for reco tracks (unlikely), or failure of track-ECL-cluster matching (more likely)."));
  h_deltalogl->GetListOfFunctions()->Add(new TNamed("Contact", "Marcel Hohmann. mhohmann@student.unimelb.edu.au"));
  h_deltalogl->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
 
  h_trkclusmatch->GetListOfFunctions()->Add(new TNamed("Description",
                                                       TString::Format("Sample PDG = %s ; Track-ECLCluster match flag distribution.",
                                                           pdgIdDesc.c_str()).Data()));
  h_trkclusmatch->GetListOfFunctions()->Add(new TNamed("Check",
                                                       "The more peaked at 1, the better. Non-zero population in the bins w/ flag != 0|1 indicates failure of MC matching for reco tracks. In such cases, flag=nan."));
  h_trkclusmatch->GetListOfFunctions()->Add(new TNamed("Contact", "Priyanka Cheema. pche3675@uni.sydney.edu.au"));
  h_trkclusmatch->GetListOfFunctions()->Add(new TNamed("MetaOptions", metaopts.c_str()));
 
  h_pid->Write();
  h_deltalogl->Write();
  h_trkclusmatch->Write();
 
  delete h_pid;
  delete h_deltalogl;
  delete h_trkclusmatch;
 
}

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 610 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
 
  // Get the (unsigned) pdgId of the input sample particle.
  const auto sampleHypoPdgId = sampleHypo.getPDGCode();
 
  // Histograms of pt, clusterTheta, clusterPhi... for "pass" (N, numerator) and "all" (D, denominator) events.
  TString h_pt_N_name = TString::Format("h_pt_N_%i", sampleHypoPdgId);
  TString h_pt_D_name = TString::Format("h_pt_D_%i", sampleHypoPdgId);
  TH1F* h_pt_N = new TH1F(h_pt_N_name.Data(), "h_pt_N", 10, 0.0, 5.0);
  TH1F* h_pt_D = new TH1F(h_pt_D_name.Data(), "h_pt_D", 10, 0.0, 5.0);
 
  TString h_th_N_name = TString::Format("h_th_N_%i", sampleHypoPdgId);
  TString h_th_D_name = TString::Format("h_th_D_%i", sampleHypoPdgId);
  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_phi_N_name = TString::Format("h_phi_N_%i", sampleHypoPdgId);
  TString h_phi_D_name = TString::Format("h_phi_D_%i", sampleHypoPdgId);
  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);
 
  TString match_cut_N("trackClusterMatch == 1");
  TString match_cut_D("trackClusterMatch >= 0");
 
  // Fill the histograms from the sample's TTree.
 
  tree->Project(h_pt_N_name.Data(), "pt", match_cut_N.Data());
  tree->Project(h_pt_D_name.Data(), "pt", match_cut_D.Data());
 
  tree->Project(h_th_N_name.Data(), "trkTheta", match_cut_N.Data());
  tree->Project(h_th_D_name.Data(), "trkTheta", match_cut_D.Data());
 
  tree->Project(h_phi_N_name.Data(), "trkPhi", match_cut_N.Data());
  tree->Project(h_phi_D_name.Data(), "trkPhi", match_cut_D.Data());
 
  // Compute the efficiency.
 
  TString match_eff_pt_name = TString::Format("trkclusmatch_%i_Efficiency__VS_pt", sampleHypoPdgId);
  TString match_eff_th_name = TString::Format("trkclusmatch_%i_Efficiency__VS_th", sampleHypoPdgId);
  TString match_eff_phi_name = TString::Format("trkclusmatch_%i_Efficiency__VS_phi", sampleHypoPdgId);
 
  // 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) {
    shifteropt = "shifter,";
  }
 
  auto pdgIdDesc = (!mergeSampleCharge) ? std::to_string(sampleHypoPdgId * sampleCharge) : std::to_string(
                     sampleHypoPdgId) + " and -" + std::to_string(sampleHypoPdgId);
 
  if (TEfficiency::CheckConsistency(*h_pt_N, *h_pt_D)) {
 
    TEfficiency* t_match_eff_pt = new TEfficiency(*h_pt_N, *h_pt_D);
    t_match_eff_pt->SetName(match_eff_pt_name.Data());
    t_match_eff_pt->SetTitle(TString::Format("%s;p_{T}^{trk} [GeV/c];#varepsilon", match_eff_pt_name.Data()).Data());
    t_match_eff_pt->SetTitle(match_eff_pt_name.Data());
 
    t_match_eff_pt->SetConfidenceLevel(0.683);
    t_match_eff_pt->SetStatisticOption(TEfficiency::kBUniform);
    t_match_eff_pt->SetPosteriorMode();
 
    t_match_eff_pt->GetListOfFunctions()->Add(new TNamed("Description",
                                                         TString::Format("Sample PDG = %s ; Efficiency of track-ECL-cluster matching as a function of $p_{T}^{trk}$.",
                                                             pdgIdDesc.c_str()).Data()));
    t_match_eff_pt->GetListOfFunctions()->Add(new TNamed("Check",
                                                         "Shape should be consistent. Obviously, check for decreasing efficiency."));
    t_match_eff_pt->GetListOfFunctions()->Add(new TNamed("Contact", "Priyanka Cheema. pche3675@uni.sydney.edu.au"));
    t_match_eff_pt->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
 
    t_match_eff_pt->Write();
 
    delete t_match_eff_pt;
 
  }
  if (TEfficiency::CheckConsistency(*h_th_N, *h_th_D)) {
 
    TEfficiency* t_match_eff_th = new TEfficiency(*h_th_N, *h_th_D);
    t_match_eff_th->SetName(match_eff_th_name.Data());
    t_match_eff_th->SetTitle(TString::Format("%s;#theta_{trk} [rad];#varepsilon", match_eff_th_name.Data()).Data());
    t_match_eff_th->SetTitle(match_eff_th_name.Data());
 
    t_match_eff_th->SetConfidenceLevel(0.683);
    t_match_eff_th->SetStatisticOption(TEfficiency::kBUniform);
    t_match_eff_th->SetPosteriorMode();
 
    t_match_eff_th->GetListOfFunctions()->Add(new TNamed("Description",
                                                         TString::Format("Sample PDG = %s ; Efficiency of track-ECL-cluster matching as a function of $\\theta_{trk}$.",
                                                             pdgIdDesc.c_str()).Data()));
    t_match_eff_th->GetListOfFunctions()->Add(new TNamed("Check",
                                                         "Shape should be consistent. Obviously, check for decreasing efficiency."));
    t_match_eff_th->GetListOfFunctions()->Add(new TNamed("Contact", "Priyanka Cheema. pche3675@uni.sydney.edu.au"));
    t_match_eff_th->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
 
    t_match_eff_th->Write();
 
    delete t_match_eff_th;
 
  }
  if (TEfficiency::CheckConsistency(*h_phi_N, *h_phi_D)) {
 
    TEfficiency* t_match_eff_phi = new TEfficiency(*h_phi_N, *h_phi_D);
    t_match_eff_phi->SetName(match_eff_phi_name.Data());
    t_match_eff_phi->SetTitle(TString::Format("%s;#phi_{trk} [rad];#varepsilon", match_eff_phi_name.Data()).Data());
 
    t_match_eff_phi->SetConfidenceLevel(0.683);
    t_match_eff_phi->SetStatisticOption(TEfficiency::kBUniform);
    t_match_eff_phi->SetPosteriorMode();
 
    t_match_eff_phi->GetListOfFunctions()->Add(new TNamed("Description",
                                                          TString::Format("Sample PDG = %s ; Efficiency of track-ECL-cluster matching as a function of $\\phi_{trk}$.",
                                                              pdgIdDesc.c_str()).Data()));
    t_match_eff_phi->GetListOfFunctions()->Add(new TNamed("Check",
                                                          "Shape should be consistent. Obviously, check for decreasing efficiency."));
    t_match_eff_phi->GetListOfFunctions()->Add(new TNamed("Contact", "Priyanka Cheema. pche3675@uni.sydney.edu.au"));
    t_match_eff_phi->GetListOfFunctions()->Add(new TNamed("MetaOptions", (shifteropt + metaopts).c_str()));
 
    t_match_eff_phi->Write();
 
    delete t_match_eff_phi;
  }
 
  delete h_pt_N;
  delete h_pt_D;
  delete h_th_N;
  delete h_th_D;
  delete h_phi_N;
  delete h_phi_D;
 
}

endRun()

void endRun ( void  )

overridevirtual

Called once when a run ends.

Reimplemented from Module.

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

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( void  )

overridevirtual

Called once for each event.

Reimplemented from Module.

Definition at line 130 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
 
  for (const auto& chargedPdgId : m_inputPdgIdSet) {
 
    const auto chargedHypo = Const::chargedStableSet.find(std::abs(chargedPdgId));
 
    // If merging particles and antiparticles for this hypo, no need to loop twice:
    // fill one TTree for the '+' charged pdgId only.
    if (m_mergeChargeFlagByHypo[chargedHypo] and chargedPdgId < 0) continue;
 
    // Get the idx of this pdgId in the Const::chargedStableSet
    auto chargedIdx = chargedHypo.getIndex();
 
    if (chargedPdgId < 0) {
      // Add offset to idx for antiparticles.
      chargedIdx += Const::ChargedStable::c_SetSize;
    }
 
    // Initialise branches to unphysical values.
    m_p[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_pt[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_trkTheta[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_trkPhi[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_clusterTheta[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_clusterPhi[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_clusterReg[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_trackClusterMatch[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_logl_sig[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_logl_bkg[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    m_deltalogl_sig_bkg[chargedIdx] = std::numeric_limits<float>::quiet_NaN();
    for (const auto& chargedStable : Const::chargedStableSet) {
      m_pids_glob[chargedIdx][chargedStable.getIndex()] = std::numeric_limits<float>::quiet_NaN();
    }
 
    for (const auto& particle : m_MCParticles) {
 
      if (!particle.hasStatus(MCParticle::c_PrimaryParticle)) continue; // Only check primaries.
      if (particle.hasStatus(MCParticle::c_Initial)) continue; // Ignore initial particles.
      if (particle.hasStatus(MCParticle::c_IsVirtual)) continue; // Ignore virtual particles.
 
      // Skip all particles expect for the one of interest.
      // If merging particles and antiparticles for this pdgId, use abs so both charges are considered for the MCParticles.
      if (m_mergeChargeFlagByHypo[chargedHypo]) {
        // Charge-agnostic check.
        if (std::abs(particle.getPDG()) != std::abs(chargedPdgId)) continue;
      } else {
        // Charge-dependent check.
        if (particle.getPDG() != chargedPdgId) continue;
      }
 
      // Get the matching track w/ max momentum.
      int itrack(0);
      int itrack_max(-1);
      double p_max(-999.0);
      for (const auto& track : particle.getRelationsFrom<Track>()) {
        const auto fitRes = track.getTrackFitResultWithClosestMass(Const::pion);
        if (!fitRes) continue;
        if (fitRes->getMomentum().R() > p_max) {
          p_max = fitRes->getMomentum().R();
          itrack_max = itrack;
        }
        itrack++;
      }
      if (itrack_max < 0) continue; // Go to next particle if no track found.
 
      const auto track = particle.getRelationsFrom<Track>()[itrack_max];
      const auto fitRes = track->getTrackFitResultWithClosestMass(Const::pion);
 
      m_p[chargedIdx] = p_max;
      m_pt[chargedIdx] = fitRes->get4Momentum().Pt();
      m_trkTheta[chargedIdx] = fitRes->get4Momentum().Theta();
      m_trkPhi[chargedIdx] = fitRes->get4Momentum().Phi();
 
      // Get the index of the ECL cluster matching this track.
      int icluster_match(-1);
      auto eclClusters = track->getRelationsTo<ECLCluster>();
      for (unsigned int icluster(0); icluster < eclClusters.size(); ++icluster) {
        const auto eclCluster = eclClusters[icluster];
        if (!eclCluster->hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons)) continue;
        if (!eclCluster->isTrack()) continue;
        icluster_match = icluster;
        break;
      }
      // If no cluster match, skip to next particle, but keep track of counter.
      if (icluster_match < 0) {
        m_trackClusterMatch[chargedIdx] = 0;
        continue;
      }
 
      const auto eclCluster = eclClusters[icluster_match];
 
      m_clusterTheta[chargedIdx] = eclCluster->getTheta();
      m_clusterPhi[chargedIdx] = eclCluster->getPhi();
      m_clusterReg[chargedIdx] = eclCluster->getDetectorRegion();
 
      m_trackClusterMatch[chargedIdx] = 1;
 
      // The "signal" likelihood corresponds to the current chargedPdgId.
      const auto chargedStableSig = Const::chargedStableSet.find(std::abs(chargedPdgId));
      // For deltaLogL, we do a binary comparison sig/bkg.
      // If sig=pion, use bkg=kaon. Otherwise, bkg=pion.
      const auto chargedStableBkg = (chargedStableSig == Const::pion) ? Const::kaon : Const::pion;
 
      // Very unlikely, but random failures due to missing ECLPidLikelihood have been observed
      // Let's continue if this is a nullptr
      const auto eclLikelihood = track->getRelated<ECLPidLikelihood>();
      if (not eclLikelihood)
        continue;
 
      double lh_sig = eclLikelihood->getLikelihood(chargedStableSig);
      double lh_bkg = eclLikelihood->getLikelihood(chargedStableBkg);
 
      m_logl_sig[chargedIdx] = log(lh_sig);
      m_logl_bkg[chargedIdx] = log(lh_bkg);
      m_deltalogl_sig_bkg[chargedIdx] = log(lh_bkg) - log(lh_sig);
 
      // For the current charged particle candidate, store the global likelihood ratio for all hypotheses.
      double lh_all(0);
      for (const auto& chargedStable : Const::chargedStableSet) {
        lh_all += eclLikelihood->getLikelihood(chargedStable);
      }
      for (const auto& chargedStable : Const::chargedStableSet) {
        m_pids_glob[chargedIdx][chargedStable.getIndex()] = eclLikelihood->getLikelihood(chargedStable) / lh_all;
      }
 
    }
 
    m_tree[chargedIdx]->Fill();
 
  }
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: 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.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: 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.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

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.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const

inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

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.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

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 RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

    {
      return std::vector<std::string>();
    }

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

{ return std::list<ModulePtr>(); }

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.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

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.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

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.

{ return m_returnValue; }

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.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

hasCondition()

bool hasCondition ( ) const

inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

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.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

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_value("<1", path, afterConditionPath);
}

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(">=1", path, afterConditionPath);
}

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://xwiki.desy.de/xwiki/rest/p/a94f2 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.

{
  m_conditions.emplace_back(expression, path, afterConditionPath);
}

initialize()

void initialize ( void  )

overridevirtual

Initializes the module.

Reimplemented from Module.

Definition at line 60 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
  B2INFO("Initialising ROOT objects...");
 
  // Convert pdgId list to a set to remove any accidental repetitions.
  m_inputPdgIdSet = std::set<int>(m_inputPdgIdList.begin(), m_inputPdgIdList.end());
 
  // By default, do not merge particles and antiparticles together,
  // unless a particle hypo is in the configured "merge" list.
  for (const auto& hypo : Const::chargedStableSet) {
    bool merge = (std::find(m_mergeChargeOfPdgIds.begin(), m_mergeChargeOfPdgIds.end(),
                            hypo.getPDGCode()) == m_mergeChargeOfPdgIds.end()) ? false : true;
    if (merge) {
      B2WARNING("For (unsigned) hypothesis " << hypo.getPDGCode() << ",  validation plots will be merged for +/- charged particles.");
    }
    m_mergeChargeFlagByHypo.insert(std::pair<Const::ChargedStable, bool>(hypo, merge));
  }
 
  std::string chargedPdgIdStr;
  std::string fname;
 
  for (const auto& chargedPdgId : m_inputPdgIdSet) {
 
    // Check if this pdgId is that of a legit Const::ChargedStable particle.
    if (!isValidChargedPdg(std::abs(chargedPdgId))) {
      B2FATAL("PDG: " << chargedPdgId << " in m_inputPdgIdSet is not that of a valid particle in Const::chargedStableSet! Aborting...");
    }
 
    const auto chargedHypo = Const::chargedStableSet.find(std::abs(chargedPdgId));
 
    // If merging particles and antiparticles for this hypo, no need to loop twice:
    // register one TTree for the '+' charged pdgId only.
    if (m_mergeChargeFlagByHypo[chargedHypo] and chargedPdgId < 0) continue;
 
    // Get the idx of this pdgId in the Const::chargedStableSet
    auto chargedIdx = chargedHypo.getIndex();
 
    if (chargedPdgId > 0) {
      chargedPdgIdStr = std::to_string(chargedPdgId);
    } else {
      chargedPdgIdStr = "anti" + std::to_string(std::abs(chargedPdgId));
      // Add offset to idx.
      chargedIdx += Const::ChargedStable::c_SetSize;
    }
 
    fname = m_outputFileName + "_" + chargedPdgIdStr + ".root";
 
    m_outputFile[chargedIdx] = new TFile(fname.c_str(), "RECREATE");
 
    m_tree[chargedIdx] = new TTree("ECLChargedPid", "ECLChargedPid");
    m_tree[chargedIdx]->Branch("p", &m_p[chargedIdx], "p/F");
    m_tree[chargedIdx]->Branch("pt", &m_pt[chargedIdx], "pt/F");
    m_tree[chargedIdx]->Branch("trkTheta", &m_trkTheta[chargedIdx], "trkTheta/F");
    m_tree[chargedIdx]->Branch("trkPhi", &m_trkPhi[chargedIdx], "trkPhi/F");
    m_tree[chargedIdx]->Branch("clusterTheta", &m_clusterTheta[chargedIdx], "clusterTheta/F");
    m_tree[chargedIdx]->Branch("clusterPhi", &m_clusterPhi[chargedIdx], "clusterPhi/F");
    m_tree[chargedIdx]->Branch("clusterReg", &m_clusterReg[chargedIdx], "clusterReg/F");
    m_tree[chargedIdx]->Branch("trackClusterMatch", &m_trackClusterMatch[chargedIdx], "trackClusterMatch/F");
    m_tree[chargedIdx]->Branch("logl_sig", &m_logl_sig[chargedIdx], "logl_sig/F");
    m_tree[chargedIdx]->Branch("logl_bkg", &m_logl_bkg[chargedIdx], "logl_bkg/F");
    m_tree[chargedIdx]->Branch("deltalogl_sig_bkg", &m_deltalogl_sig_bkg[chargedIdx], "deltalogl_sig_bkg/F");
    m_tree[chargedIdx]->Branch("pids_glob", &m_pids_glob[chargedIdx]);
 
  }
}

isValidChargedPdg()

bool isValidChargedPdg ( const int  pdg ) const

inlineprivate

Check if the input pdgId is that of a valid charged stable particle.

Definition at line 313 of file ECLChargedPIDDataAnalysisValidationModule.h.

    {
      return (Const::chargedStableSet.find(pdg) != Const::invalidParticle);
    }

paintUnderOverflow()

void paintUnderOverflow ( TH1F *  h )

private

Draw u/oflow content on top of first/last visible bin.

Definition at line 745 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
 
  auto nentries = h->GetEntries();
  auto nbins_vis = h->GetNbinsX();
 
  // Get the content and error of first/last visible bin.
  float bin_vis_first = h->GetBinContent(1);
  float bin_vis_last = h->GetBinContent(nbins_vis);
  float bin_vis_first_err = h->GetBinError(1);
  float bin_vis_last_err = h->GetBinError(nbins_vis);
 
  // Get the content and error of u/oflow bins.
  float bin_uflow = h->GetBinContent(0);
  float bin_oflow = h->GetBinContent(nbins_vis + 1);
  float bin_uflow_err = h->GetBinError(0);
  float bin_oflow_err = h->GetBinError(nbins_vis + 1);
 
  // Reset first/last visible bins to include u/oflow.
  h->SetBinContent(1, bin_vis_first + bin_uflow);
  h->SetBinError(1, sqrt(bin_vis_first_err * bin_vis_first_err + bin_uflow_err * bin_uflow_err));
  h->SetBinContent(nbins_vis, bin_vis_last + bin_oflow);
  h->SetBinError(nbins_vis, sqrt(bin_vis_last_err * bin_vis_last_err + bin_oflow_err * bin_oflow_err));
 
  // Reset total entries to the original value.
  h->SetEntries(nentries);
 
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

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.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

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.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

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.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

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.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

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.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

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.

{
  m_propertyFlags = propertyFlags;
}

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.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

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.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

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.

{
  if (!m_type.empty())
    B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
  m_type = type;
}

terminate()

void terminate ( void  )

overridevirtual

Termination action.

Reimplemented from Module.

Definition at line 267 of file ECLChargedPIDDataAnalysisValidationModule.cc.

{
 
  for (const auto& chargedPdgId : m_inputPdgIdSet) {
 
    // Define the charged stable particle ("sample") corresponding to the current pdgId.
    const auto chargedStableSample = Const::chargedStableSet.find(std::abs(chargedPdgId));
 
    const auto mergeCharge = m_mergeChargeFlagByHypo[chargedStableSample];
 
    // If partcile/antiparticle merging is active for this hypo, the results are stored for the '+' particle only.
    if (mergeCharge && chargedPdgId <= 0) continue;
 
    // Extract the sign of the charge.
    const auto chargeSign = static_cast<int>(chargedPdgId / std::abs(chargedPdgId));
 
    // What we call "signal" is equal to the sample under consideration.
    const auto chargedStableSig = chargedStableSample;
 
    // What we call "background" depends on the current "signal" particle hypothesis.
    const auto chargedStableBkg = (chargedStableSig == Const::pion) ? Const::kaon : Const::pion;
 
    // Get the idx of this sample's pdgId to retrieve the correct TTree and output TFile.
    // Remember to add offset for antiparticles.
    auto chargedSampleIdx = (chargeSign > 0) ? chargedStableSig.getIndex() : chargedStableSig.getIndex() +
                            Const::ChargedStable::c_SetSize;
 
    m_outputFile[chargedSampleIdx]->cd();
 
    auto pdgIdDesc = (mergeCharge) ? std::to_string(chargedPdgId) + " and -" + std::to_string(chargedPdgId) : std::to_string(
                       chargedPdgId);
 
    // Add summary description of validation file content.
    TNamed("Description", TString::Format("ECL Charged PID control plots for charged stable particles/antiparticles ; Sample PDG = %s",
                                          pdgIdDesc.c_str()).Data()).Write();
 
    // Dump plots of PID variables.
    dumpPIDVars(m_tree[chargedSampleIdx], chargedStableSig, chargeSign, chargedStableBkg, mergeCharge);
    // Dump plots of PID "signal" efficiency for this "sample".
    dumpPIDEfficiencyFakeRate(m_tree[chargedSampleIdx], chargedStableSample, chargeSign, chargedStableSig, mergeCharge);
    // For pions, dump also the pi->lep fake rate.
    if (chargedStableSample == Const::pion) {
      dumpPIDEfficiencyFakeRate(m_tree[chargedSampleIdx], chargedStableSample, chargeSign, Const::electron, mergeCharge);
      dumpPIDEfficiencyFakeRate(m_tree[chargedSampleIdx], chargedStableSample, chargeSign, Const::muon, mergeCharge);
    }
    // Dump plots of matching efficiency for this "sample".
    dumpTrkClusMatchingEfficiency(m_tree[chargedSampleIdx], chargedStableSample, chargeSign, mergeCharge);
 
    // Write the TTree to file if requested.
    if (m_saveValidationTree) {
      m_tree[chargedSampleIdx]->Write();
    }
 
    m_outputFile[chargedSampleIdx]->Close();
 
  }
}

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_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_deltalogl_sig_bkg

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

private

Delta Log-likelihood "signal" vs.

"background".

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_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.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_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.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_MCParticles

StoreArray<MCParticle> m_MCParticles

private

MCParticles.

Definition at line 276 of file ECLChargedPIDDataAnalysisValidationModule.h.

m_mergeChargeFlagByHypo

std::map<Const::ChargedStable, bool> m_mergeChargeFlagByHypo

private

A map to tell for each charged stable particle hypothesis whether particle and antiparticle should be merged together in the plots.

Definition at line 104 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_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.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_package

std::string m_package

privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.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))

List of global PIDs, defined by the likelihood ratio:

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_propertyFlags

unsigned int m_propertyFlags

privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.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_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.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.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

---

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

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