V0findingPerformanceEvaluationModule Class Reference

This module takes the MCParticles, the V0 candidates input and produce a root file containing various histograms showing the performance of the V0 finding module. More...

#include <V0findingPerformanceEvaluationModule.h>

Inheritance diagram for V0findingPerformanceEvaluationModule:

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
	V0findingPerformanceEvaluationModule ()
	Constructor.
	~V0findingPerformanceEvaluationModule ()
	Destructor.
void	initialize () override
	Initializer.
void	beginRun () override
	Called when entering a new run.
void	event () override
	This method is called for each event.
void	endRun () override
	This method is called if the current run ends.
void	terminate () override
	This method is called at the end of the event processing.
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
bool	isV0 (const MCParticle &the_mcParticle)
	is V0
int	nMatchedDaughters (const MCParticle &the_mcParticle)
	number of truth matched dauhters
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.
TH1F *	createHistogram1D (const char *name, const char *title, Int_t nbins, Double_t min, Double_t max, const char *xtitle, TList *histoList=nullptr)
	Create a 1D histogram and add it to the TList of 1D-histograms.
TH1F *	createHistogram1D (const char *name, const char *title, Int_t nbins, Double_t *bins, const char *xtitle, TList *histoList=nullptr)
	Create a 1D histogram and add it to the TList of 1D-histograms.
TH2F *	createHistogram2D (const char *name, const char *title, Int_t nbinsX, Double_t minX, Double_t maxX, const char *titleX, Int_t nbinsY, Double_t minY, Double_t maxY, const char *titleY, TList *histoList=nullptr)
	Create a 2D histogram and add it to the TList of 2D-histograms.
TH2F *	createHistogram2D (const char *name, const char *title, Int_t nbinsX, Double_t *binsX, const char *titleX, Int_t nbinsY, Double_t *binsY, const char *titleY, TList *histoList=nullptr)
	Create a 2D histogram and add it to the TList of 2D-histograms.
TH3F *	createHistogram3D (const char *name, const char *title, Int_t nbinsX, Double_t minX, Double_t maxX, const char *titleX, Int_t nbinsY, Double_t minY, Double_t maxY, const char *titleY, Int_t nbinsZ, Double_t minZ, Double_t maxZ, const char *titleZ, TList *histoList=nullptr)
	Create a 3D histogram and add it to the TList of 3D-histograms.
TH3F *	createHistogram3D (const char *name, const char *title, Int_t nbinsX, Double_t *binsX, const char *titleX, Int_t nbinsY, Double_t *binsY, const char *titleY, Int_t nbinsZ, Double_t *binsZ, const char *titleZ, TList *histoList=nullptr)
	Create a 3D histogram and add it to the TList of 3D-histograms.
TH1 *	duplicateHistogram (const char *newname, const char *newtitle, TH1 *h, TList *histoList=nullptr)
	Make a copy of a 1D histogram and add it to the TList of 1D-histograms.
TH1F *	createHistogramsRatio (const char *name, const char *title, TH1 *hNum, TH1 *hDen, bool isEffPlot, int axisRef)
	Make a new 1D histogram from the ratio of two others and add it to the TList of 1D-histograms.
void	addEfficiencyPlots (TList *graphList=nullptr, TH3F *h3_xPerMCParticle=nullptr, TH3F *h3_MCParticle=nullptr)
	Create pt-, theta- and phi-efficiency 1D histograms and add them to the TList of 1D-histograms.
void	addInefficiencyPlots (TList *graphList=nullptr, TH3F *h3_xPerMCParticle=nullptr, TH3F *h3_MCParticle=nullptr)
	Create pt-, theta- and phi-inefficiency 1D histograms and add them to the TList of 1D-histograms.
void	addPurityPlots (TList *graphList=nullptr, TH3F *h3_xPerMCParticle=nullptr, TH3F *h3_MCParticle=nullptr)
	Create pt-, theta- and phi-purity 1D histograms and add them to the TList of 1D-histograms.
TH1F *	effPlot1D (TH1F *h1_den, TH1F *h1_num, const char *name, const char *title, bool geo_accettance, TList *histoList=nullptr)
	Create a 1D efficiency histogram and add it to the TList of 1D-histograms.
TH1F *	effPlot1D (TH1F *h1_MC, TH1F *h1_RecoTrack, TH1F *h1_Track, const char *name, const char *title, TList *histoList=nullptr)
	Create a 1D efficiency histogram and add it to the TList of 1D-histograms.
TH2F *	effPlot2D (TH2F *h2_den, TH2F *h2_num, const char *name, const char *title, bool geo_accettance, TList *histoList=nullptr)
	Create a 2D efficiency histogram and add it to the TList of 2D-histograms.
TH2F *	effPlot2D (TH2F *h2_MC, TH2F *h2_RecoTrack, TH2F *h2_Track, const char *name, const char *title, TList *histoList)
	Create a 2D efficiency histogram and add it to the TList of 2D-histograms.
TH1F *	geoAcc1D (TH1F *h1_den, TH1F *h1_num, const char *name, const char *title, TList *histoList=nullptr)
	Create a 1D efficiency histogram for geometric acceptance and add it to the TList of 1D-histograms.
TH2F *	geoAcc2D (TH2F *h2_den, TH2F *h2_num, const char *name, const char *title, TList *histoList=nullptr)
	Create a 2D efficiency histogram for geometric acceptance and add it to the TList of 2D-histograms.
TH1F *	V0FinderEff (TH1F *h1_dau0, TH1F *h1_dau1, TH1F *h1_Mother, const char *name, const char *title, TList *histoList=nullptr)
	Create a 1D efficiency histogram for V0 finding and add it to the TList of 1D-histograms.

Private Attributes
std::string	m_MCParticlesName
	MCParticle StoreArray name.
std::string	m_V0sName
	MCTrackCand StoreArray name.
StoreArray< MCParticle >	m_MCParticles
	MCParticles StoreArray.
StoreArray< V0ValidationVertex >	m_V0ValidationVertices
	V0ValidationVertices StoreArray.
TH1F *	m_multiplicityV0s = nullptr
	number of V0s per MCParticles
TH1F *	m_multiplicityMCParticles = nullptr
	number of MCParticles per fitted Track
TH1F *	m_MCParticlePDGcode = nullptr
	MCParticle PDG code.
TH1F *	m_h1_vtxX_err = nullptr
	vtx error
TH1F *	m_h1_vtxY_err = nullptr
	vtx error
TH1F *	m_h1_vtxZ_err = nullptr
	vtx error
TH2F *	m_h2_vtxTvsR_err = nullptr
	vtx error on transverse plane VS transverse flight length
TH1F *	m_h1_vtxX_res = nullptr
	vtx resid
TH1F *	m_h1_vtxY_res = nullptr
	vtx resid
TH1F *	m_h1_vtxZ_res = nullptr
	vtx resid
TH1F *	m_h1_mom_res = nullptr
	mom resid
TH2F *	m_h2_mom = nullptr
	mom reco VS true
TH1F *	m_h1_mass_res = nullptr
	mom resid
TH2F *	m_h2_mass = nullptr
	mass reco VS true
TH1F *	m_h1_vtxX_pll = nullptr
	vtx pull
TH1F *	m_h1_vtxY_pll = nullptr
	vtx pull
TH1F *	m_h1_vtxZ_pll = nullptr
	vtx pull
TH1F *	m_h1_ChiSquare = nullptr
	TH1F chi square.
TH1F *	m_h1_nMatchedDau = nullptr
	TH1F n matched daughters.
TH3F *	m_h3_MCParticle = nullptr
	V0-finding denominator.
TH3F *	m_h3_V0sPerMCParticle = nullptr
	V0-finding numerator.
TH1F *	m_h1_MCParticle_R = nullptr
	V0-finding denominator by radius.
TH1F *	m_h1_V0sPerMCParticle_R = nullptr
	V0-finding numerator by radius.
TH3F *	m_h3_V0s = nullptr
	V0-finding purity denominator.
TH3F *	m_h3_MCParticlesPerV0 = nullptr
	V0-finding numerator.
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.
TList *	m_histoList = nullptr
	List of performance-evaluation histograms.
TList *	m_histoList_multiplicity = nullptr
	List of multiplicity histograms.
TList *	m_histoList_evtCharacterization = nullptr
	List of event-characterization histograms.
TList *	m_histoList_trkQuality = nullptr
	List of track-quality histograms.
TList *	m_histoList_firstHit = nullptr
	List of first-hit-position histograms.
TList *	m_histoList_pr = nullptr
	List of pattern-recognition histograms.
TList *	m_histoList_fit = nullptr
	List of track-fit histograms.
TList *	m_histoList_efficiency = nullptr
	List of efficiency histograms.
TList *	m_histoList_purity = nullptr
	List of purity histograms.
TList *	m_histoList_others = nullptr
	List of other performance-evaluation histograms.
std::string	m_rootFileName
	root file name
TFile *	m_rootFilePtr = nullptr
	pointer at root file used for storing histograms

Detailed Description

This module takes the MCParticles, the V0 candidates input and produce a root file containing various histograms showing the performance of the V0 finding module.

Definition at line 32 of file V0findingPerformanceEvaluationModule.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

V0findingPerformanceEvaluationModule()

V0findingPerformanceEvaluationModule

(

)

Constructor.

Definition at line 34 of file V0findingPerformanceEvaluationModule.cc.

                                                                           :
  Module()
{
 
  setDescription("This module evaluates the V0 finding package performance");
 
  addParam("outputFileName", m_rootFileName, "Name of output root file.",
           std::string("V0findingPerformanceEvaluation_output.root"));
  addParam("V0sName", m_V0sName, "Name of V0 collection.", std::string("V0ValidationVertexs"));
  addParam("MCParticlesName", m_MCParticlesName, "Name of MC Particle collection.", std::string(""));
 
}

~V0findingPerformanceEvaluationModule()

~V0findingPerformanceEvaluationModule

(

)

Destructor.

Definition at line 47 of file V0findingPerformanceEvaluationModule.cc.

{
 
}

Member Function Documentation

addEfficiencyPlots()

void addEfficiencyPlots ( TList *  graphList = nullptr, TH3F *  h3_xPerMCParticle = nullptr, TH3F *  h3_MCParticle = nullptr  )

inherited

Create pt-, theta- and phi-efficiency 1D histograms and add them to the TList of 1D-histograms.

Definition at line 293 of file PerformanceEvaluationBaseClass.cc.

{
  if ((h3_xPerMCParticle == nullptr) || (h3_MCParticle == nullptr))
    return;
 
  //normalized to MCParticles
  TH1F* h_eff_pt = createHistogramsRatio("heffpt", "efficiency VS pt, normalized to MCParticles", h3_xPerMCParticle,
                                         h3_MCParticle, true, 0);
  histoList->Add(h_eff_pt);
 
  TH1F* h_eff_theta = createHistogramsRatio("hefftheta", "efficiency VS #theta, normalized to MCParticles", h3_xPerMCParticle,
                                            h3_MCParticle, true, 1);
  histoList->Add(h_eff_theta);
 
  TH1F* h_eff_phi = createHistogramsRatio("heffphi", "efficiency VS #phi, normalized to MCParticles", h3_xPerMCParticle,
                                          h3_MCParticle, true, 2);
  histoList->Add(h_eff_phi);
 
}

addInefficiencyPlots()

void addInefficiencyPlots ( TList *  graphList = nullptr, TH3F *  h3_xPerMCParticle = nullptr, TH3F *  h3_MCParticle = nullptr  )

inherited

Create pt-, theta- and phi-inefficiency 1D histograms and add them to the TList of 1D-histograms.

Definition at line 272 of file PerformanceEvaluationBaseClass.cc.

{
 
  if ((h3_xPerMCParticle == nullptr) || (h3_MCParticle == nullptr))
    return;
 
  //normalized to MCParticles
  TH1F* h_ineff_pt = createHistogramsRatio("hineffpt", "inefficiency VS pt, normalized to MCParticles", h3_xPerMCParticle,
                                           h3_MCParticle, false, 0);
  histoList->Add(h_ineff_pt);
 
  TH1F* h_ineff_theta = createHistogramsRatio("hinefftheta", "inefficiency VS #theta, normalized to MCParticles",
                                              h3_xPerMCParticle, h3_MCParticle, false, 1);
  histoList->Add(h_ineff_theta);
 
  TH1F* h_ineff_phi = createHistogramsRatio("hineffphi", "inefficiency VS #phi, normalized to MCParticles", h3_xPerMCParticle,
                                            h3_MCParticle, false, 2);
  histoList->Add(h_ineff_phi);
 
}

addPurityPlots()

void addPurityPlots ( TList *  graphList = nullptr, TH3F *  h3_xPerMCParticle = nullptr, TH3F *  h3_MCParticle = nullptr  )

inherited

Create pt-, theta- and phi-purity 1D histograms and add them to the TList of 1D-histograms.

Definition at line 315 of file PerformanceEvaluationBaseClass.cc.

{
  if ((h3_X == nullptr) || (h3_MCParticlesPerX == nullptr))
    return;
 
  //purity histograms
  TH1F* h_pur_pt = createHistogramsRatio("hpurpt", "purity VS pt", h3_MCParticlesPerX, h3_X, true, 0);
  histoList->Add(h_pur_pt);
 
  TH1F* h_pur_theta = createHistogramsRatio("hpurtheta", "purity VS #theta", h3_MCParticlesPerX, h3_X, true, 1);
  histoList->Add(h_pur_theta);
 
  TH1F* h_pur_phi = createHistogramsRatio("hpurphi", "purity VS #phi", h3_MCParticlesPerX, h3_X, true, 2);
  histoList->Add(h_pur_phi);
 
}

beginRun()

void beginRun ( void  )

overridevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 146 of file V0findingPerformanceEvaluationModule.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;
}

createHistogram1D() [1/2]

TH1F * createHistogram1D ( const char *  name, const char *  title, Int_t  nbins, Double_t *  bins, const char *  xtitle, TList *  histoList = nullptr  )

inherited

Create a 1D histogram and add it to the TList of 1D-histograms.

Definition at line 41 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH1F* h = new TH1F(name, title, nbins, bins);
 
  h->GetXaxis()->SetTitle(xtitle);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogram1D() [2/2]

TH1F * createHistogram1D ( const char *  name, const char *  title, Int_t  nbins, Double_t  min, Double_t  max, const char *  xtitle, TList *  histoList = nullptr  )

inherited

Create a 1D histogram and add it to the TList of 1D-histograms.

Definition at line 26 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH1F* h = new TH1F(name, title, nbins, min, max);
 
  h->GetXaxis()->SetTitle(xtitle);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogram2D() [1/2]

TH2F * createHistogram2D ( const char *  name, const char *  title, Int_t  nbinsX, Double_t *  binsX, const char *  titleX, Int_t  nbinsY, Double_t *  binsY, const char *  titleY, TList *  histoList = nullptr  )

inherited

Create a 2D histogram and add it to the TList of 2D-histograms.

Definition at line 74 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH2F* h = new TH2F(name, title, nbinsX, binsX, nbinsY, binsY);
 
  h->GetXaxis()->SetTitle(titleX);
  h->GetYaxis()->SetTitle(titleY);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogram2D() [2/2]

TH2F * createHistogram2D ( const char *  name, const char *  title, Int_t  nbinsX, Double_t  minX, Double_t  maxX, const char *  titleX, Int_t  nbinsY, Double_t  minY, Double_t  maxY, const char *  titleY, TList *  histoList = nullptr  )

inherited

Create a 2D histogram and add it to the TList of 2D-histograms.

Create 2D histogram

Definition at line 56 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH2F* h = new TH2F(name, title, nbinsX, minX, maxX, nbinsY, minY, maxY);
 
  h->GetXaxis()->SetTitle(titleX);
  h->GetYaxis()->SetTitle(titleY);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogram3D() [1/2]

TH3F * createHistogram3D ( const char *  name, const char *  title, Int_t  nbinsX, Double_t *  binsX, const char *  titleX, Int_t  nbinsY, Double_t *  binsY, const char *  titleY, Int_t  nbinsZ, Double_t *  binsZ, const char *  titleZ, TList *  histoList = nullptr  )

inherited

Create a 3D histogram and add it to the TList of 3D-histograms.

Definition at line 115 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH3F* h = new TH3F(name, title, nbinsX, binsX, nbinsY, binsY, nbinsZ, binsZ);
 
  h->GetXaxis()->SetTitle(titleX);
  h->GetYaxis()->SetTitle(titleY);
  h->GetZaxis()->SetTitle(titleZ);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogram3D() [2/2]

TH3F * createHistogram3D ( const char *  name, const char *  title, Int_t  nbinsX, Double_t  minX, Double_t  maxX, const char *  titleX, Int_t  nbinsY, Double_t  minY, Double_t  maxY, const char *  titleY, Int_t  nbinsZ, Double_t  minZ, Double_t  maxZ, const char *  titleZ, TList *  histoList = nullptr  )

inherited

Create a 3D histogram and add it to the TList of 3D-histograms.

Definition at line 93 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH3F* h = new TH3F(name, title, nbinsX, minX, maxX, nbinsY, minY, maxY, nbinsZ, minZ, maxZ);
 
  h->GetXaxis()->SetTitle(titleX);
  h->GetYaxis()->SetTitle(titleY);
  h->GetZaxis()->SetTitle(titleZ);
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

createHistogramsRatio()

TH1F * createHistogramsRatio ( const char *  name, const char *  title, TH1 *  hNum, TH1 *  hDen, bool  isEffPlot, int  axisRef  )

inherited

Make a new 1D histogram from the ratio of two others and add it to the TList of 1D-histograms.

Definition at line 170 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH1F* h1den =  dynamic_cast<TH1F*>(hDen);
  TH1F* h1num =  dynamic_cast<TH1F*>(hNum);
  TH2F* h2den =  dynamic_cast<TH2F*>(hDen);
  TH2F* h2num =  dynamic_cast<TH2F*>(hNum);
  TH3F* h3den =  dynamic_cast<TH3F*>(hDen);
  TH3F* h3num =  dynamic_cast<TH3F*>(hNum);
 
  TH1* hden = 0;
  TH1* hnum = 0;
 
  if (h1den) {
    hden = new TH1F(*h1den);
    hnum = new TH1F(*h1num);
  }
  if (h2den) {
    hden = new TH2F(*h2den);
    hnum = new TH2F(*h2num);
  }
  if (h3den) {
    hden = new TH3F(*h3den);
    hnum = new TH3F(*h3num);
  }
 
  TAxis* the_axis;
  TAxis* the_other1;
  TAxis* the_other2;
 
  if (axisRef == 0) {
    the_axis = hden->GetXaxis();
    the_other1 = hden->GetYaxis();
    the_other2 = hden->GetZaxis();
  } else if (axisRef == 1) {
    the_axis = hden->GetYaxis();
    the_other1 = hden->GetXaxis();
    the_other2 = hden->GetZaxis();
  } else if (axisRef == 2) {
    the_axis = hden->GetZaxis();
    the_other1 = hden->GetXaxis();
    the_other2 = hden->GetYaxis();
  } else
    return nullptr;
 
 
  TH1F* h;
  if (the_axis->GetXbins()->GetSize())
    h = new TH1F(name, title, the_axis->GetNbins(), (the_axis->GetXbins())->GetArray());
  else
    h = new TH1F(name, title, the_axis->GetNbins(), the_axis->GetXmin(), the_axis->GetXmax());
  h->GetXaxis()->SetTitle(the_axis->GetTitle());
 
  h->GetYaxis()->SetRangeUser(0.00001, 1);
 
  Int_t bin = 0;
 
  for (int the_bin = 1; the_bin < the_axis->GetNbins() + 1; the_bin++) {
 
    double num = 0;
    double den = 0;
 
    for (int other1_bin = 1; other1_bin < the_other1->GetNbins() + 1; other1_bin++)
      for (int other2_bin = 1; other2_bin < the_other2->GetNbins() + 1; other2_bin++) {
 
        if (axisRef == 0) bin = hden->GetBin(the_bin, other1_bin, other2_bin);
        else if (axisRef == 1) bin = hden->GetBin(other1_bin, the_bin, other2_bin);
        else if (axisRef == 2) bin = hden->GetBin(other1_bin, other2_bin, the_bin);
 
        if (hden->IsBinUnderflow(bin))
          B2INFO("  bin = " << bin << "(" << the_bin << "," << other1_bin << "," << other2_bin << "), UNDERFLOW");
        if (hden->IsBinOverflow(bin))
          B2INFO("  bin = " << bin << "(" << the_bin << "," << other1_bin << "," << other2_bin << "), OVERFLOW");
 
        num += hnum->GetBinContent(bin);
        den += hden->GetBinContent(bin);
      }
 
    double eff = 0;
    double err = 0;
 
    if (den > 0) {
      eff = (double)num / den;
      err = sqrt(eff * (1 - eff)) / sqrt(den);
    }
 
    if (isEffPlot) {
      h->SetBinContent(the_bin, eff);
      h->SetBinError(the_bin, err);
    } else {
      h->SetBinContent(the_bin, 1 - eff);
      h->SetBinError(the_bin, err);
    }
  }
 
  return h;
 
}

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

duplicateHistogram()

TH1 * duplicateHistogram ( const char *  newname, const char *  newtitle, TH1 *  h, TList *  histoList = nullptr  )

inherited

Make a copy of a 1D histogram and add it to the TList of 1D-histograms.

Definition at line 137 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH1F* h1 =  dynamic_cast<TH1F*>(h);
  TH2F* h2 =  dynamic_cast<TH2F*>(h);
  TH3F* h3 =  dynamic_cast<TH3F*>(h);
 
  TH1* newh = nullptr;
 
  if (h1)
    newh = new TH1F(*h1);
  if (h2)
    newh = new TH2F(*h2);
  if (h3)
    newh = new TH3F(*h3);
 
  if (newh == nullptr) {
    B2ERROR("In function duplicateHistogram: newh is a nullptr. This shouldn't happen."\
            "Don't continue creation of duplicate histogram in this case and return nullptr.");
    return nullptr;
  }
 
  newh->SetName(newname);
  newh->SetTitle(newtitle);
 
  if (histoList)
    histoList->Add(newh);
 
 
  return newh;
}

effPlot1D() [1/2]

TH1F * effPlot1D ( TH1F *  h1_den, TH1F *  h1_num, const char *  name, const char *  title, bool  geo_accettance, TList *  histoList = nullptr  )

inherited

Create a 1D efficiency histogram and add it to the TList of 1D-histograms.

Definition at line 332 of file PerformanceEvaluationBaseClass.cc.

{
  if (h1_den == nullptr or h1_num == nullptr) {
    B2ERROR("One of the input histograms for function effPlot1D is a nullptr, "\
            "can't create new histograms from this. Returning a nullptr.");
    return nullptr;
  }
 
  std::string total;
  std::string trueTitle;
 
  if (geo_accettance == false) {
    std::string name1 = "_noGeoAcc";
    total = std::string(name) + name1;
    trueTitle = std::string(title) + name1;
  } else {
    std::string name2 = "_withGeoAcc";
    total = std::string(name) + name2;
    trueTitle = std::string(title) + name2;
  }
 
  TH1F* h = (TH1F*)duplicateHistogram(total.c_str(), trueTitle.c_str(), h1_den, histoList);
  h->GetYaxis()->SetRangeUser(0., 1);
 
  for (int bin = 0; bin < h->GetXaxis()->GetNbins(); bin++) {
    float num = h1_num->GetBinContent(bin + 1);
    float den = h1_den->GetBinContent(bin + 1);
    double eff = 0.;
    double err = 0.;
 
    if (den > 0) {
      eff = (double)num / den;
      err = sqrt(eff * (1 - eff)) / sqrt(den);
    }
    h->SetBinContent(bin + 1, eff);
    h->SetBinError(bin + 1, err);
  }
 
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

effPlot1D() [2/2]

TH1F * effPlot1D ( TH1F *  h1_MC, TH1F *  h1_RecoTrack, TH1F *  h1_Track, const char *  name, const char *  title, TList *  histoList = nullptr  )

inherited

Create a 1D efficiency histogram and add it to the TList of 1D-histograms.

Definition at line 378 of file PerformanceEvaluationBaseClass.cc.

{
  if (h1_MC == nullptr or h1_RecoTrack == nullptr or h1_Track == nullptr) {
    B2ERROR("One of the input histograms for function effPlot1D is a nullptr, "\
            "can't create new histograms from this. Returning a nullptr.");
    return nullptr;
  }
 
  std::string name1 = "_noGeoAcc";
  std::string name2 = "_withGeoAcc";
 
  std::string total1 = std::string(name) + name1;
  std::string total2 = std::string(name) + name2;
 
  std::string title1 = std::string(title) + name1;
  std::string title2 = std::string(title) + name2;
 
  TH1F* h[2];
 
  h[0] = (TH1F*)duplicateHistogram(total2.c_str(), title2.c_str(), h1_RecoTrack, histoList);
  h[0]->GetYaxis()->SetRangeUser(0., 1);
 
  for (int bin = 0; bin < h[0]->GetXaxis()->GetNbins(); bin++) {
    float num = h1_Track->GetBinContent(bin + 1);
    float den = h1_RecoTrack->GetBinContent(bin + 1);
    double eff = 0.;
    double err = 0.;
 
    if (den > 0) {
      eff = (double)num / den;
      err = sqrt(eff * (1 - eff)) / sqrt(den);
    }
    h[0]->SetBinContent(bin + 1, eff);
    h[0]->SetBinError(bin + 1, err);
  }
 
  h[1] = (TH1F*)duplicateHistogram(total1.c_str(), title1.c_str(), h1_MC, histoList);
  h[1]->GetYaxis()->SetRangeUser(0., 1);
 
  for (int bin = 0; bin < h[1]->GetXaxis()->GetNbins(); bin++) {
    float num = h1_Track->GetBinContent(bin + 1);
    float den = h1_MC->GetBinContent(bin + 1);
    double eff = 0.;
    double err = 0.;
 
    if (den > 0) {
      eff = (double)num / den;
      err = sqrt(eff * (1 - eff)) / sqrt(den);
    }
    h[1]->SetBinContent(bin + 1, eff);
    h[1]->SetBinError(bin + 1, err);
  }
 
  if (histoList) {
    histoList->Add(h[0]);
    histoList->Add(h[1]);
  }
 
  return *h;
}

effPlot2D() [1/2]

TH2F * effPlot2D ( TH2F *  h2_den, TH2F *  h2_num, const char *  name, const char *  title, bool  geo_accettance, TList *  histoList = nullptr  )

inherited

Create a 2D efficiency histogram and add it to the TList of 2D-histograms.

Definition at line 440 of file PerformanceEvaluationBaseClass.cc.

{
  if (h2_den == nullptr or h2_num == nullptr) {
    B2ERROR("One of the input histograms for function effPlot1D is a nullptr, "\
            "can't create new histograms from this. Returning a nullptr.");
    return nullptr;
  }
 
  std::string err_char = "_error_";
  std::string addTitle = "Errors, ";
 
  std::string total;
  std::string error;
  std::string trueTitle;
 
  std::string titleErr = addTitle + std::string(title);
 
  if (geo_accettance == false) {
    std::string name1 = "_noGeoAcc";
    total = std::string(name) + name1;
    trueTitle = std::string(title) + name1;
    error = std::string(name) + err_char + std::string(name1);
  } else {
    std::string name2 = "_withGeoAcc";
    total = std::string(name) + name2;
    trueTitle = std::string(title) + name2;
    error = std::string(name) + err_char + std::string(name2);
  }
 
  TH2F* h2[2];
  h2[0] = (TH2F*)duplicateHistogram(total.c_str(), trueTitle.c_str(), h2_den, histoList);
  h2[1] = (TH2F*)duplicateHistogram(error.c_str(), titleErr.c_str(), h2_den, histoList);
 
  for (int binX = 0; binX < h2[0]->GetXaxis()->GetNbins(); binX++) {
    for (int binY = 0; binY < h2[0]->GetYaxis()->GetNbins(); binY++) {
      float num = h2_num->GetBinContent(binX + 1, binY + 1);
      float den = h2_den->GetBinContent(binX + 1, binY + 1);
      double eff = 0.;
      double err = 0.;
 
      if (den > 0) {
        eff = (double)num / den;
        err = sqrt(eff * (1 - eff)) / sqrt(den);
      }
 
      h2[0]->SetBinContent(binX + 1, binY + 1, eff);
      h2[0]->SetBinError(binX + 1, binY + 1, err);
      h2[1]->SetBinContent(binX + 1, binY + 1, err);
    }
  }
 
 
  if (histoList) {
    histoList->Add(h2[0]);
    histoList->Add(h2[1]);
  }
 
  return *h2;
 
}

effPlot2D() [2/2]

TH2F * effPlot2D ( TH2F *  h2_MC, TH2F *  h2_RecoTrack, TH2F *  h2_Track, const char *  name, const char *  title, TList *  histoList  )

inherited

Create a 2D efficiency histogram and add it to the TList of 2D-histograms.

Definition at line 502 of file PerformanceEvaluationBaseClass.cc.

{
  if (h2_MC == nullptr or h2_RecoTrack == nullptr or h2_Track == nullptr) {
    B2ERROR("One of the input histograms for function effPlot1D is a nullptr, "\
            "can't create new histograms from this. Returning a nullptr.");
    return nullptr;
  }
 
  std::string name1 = "_noGeoAcc";
  std::string name2 = "_withGeoAcc";
  std::string err_char = "_error_";
  std::string addTitle = "Errors, ";
 
  std::string total1 = std::string(name) + name1;
  std::string total2 = std::string(name) + name2;
 
  std::string title1 = std::string(title) + name1;
  std::string title2 = std::string(title) + name2;
 
  std::string error1 = std::string(name) + err_char + name1;
  std::string error2 = std::string(name) + err_char + name2;
  std::string titleErr = addTitle + std::string(title);
 
  TH2F* h2[4];
 
  h2[0] = (TH2F*)duplicateHistogram(total2.c_str(), title2.c_str(), h2_RecoTrack, histoList);
  h2[1] = (TH2F*)duplicateHistogram(error2.c_str(), titleErr.c_str(), h2_RecoTrack, histoList);
 
  for (int binX = 0; binX < h2[0]->GetXaxis()->GetNbins(); binX++) {
    for (int binY = 0; binY < h2[0]->GetYaxis()->GetNbins(); binY++) {
      float num = h2_Track->GetBinContent(binX + 1, binY + 1);
      float den = h2_RecoTrack->GetBinContent(binX + 1, binY + 1);
      double eff = 0.;
      double err = 0.;
 
      if (den > 0) {
        eff = num / den;
        err = sqrt(eff * (1 - eff)) / sqrt(den);
      }
 
      h2[0]->SetBinContent(binX + 1, binY + 1, eff);
      h2[0]->SetBinError(binX + 1, binY + 1, err);
      h2[1]->SetBinContent(binX + 1, binY + 1, err);
    }
  }
 
  h2[2] = (TH2F*)duplicateHistogram(total1.c_str(), title1.c_str(), h2_MC, histoList);
  h2[3] = (TH2F*)duplicateHistogram(error1.c_str(), titleErr.c_str(), h2_MC, histoList);
 
  for (int binX = 0; binX < h2[2]->GetXaxis()->GetNbins(); binX++) {
    for (int binY = 0; binY < h2[2]->GetYaxis()->GetNbins(); binY++) {
      float num = h2_Track->GetBinContent(binX + 1, binY + 1);
      float den = h2_MC->GetBinContent(binX + 1, binY + 1);
      double eff = 0.;
      double err = 0.;
 
      if (den > 0) {
        eff = num / den;
        err = sqrt(eff * (1 - eff)) / sqrt(den);
      }
 
      h2[2]->SetBinContent(binX + 1, binY + 1, eff);
      h2[2]->SetBinError(binX + 1, binY + 1, err);
      h2[3]->SetBinContent(binX + 1, binY + 1, err);
    }
  }
 
  if (histoList) {
    histoList->Add(h2[0]);
    histoList->Add(h2[1]);
    histoList->Add(h2[2]);
    histoList->Add(h2[3]);
  }
 
  return *h2;
}

endRun()

void endRun ( void  )

overridevirtual

This method is called if the current run ends.

Reimplemented from Module.

Definition at line 256 of file V0findingPerformanceEvaluationModule.cc.

{
 
  double num = 0;
  double den = 0;
 
  for (int bin = 1; bin < m_multiplicityV0s->GetNbinsX(); bin ++)
    num += m_multiplicityV0s->GetBinContent(bin + 1);
  den = m_multiplicityV0s->GetEntries();
  double efficiency = num / den ;
  double efficiencyErr =  sqrt(efficiency * (1 - efficiency)) / sqrt(den);
 
  double nMCParticles = 0;
  for (int bin = 1; bin < m_multiplicityMCParticles->GetNbinsX(); bin ++)
    nMCParticles += m_multiplicityMCParticles->GetBinContent(bin + 1);
  double purity = nMCParticles / m_multiplicityMCParticles->GetEntries();
  double purityErr =  sqrt(purity * (1 - purity)) / sqrt(m_multiplicityMCParticles->GetEntries());
 
  B2INFO("");
  B2INFO("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
  B2INFO("~ V0 Finding Performance Evaluation ~ SHORT SUMMARY ~");
  B2INFO("");
  B2INFO(" + overall:");
  B2INFO("   efficiency = (" << efficiency * 100 << " +/- " << efficiencyErr * 100 << ")% ");
  B2INFO("       purity = (" << purity * 100 << " +/- " << purityErr * 100 << ")% ");
  B2INFO("");
  B2INFO("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
}

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

This method is called for each event.

Reimplemented from Module.

Definition at line 151 of file V0findingPerformanceEvaluationModule.cc.

{
 
  ROOT::Math::XYZVector magField = BFieldManager::getField(0, 0, 0) / Unit::T;
 
  B2DEBUG(29, "+++++ 1. loop on MCParticles");
  for (const MCParticle& mcParticle : m_MCParticles) {
 
    if (! isV0(mcParticle))
      continue;
 
    int nMatchedDau =  nMatchedDaughters(mcParticle);
    m_h1_nMatchedDau->Fill(nMatchedDau);
 
    //proceed only in case the MCParticle daughters have both one associated reconstructed track:
    if (nMatchedDau != 2)
      continue;
 
    int pdgCode = mcParticle.getPDG();
    B2DEBUG(29, "MCParticle has PDG code " << pdgCode);
    m_MCParticlePDGcode->Fill(mcParticle.getPDG());
 
    MCParticleInfo mcParticleInfo(mcParticle, magField);
 
    ROOT::Math::XYZVector MC_prodvtx = mcParticle.getVertex();
    ROOT::Math::XYZVector MC_vtx = mcParticle.getDecayVertex();
    float MC_mom = mcParticle.getMomentum().R();
    float MC_mass = mcParticle.getMass();
    ROOT::Math::XYZVector MC_FL = MC_vtx - MC_prodvtx;
    float flightR = sqrt(MC_FL.X() * MC_FL.X() + MC_FL.Y() * MC_FL.Y());
    m_h1_MCParticle_R->Fill(flightR);
 
    m_h3_MCParticle->Fill(mcParticleInfo.getPt(), mcParticleInfo.getPtheta(), mcParticleInfo.getPphi());
 
    //1. retrieve all the V0s related to the MCParticle
 
    //1.0 check if there is a V0
    RelationVector<V0ValidationVertex> V0s_toMCParticle =
      DataStore::getRelationsWithObj<V0ValidationVertex>(&mcParticle, m_V0sName);
 
    m_multiplicityV0s->Fill(V0s_toMCParticle.size());
 
    if (V0s_toMCParticle.size() > 0)
      m_h3_V0sPerMCParticle->Fill(mcParticleInfo.getPt(), mcParticleInfo.getPtheta(), mcParticleInfo.getPphi());
 
    for (int v0 = 0; v0 < (int)V0s_toMCParticle.size(); v0++) {
 
      ROOT::Math::XYZVector V0_vtx = V0s_toMCParticle[v0]->getVertexPosition();
      float V0_mom = V0s_toMCParticle[v0]->getFittedMomentum();
      float V0_chi2 = V0s_toMCParticle[v0]->getVertexChi2();
      float V0_mass = V0s_toMCParticle[v0]->getFittedInvariantMass();
      TMatrixDSym V0_cov = V0s_toMCParticle[v0]->getVertexPositionCovariance();
 
      m_h1_vtxX_err->Fill(sqrt(V0_cov[0][0]));
      m_h1_vtxY_err->Fill(sqrt(V0_cov[1][1]));
      m_h1_vtxZ_err->Fill(sqrt(V0_cov[2][2]));
      m_h2_vtxTvsR_err->Fill(flightR, sqrt(V0_cov[0][0] + V0_cov[1][1]));
 
      m_h1_V0sPerMCParticle_R->Fill(flightR);
 
      m_h1_vtxX_res->Fill(V0_vtx.X() -  MC_vtx.X());
      m_h1_vtxY_res->Fill(V0_vtx.Y() -  MC_vtx.Y());
      m_h1_vtxZ_res->Fill(V0_vtx.Z() -  MC_vtx.Z());
 
      m_h1_mom_res->Fill(V0_mom -  MC_mom);
      m_h2_mom->Fill(V0_mom, MC_mom);
      m_h1_mass_res->Fill(V0_mass -  MC_mass);
      m_h2_mass->Fill(V0_mass, MC_mass);
 
      m_h1_vtxX_pll->Fill((V0_vtx.X() -  MC_vtx.X()) / sqrt(V0_cov[0][0]));
      m_h1_vtxY_pll->Fill((V0_vtx.Y() -  MC_vtx.Y()) / sqrt(V0_cov[1][1]));
      m_h1_vtxZ_pll->Fill((V0_vtx.Z() -  MC_vtx.Z()) / sqrt(V0_cov[2][2]));
 
      m_h1_ChiSquare->Fill(V0_chi2);
 
    }
 
 
  }
 
 
  B2DEBUG(29, "+++++ 2. loop on V0s");
 
  for (const V0ValidationVertex& v0 : m_V0ValidationVertices) {
 
    int nMCParticles = 0;
 
    //    m_h3_V0s>Fill(mcParticleInfo.getPt(), mcParticleInfo.getPtheta(), mcParticleInfo.getPphi());
    //2. retrieve all the MCParticles related to the V0s
    RelationVector<MCParticle> MCParticles_fromV0 =
      DataStore::getRelationsWithObj<MCParticle>(&v0, m_MCParticlesName);
 
    nMCParticles = MCParticles_fromV0.size();
 
    if (nMCParticles == 0)
      continue;
 
    MCParticleInfo mcParticleInfo(* MCParticles_fromV0[0], magField);
    m_h3_MCParticlesPerV0->Fill(mcParticleInfo.getPt(), mcParticleInfo.getPtheta(), mcParticleInfo.getPphi());
    m_multiplicityMCParticles->Fill(nMCParticles);
 
  }
 
}

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://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  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)

geoAcc1D()

TH1F * geoAcc1D ( TH1F *  h1_den, TH1F *  h1_num, const char *  name, const char *  title, TList *  histoList = nullptr  )

inherited

Create a 1D efficiency histogram for geometric acceptance and add it to the TList of 1D-histograms.

Definition at line 580 of file PerformanceEvaluationBaseClass.cc.

{
  TH1F* h = (TH1F*)duplicateHistogram(name, title, h1_den, histoList);
  h->GetYaxis()->SetRangeUser(0., 1);
 
  for (int bin = 0; bin < h->GetXaxis()->GetNbins(); bin++) {
    float num = h1_num->GetBinContent(bin + 1);
    float den = h1_den->GetBinContent(bin + 1);
    double eff = 0.;
    double err = 0.;
 
    if (den > 0) {
      eff = (double)num / den;
      err = sqrt(eff * (1 - eff)) / sqrt(den);
    }
    h->SetBinContent(bin + 1, eff);
    h->SetBinError(bin + 1, err);
  }
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

geoAcc2D()

TH2F * geoAcc2D ( TH2F *  h2_den, TH2F *  h2_num, const char *  name, const char *  title, TList *  histoList = nullptr  )

inherited

Create a 2D efficiency histogram for geometric acceptance and add it to the TList of 2D-histograms.

Definition at line 605 of file PerformanceEvaluationBaseClass.cc.

{
  std::string err_char = "_err";
  std::string addTitle = "Errors, ";
 
  std::string error = std::string(name) + err_char;
  std::string titleErr = addTitle + std::string(title);
 
  TH2F* h2[2];
  h2[0] = (TH2F*)duplicateHistogram(name, title, h2_den, histoList);
  h2[1] = (TH2F*)duplicateHistogram(error.c_str(), titleErr.c_str(), h2_den, histoList);
 
  for (int binX = 0; binX < h2[0]->GetXaxis()->GetNbins(); binX++) {
    for (int binY = 0; binY < h2[0]->GetYaxis()->GetNbins(); binY++) {
      float num = h2_num->GetBinContent(binX + 1, binY + 1);
      float den = h2_den->GetBinContent(binX + 1, binY + 1);
      double eff = 0.;
      double err = 0.;
 
      if (den > 0) {
        eff = (double)num / den;
        err = sqrt(eff * (1 - eff)) / sqrt(den);
      }
      h2[0]->SetBinContent(binX + 1, binY + 1, eff);
      h2[0]->SetBinError(binX + 1, binY + 1, err);
      h2[1]->SetBinContent(binX + 1, binY + 1, err);
    }
  }
 
  if (histoList) {
    histoList->Add(h2[0]);
    histoList->Add(h2[1]);
  }
 
  return *h2;
 
}

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://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( void  )

overridevirtual

Initializer.

Reimplemented from Module.

Definition at line 52 of file V0findingPerformanceEvaluationModule.cc.

{
  m_MCParticles.isRequired(m_MCParticlesName);
  m_V0ValidationVertices.isRequired(m_V0sName);
 
  //create list of histograms to be saved in the rootfile
  m_histoList = new TList;
  m_histoList_multiplicity = new TList;
  m_histoList_efficiency = new TList;
  m_histoList_purity = new TList;
  m_histoList_trkQuality = new TList;
 
  //set the ROOT File
  m_rootFilePtr = new TFile(m_rootFileName.c_str(), "RECREATE");
 
  //now create histograms
 
  //multiplicity histograms
  m_multiplicityV0s = createHistogram1D("h1nV0", "number of V0s per MC Particle", 8, -0.5, 7.5, "# V0s", m_histoList_multiplicity);
 
  m_multiplicityMCParticles = createHistogram1D("h1nMCPrtcl", "number of MCParticles per V0s", 5, -0.5, 4.5,
                                                "# MCParticles", m_histoList_multiplicity);
 
  m_MCParticlePDGcode = createHistogram1D("h1PDGcode", "PDG code of MCParticles", 6244, Const::antiLambda.getPDGCode(),
                                          Const::Lambda.getPDGCode(),
                                          "PDG code", m_histoList_multiplicity);
 
 
  //vertex and momentum parameters errors
  m_h1_vtxX_err = createHistogram1D("h1vtxXerr", "vtxX error", 100, 0, 0.1, "#sigma_{vtxX} (cm)", m_histoList);
  m_h1_vtxY_err = createHistogram1D("h1vtxYerr", "vtxY error", 100, 0, 0.1, "#sigma_{vtxY} (cm)", m_histoList);
  m_h1_vtxZ_err = createHistogram1D("h1vtxZerr", "vtxZ error", 100, 0, 0.3, "#sigma_{vtxZ} (cm)", m_histoList);
  m_h2_vtxTvsR_err = createHistogram2D("h2vtxTerrVsR", "vtxT error vs R", 100, 0, 100, "R (cm)", 100, 0, 0.3, "#sigma_{vtxT} (cm)",
                                       m_histoList);
  //  m_h1_mom_err = createHistogram1D("h1momerr", "mom error", 100, 0, 0.1, "#sigma_{p} (GeV/c)", m_histoList);
  //  m_h1_mass_err = createHistogram1D("h1masserr", "mass error", 100, 0, 1, "#sigma_{m} (GeV/c2)", m_histoList);
  //vertex and momentum parameters residuals
  m_h1_vtxX_res = createHistogram1D("h1vtxXres", "vtxX resid", 100, -0.2, 0.2, "vtxX resid (cm)", m_histoList);
  m_h1_vtxY_res = createHistogram1D("h1vtxYres", "vtxY resid", 100, -0.2, 0.2, "vtxY resid (cm)", m_histoList);
  m_h1_vtxZ_res = createHistogram1D("h1vtxZres", "vtxZ resid", 100, -0.5, 0.5, "vtxZ resid (cm)", m_histoList);
  m_h1_mom_res = createHistogram1D("h1momres", "mom resid", 1000, -0.5, 0.5, "mom resid (GeV/c)", m_histoList);
  m_h1_mass_res = createHistogram1D("h1massres", "mass resid", 500, -0.3, 0.3, "mass resid (GeV/c)", m_histoList);
 
  //vertex and momentum parameters pulls
  m_h1_vtxX_pll = createHistogram1D("h1vtxXpll", "vtxX pull", 100, -5, 5, "vtxX pull", m_histoList);
  m_h1_vtxY_pll = createHistogram1D("h1vtxYpll", "vtxY pull", 100, -5, 5, "vtxY pull", m_histoList);
  m_h1_vtxZ_pll = createHistogram1D("h1vtxZpll", "vtxZ pull", 100, -5, 5, "vtxZ pull", m_histoList);
  //  m_h1_mom_pll = createHistogram1D("h1mompll", "mom pull", 100, -5, 5, "momX pull", m_histoList);
  //  m_h1_mass_pll = createHistogram1D("h1masspll", "mass pull", 100, -5, 5, "momY pull", m_histoList);
 
 
  m_h1_ChiSquare = createHistogram1D("h1Chi2", "Chi2 of the fit", 100, 0, 20, "Chi2", m_histoList_trkQuality);
 
  m_h1_nMatchedDau = createHistogram1D("h1nMatchedDau", "Number of Matched MCParticle Daughters", 3, -0.5, 2.5, "# matched dau",
                                       m_histoList);
 
 
  m_h2_mom = createHistogram2D("h2mom", "reco VS true momentum", 100, 0, 3, "V0 mom (GeV/c)", 100, 0, 3, "MC mom (GeV/c)",
                               m_histoList);
  m_h2_mass = createHistogram2D("h2mass", "reco VS true mass", 100, 0, 1.5, "V0 mass (GeV/c2)", 100, 0, 1.5, "MC mass (GeV/c)",
                                m_histoList);
 
  //histograms to produce efficiency plots
  Double_t bins_pt[9 + 1] = {0, 0.05, 0.1, 0.15, 0.2, 0.3, 0.5, 1, 2, 3.5}; //GeV/c
  Double_t bins_theta[10 + 1] = {0, 0.25, 0.5, 0.75, 0.75 + 0.32, 0.75 + 2 * 0.32, 0.75 + 3 * 0.32, 0.75 + 4 * 0.32, 0.75 + 5 * 0.32, 2.65, M_PI};
  Double_t bins_phi[14 + 1];
  Double_t width_phi = 2 * M_PI / 14;
  for (int bin = 0; bin < 14 + 1; bin++)
    bins_phi[bin] = - M_PI + bin * width_phi;
 
  m_h1_MCParticle_R = createHistogram1D("h1nMCParticleVSr", "entry per MCParticles", 50, 0, 20, "transverse L", m_histoList);
 
  m_h1_V0sPerMCParticle_R = (TH1F*)duplicateHistogram("h1nV0perMCvsR", "entry per V0 related to a MCParticle",   m_h1_MCParticle_R,
                                                      m_histoList);
 
 
  m_h3_MCParticle = createHistogram3D("h3MCParticle", "entry per MCParticle",
                                      9, bins_pt, "p_{t} (GeV/c)",
                                      10, bins_theta, "#theta",
                                      14, bins_phi, "#phi" /*, m_histoList*/);
 
  m_h3_V0sPerMCParticle = (TH3F*)duplicateHistogram("h3V0sPerMCParticle",
                                                    "entry per V0 connected to a MCParticle",
                                                    m_h3_MCParticle /*, m_histoList*/);
 
  m_h3_V0s = (TH3F*)duplicateHistogram("h3V0s", "entry per V0",
                                       m_h3_MCParticle /*, m_histoList*/);
 
  //histograms to produce purity plots
  m_h3_MCParticlesPerV0 = (TH3F*)duplicateHistogram("h3MCParticlesPerV0",
                                                    "entry per MCParticle connected to a V0",
                                                    m_h3_MCParticle /*, m_histoList*/);
}

isV0()

bool isV0 ( const MCParticle &  the_mcParticle )

private

is V0

Definition at line 352 of file V0findingPerformanceEvaluationModule.cc.

{
 
  bool isGamma = false;
  if (abs(the_mcParticle.getPDG()) == Const::photon.getPDGCode())
    isGamma = true;
 
  bool isK_S0 = false;
  if (abs(the_mcParticle.getPDG()) == Const::Kshort.getPDGCode())
    isK_S0 = true;
 
  bool isK_0 = false;
  if (abs(the_mcParticle.getPDG()) == 311)
    isK_0 = true;
 
  bool isLambda = false;
  if (abs(the_mcParticle.getPDG()) == Const::Lambda.getPDGCode())
    isLambda = true;
 
  bool twoProngs = false;
  bool twoChargedProngs = false;
 
  if (the_mcParticle.getDaughters().size() == 2)
    twoProngs = true;
 
  if (twoProngs)
    if (the_mcParticle.getDaughters()[0]->getCharge() *  the_mcParticle.getDaughters()[1]->getCharge() < 0)
      twoChargedProngs = true;
 
  return ((isGamma || isK_S0 || isK_0 || isLambda) && twoChargedProngs);
 
}

nMatchedDaughters()

int nMatchedDaughters ( const MCParticle &  the_mcParticle )

private

number of truth matched dauhters

Definition at line 385 of file V0findingPerformanceEvaluationModule.cc.

{
 
  int nMatchedDau = 0;
 
  std::vector< MCParticle* > MCPart_dau = the_mcParticle.getDaughters();
 
  bool first = false;
  bool second = false;
 
  RelationVector<Track> Tracks_fromMCParticle_0 = DataStore::getRelationsWithObj<Track>(MCPart_dau[0]);
  if (Tracks_fromMCParticle_0.size() > 0)
    first = true;
 
  RelationVector<Track> Tracks_fromMCParticle_1 = DataStore::getRelationsWithObj<Track>(MCPart_dau[1]);
  if (Tracks_fromMCParticle_1.size() > 0)
    second = true;
 
 
  if (first)
    nMatchedDau++;
 
  if (second)
    nMatchedDau++;
 
 
  return nMatchedDau;
 
}

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

This method is called at the end of the event processing.

Reimplemented from Module.

Definition at line 285 of file V0findingPerformanceEvaluationModule.cc.

{
 
  TH1F* h_eff_R   = (TH1F*)duplicateHistogram("h_eff_R", "efficiency vs R", m_h1_MCParticle_R, m_histoList_efficiency);
 
  for (int bin = 0; bin < h_eff_R->GetXaxis()->GetNbins(); bin++) {
    float num = m_h1_V0sPerMCParticle_R->GetBinContent(bin + 1);
    float den = m_h1_MCParticle_R->GetBinContent(bin + 1);
    double eff = 0;
    double err = 0;
 
    if (den > 0) {
      eff = (double)num / den;
      err = sqrt(eff * (1 - eff)) / sqrt(den);
    }
 
    h_eff_R->SetBinContent(bin + 1, eff);
    h_eff_R->SetBinError(bin + 1, err);
  }
 
  addEfficiencyPlots(m_histoList_efficiency, m_h3_V0sPerMCParticle, m_h3_MCParticle);
 
  addInefficiencyPlots(m_histoList_efficiency, m_h3_V0sPerMCParticle, m_h3_MCParticle);
 
  //  addPurityPlots(m_histoList_purity, m_h3_MCParticlesPerV0, m_h3_V0s);
 
  if (m_rootFilePtr != nullptr) {
    m_rootFilePtr->cd();
 
    TDirectory* oldDir = gDirectory;
 
    TDirectory* dir_multiplicity = oldDir->mkdir("multiplicity");
    dir_multiplicity->cd();
    TIter nextH_multiplicity(m_histoList_multiplicity);
    TObject* obj;
    while ((obj = nextH_multiplicity()))
      obj->Write();
 
    TDirectory* dir_efficiency = oldDir->mkdir("efficiency");
    dir_efficiency->cd();
    TIter nextH_efficiency(m_histoList_efficiency);
    while ((obj = nextH_efficiency()))
      obj->Write();
 
    TDirectory* dir_purity = oldDir->mkdir("purity");
    dir_purity->cd();
    TIter nextH_purity(m_histoList_purity);
    while ((obj = nextH_purity()))
      obj->Write();
 
    TDirectory* dir_trkQuality = oldDir->mkdir("trkQuality");
    dir_trkQuality->cd();
    TIter nextH_trkQuality(m_histoList_trkQuality);
    while ((obj = nextH_trkQuality()))
      obj->Write();
 
    TIter nextH(m_histoList);
    while ((obj = nextH()))
      obj->Write();
 
 
    m_rootFilePtr->Close();
  }
 
}

V0FinderEff()

TH1F * V0FinderEff ( TH1F *  h1_dau0, TH1F *  h1_dau1, TH1F *  h1_Mother, const char *  name, const char *  title, TList *  histoList = nullptr  )

inherited

Create a 1D efficiency histogram for V0 finding and add it to the TList of 1D-histograms.

Definition at line 644 of file PerformanceEvaluationBaseClass.cc.

{
 
  TH1F* h = (TH1F*)duplicateHistogram(name, title, h1_Mother, histoList);
  h->GetYaxis()->SetRangeUser(0., 1);
 
  for (int bin = 0; bin < h->GetXaxis()->GetNbins(); bin++) {
    double dau0 = h1_dau0->GetBinContent(bin);
    double dau1 = h1_dau1->GetBinContent(bin);
    double Mother = h1_Mother->GetBinContent(bin);
    double dau0Err = h1_dau0->GetBinError(bin);
    double dau1Err = h1_dau1->GetBinError(bin);
    double MotherErr = h1_Mother->GetBinError(bin);
 
    double binCont = 1. * Mother / dau0 / dau1;
    double binErr = binCont * sqrt((dau0Err / dau0) * (dau0Err / dau0) + (dau1Err / dau1) * (dau1Err / dau1) * (MotherErr / Mother) *
                                   (MotherErr / Mother));
 
    h->SetBinContent(bin, binCont);
    h->SetBinError(bin, binErr);
  }
 
  if (histoList)
    histoList->Add(h);
 
  return h;
}

Member Data Documentation

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_h1_ChiSquare

TH1F* m_h1_ChiSquare = nullptr

private

TH1F chi square.

Definition at line 112 of file V0findingPerformanceEvaluationModule.h.

m_h1_mass_res

TH1F* m_h1_mass_res = nullptr

private

mom resid

Definition at line 103 of file V0findingPerformanceEvaluationModule.h.

m_h1_MCParticle_R

TH1F* m_h1_MCParticle_R = nullptr

private

V0-finding denominator by radius.

Definition at line 119 of file V0findingPerformanceEvaluationModule.h.

m_h1_mom_res

TH1F* m_h1_mom_res = nullptr

private

mom resid

Definition at line 101 of file V0findingPerformanceEvaluationModule.h.

m_h1_nMatchedDau

TH1F* m_h1_nMatchedDau = nullptr

private

TH1F n matched daughters.

Definition at line 114 of file V0findingPerformanceEvaluationModule.h.

m_h1_V0sPerMCParticle_R

TH1F* m_h1_V0sPerMCParticle_R = nullptr

private

V0-finding numerator by radius.

Definition at line 120 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxX_err

TH1F* m_h1_vtxX_err = nullptr

private

vtx error

Definition at line 91 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxX_pll

TH1F* m_h1_vtxX_pll = nullptr

private

vtx pull

Definition at line 106 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxX_res

TH1F* m_h1_vtxX_res = nullptr

private

vtx resid

Definition at line 98 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxY_err

TH1F* m_h1_vtxY_err = nullptr

private

vtx error

Definition at line 92 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxY_pll

TH1F* m_h1_vtxY_pll = nullptr

private

vtx pull

Definition at line 107 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxY_res

TH1F* m_h1_vtxY_res = nullptr

private

vtx resid

Definition at line 99 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxZ_err

TH1F* m_h1_vtxZ_err = nullptr

private

vtx error

Definition at line 93 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxZ_pll

TH1F* m_h1_vtxZ_pll = nullptr

private

vtx pull

Definition at line 108 of file V0findingPerformanceEvaluationModule.h.

m_h1_vtxZ_res

TH1F* m_h1_vtxZ_res = nullptr

private

vtx resid

Definition at line 100 of file V0findingPerformanceEvaluationModule.h.

m_h2_mass

TH2F* m_h2_mass = nullptr

private

mass reco VS true

Definition at line 104 of file V0findingPerformanceEvaluationModule.h.

m_h2_mom

TH2F* m_h2_mom = nullptr

private

mom reco VS true

Definition at line 102 of file V0findingPerformanceEvaluationModule.h.

m_h2_vtxTvsR_err

TH2F* m_h2_vtxTvsR_err = nullptr

private

vtx error on transverse plane VS transverse flight length

Definition at line 94 of file V0findingPerformanceEvaluationModule.h.

m_h3_MCParticle

TH3F* m_h3_MCParticle = nullptr

private

V0-finding denominator.

Definition at line 117 of file V0findingPerformanceEvaluationModule.h.

m_h3_MCParticlesPerV0

TH3F* m_h3_MCParticlesPerV0 = nullptr

private

V0-finding numerator.

Definition at line 124 of file V0findingPerformanceEvaluationModule.h.

m_h3_V0s

TH3F* m_h3_V0s = nullptr

private

V0-finding purity denominator.

Definition at line 123 of file V0findingPerformanceEvaluationModule.h.

m_h3_V0sPerMCParticle

TH3F* m_h3_V0sPerMCParticle = nullptr

private

V0-finding numerator.

Definition at line 118 of file V0findingPerformanceEvaluationModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_histoList

TList* m_histoList = nullptr

inherited

List of performance-evaluation histograms.

Definition at line 38 of file PerformanceEvaluationBaseClass.h.

m_histoList_efficiency

TList* m_histoList_efficiency = nullptr

inherited

List of efficiency histograms.

Definition at line 46 of file PerformanceEvaluationBaseClass.h.

m_histoList_evtCharacterization

TList* m_histoList_evtCharacterization = nullptr

inherited

List of event-characterization histograms.

Definition at line 41 of file PerformanceEvaluationBaseClass.h.

m_histoList_firstHit

TList* m_histoList_firstHit = nullptr

inherited

List of first-hit-position histograms.

Definition at line 43 of file PerformanceEvaluationBaseClass.h.

m_histoList_fit

TList* m_histoList_fit = nullptr

inherited

List of track-fit histograms.

Definition at line 45 of file PerformanceEvaluationBaseClass.h.

m_histoList_multiplicity

TList* m_histoList_multiplicity = nullptr

inherited

List of multiplicity histograms.

Definition at line 40 of file PerformanceEvaluationBaseClass.h.

m_histoList_others

TList* m_histoList_others = nullptr

inherited

List of other performance-evaluation histograms.

Definition at line 48 of file PerformanceEvaluationBaseClass.h.

m_histoList_pr

TList* m_histoList_pr = nullptr

inherited

List of pattern-recognition histograms.

Definition at line 44 of file PerformanceEvaluationBaseClass.h.

m_histoList_purity

TList* m_histoList_purity = nullptr

inherited

List of purity histograms.

Definition at line 47 of file PerformanceEvaluationBaseClass.h.

m_histoList_trkQuality

TList* m_histoList_trkQuality = nullptr

inherited

List of track-quality histograms.

Definition at line 42 of file PerformanceEvaluationBaseClass.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_MCParticlePDGcode

TH1F* m_MCParticlePDGcode = nullptr

private

MCParticle PDG code.

Definition at line 88 of file V0findingPerformanceEvaluationModule.h.

m_MCParticles

StoreArray<MCParticle> m_MCParticles

private

MCParticles StoreArray.

Definition at line 81 of file V0findingPerformanceEvaluationModule.h.

m_MCParticlesName

std::string m_MCParticlesName

private

MCParticle StoreArray name.

Definition at line 78 of file V0findingPerformanceEvaluationModule.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_multiplicityMCParticles

TH1F* m_multiplicityMCParticles = nullptr

private

number of MCParticles per fitted Track

Definition at line 87 of file V0findingPerformanceEvaluationModule.h.

m_multiplicityV0s

TH1F* m_multiplicityV0s = nullptr

private

number of V0s per MCParticles

Definition at line 86 of file V0findingPerformanceEvaluationModule.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_package

std::string m_package

privateinherited

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

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

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_rootFileName

std::string m_rootFileName

inherited

root file name

Definition at line 137 of file PerformanceEvaluationBaseClass.h.

m_rootFilePtr

TFile* m_rootFilePtr = nullptr

inherited

pointer at root file used for storing histograms

Definition at line 140 of file PerformanceEvaluationBaseClass.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.

m_V0sName

std::string m_V0sName

private

MCTrackCand StoreArray name.

Definition at line 79 of file V0findingPerformanceEvaluationModule.h.

m_V0ValidationVertices

StoreArray<V0ValidationVertex> m_V0ValidationVertices

private

V0ValidationVertices StoreArray.

Definition at line 82 of file V0findingPerformanceEvaluationModule.h.

---

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

• tracking/modules/trackingPerformanceEvaluation/include/V0findingPerformanceEvaluationModule.h
• tracking/modules/trackingPerformanceEvaluation/src/V0findingPerformanceEvaluationModule.cc