Module for analysing the phase space of genfit::TrackCand(s) and SpacePointTrackCand(s) NOTE: this is just a very simple module that takes the MCParticleID of any TC and collects some information from them. More...

#include <PhaseSpaceAnalysisModule.h>

Inheritance diagram for PhaseSpaceAnalysisModule:

Classes
struct	RootVariables
	helper class to have all RootVariables assembled in one container More...

Public Types
enum	e_trackCandType { c_gftc , c_sptc }
	enum to differentiate between possible trackCandidate types More...

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
	PhaseSpaceAnalysisModule ()
	Constructor.

void	initialize () override
	initialize

void	event () override
	event

void	terminate () override
	terminate

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

virtual void	beginRun ()
	Called when entering a new run.

virtual void	endRun ()
	This method is called if the current run ends.

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
void	initializeCounters (size_t nContainers)
	initialize all counters to 0 to avoid undefined behavior

void	initializeRootFile (std::string fileName, std::string writeOption, std::vector< std::string > treeNames)
	create a root file with file name

void	getValuesForRoot (Belle2::MCParticle *mcParticle, RootVariables &rootVariables)
	collect the values for root output

template<typename TrackCandType >
std::vector< int >	getMCParticleIDs (Belle2::StoreArray< TrackCandType > trackCands)
	get all MCPartileIDs of tracks

std::vector< std::vector< int > >	getDiffIds (const std::vector< std::vector< int > > &allIDs)
	the first vector in allIds is used as reference to which all other vectors of allIDs are compared.

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.

Protected Attributes
std::vector< std::string >	m_PARAMcontainerNames
	collection name of trackCands to be investigated

std::vector< std::string >	m_PARAMtrackCandTypes
	types of the track candidates in containerNames

std::vector< std::string >	m_PARAMrootFileName
	name of the output root file name

bool	m_PARAMdiffAnalysis
	take containers pair-wise and only analize those particles that are found in one container but not in the other

std::vector< std::pair< boost::any, e_trackCandType > >	m_tcStoreArrays
	StoreArrays of the containers.

RootVariables	m_rootVariables
	root variables used for collecting data event-wise

std::vector< TTree * >	m_treePtrs
	each container name gets its own tree in the root file

TFile *	m_rootFilePtr
	Pointer to root file.

std::vector< std::string >	m_treeNames
	names of the trees that are stored in the root file

unsigned int	m_noMcPartCtr
	Counter for nullptr pointers to MC Particles (should always be zero.

unsigned int	m_skippedTCsCtr
	Counter for negative MC particle ids (should always be zero.

std::vector< unsigned int >	m_mcPartCtr
	container wise coutner of TrackCands / MCParticles

StoreArray< MCParticle >	m_MCParticles
	MCParticles StoreArray.

StoreArray< genfit::TrackCand >	m_GenfitTrackCands
	Genfit::TrackCands StoreArray.

StoreArray< SpacePointTrackCand >	m_SpacePointTrackCands
	SpacePointTrackCands StoreArray.

Private Member Functions
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::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.

Detailed Description

Module for analysing the phase space of genfit::TrackCand(s) and SpacePointTrackCand(s) NOTE: this is just a very simple module that takes the MCParticleID of any TC and collects some information from them.

Definition at line 38 of file PhaseSpaceAnalysisModule.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

◆ e_trackCandType

enum e_trackCandType

enum to differentiate between possible trackCandidate types

Enumerator
c_gftc	genfit::TrackCand
c_sptc	SpacePointTrackCand.

Definition at line 72 of file PhaseSpaceAnalysisModule.h.

                         {
      c_gftc, 
      c_sptc, 
    };

◆ 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

◆ PhaseSpaceAnalysisModule()

PhaseSpaceAnalysisModule ( )

Constructor.

Definition at line 21 of file PhaseSpaceAnalysisModule.cc.

                                                   : Module()
{
  setDescription("Module for analysing the phase space covered by TrackCands (resp. their related MCParticles)");
 
  std::vector<std::string> defaultNames = { std::string("") };
  addParam("containerNames", m_PARAMcontainerNames, "Collection names of trackCands to be analized.", defaultNames);
  addParam("trackCandTypes", m_PARAMtrackCandTypes, "Either 'GFTC' for genfit::TrackCand or 'SPTC' for SpacePointTrackCand." \
           "If there are more 'containerNames' than 'trackCandTypes' the last type is assumed for all the names that cannot be matched"\
           "one-to-one with a trackCandType. If there are as much names as types the i-th name is assumed to be of the i-th type");
 
  addParam("diffAnalysis", m_PARAMdiffAnalysis,
           "Use the first container as reference and only collect data for those MCParticle that"\
           " cannot be found in the other containers.", false);
 
  std::vector<std::string> defaultRootFName = { "PhaseSpaceAnalysis", "RECREATE" };
  addParam("rootFileName", m_PARAMrootFileName, "Name of the output root file without '.root' file ending + write mode"\
           " ('UPDATE' or 'RECREATE')", defaultRootFName);
 
  // initialize pointers to nullptr (cppcheck)
  m_rootFilePtr = nullptr;
  initializeCounters(0);
}

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

147{};

◆ 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.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ 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.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ 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.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ 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.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ 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.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

◆ 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

event

Reimplemented from Module.

Definition at line 89 of file PhaseSpaceAnalysisModule.cc.

{
  // print out the number of the event in debug output
  StoreObjPtr<EventMetaData> eventMetaDataPtr("EventMetaData", DataStore::c_Event);
  const int eventCounter = eventMetaDataPtr->getEvent();
  std::string arrayNames;
  for (std::string name : m_PARAMcontainerNames) {
    arrayNames += " " + name;
  }
  B2DEBUG(25, "PhaseSpaceAnalysis::event(). Processing event " << eventCounter << " for StoreArray names :" << arrayNames);
 
  const int nMCParticles = m_MCParticles.getEntries();
  B2DEBUG(25, "Found " << nMCParticles << " MCParticles for this event");
 
  std::vector<std::vector<int> > mcPartIds; // collect all mcParticle Ids of all trackCands
 
  for (std::pair<boost::any, e_trackCandType> storeArray : m_tcStoreArrays) {
    // COULDDO: wrap this in try-catch, but since it is known what has to be casted, nothing should really happen
    if (storeArray.second == c_gftc) {
      mcPartIds.push_back(getMCParticleIDs(boost::any_cast<StoreArray<genfit::TrackCand> >(storeArray.first)));
    } else if (storeArray.second == c_sptc) {
      mcPartIds.push_back(getMCParticleIDs(boost::any_cast<StoreArray<SpacePointTrackCand> >(storeArray.first)));
    }
    B2DEBUG(25, mcPartIds.back().size() << " MCParticles of this event were set for this container");
  }
 
  if (m_PARAMdiffAnalysis) { mcPartIds = getDiffIds(mcPartIds); }
  // TODO: get the referee Status of a SPTC into the getValuesForRoot stuff
 
  // now loop over all MCParticle IDs
  for (size_t iTree = 0; iTree < mcPartIds.size(); ++iTree) {
    B2DEBUG(25, "Now collecting values for vector of MCParticle Ids " << iTree);
    m_mcPartCtr[iTree]++; // increase counter
 
    m_rootVariables = RootVariables(); // clear root variables for each run
    for (int id : mcPartIds[iTree]) {
      if (id < 0) {
        // cppcheck-suppress shiftNegative
        B2WARNING("Found a negative id in mcParticleId: " << id << \
                  ". It seems that it has not been set properly, I will skip this MC Particle");
        m_skippedTCsCtr++;
        continue;
      }
      MCParticle* mcParticle = m_MCParticles[id];
      if (mcParticle == nullptr) { // safety measure
        m_noMcPartCtr++;
        continue;
      }
      getValuesForRoot(mcParticle, m_rootVariables);
    }
    m_treePtrs[iTree]->Fill(); // write values to TTree
  }
}

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

◆ 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.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getDiffIds()

std::vector< std::vector< int > > getDiffIds ( const std::vector< std::vector< int > > & allIDs )

protected

the first vector in allIds is used as reference to which all other vectors of allIDs are compared.

The values that cannot be found in these vectors but are in the reference are collected for each vector.

Returns: the original allIDs interlaced with the vectors of mcPartIds that were in the reference but not in the vector

Definition at line 247 of file PhaseSpaceAnalysisModule.cc.

{
  if (allIDs.size() < 2) { // do nothing if there are less than two entries
    B2DEBUG(25, "There are no more than 1 vectors passed to getDiffIds. No comparison possible. Returning passed vector");
    return allIDs;
  }
 
//   // COULDDO: remove (left here for checking if working properly, simply prints out all the entries in the vector of vectors)
//   if(LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 1999, PACKAGENAME())) { // very verbose dev output
//     std::stringstream output;
//     output << "content of allIDs: " << endl;
//     for(vector<int> vec: allIDs) {
//       output << "vector: ";
//       for(int i : vec) output << i << " ";
//       output << endl;
//     }
//     B2DEBUG(1999, output.str())
//   }
 
  std::vector<std::vector<int> > diffIds;
  std::vector<int> referenceIds = allIDs.at(0); // the first vector is the reference
  diffIds.push_back(referenceIds);
 
  // loop over other vectors and look for missing IDs
  for (size_t iVec = 1; iVec < allIDs.size(); ++iVec) {
    std::vector<int> compareIds = allIDs[iVec];
    diffIds.push_back(compareIds);
    std::vector<int> notFoundIds;
    for (int id : referenceIds) {
      if (find(compareIds.begin(), compareIds.end(), id) == compareIds.end()) { // not found
        notFoundIds.push_back(id);
      }
    }
    diffIds.push_back(notFoundIds); // push_back empty vectors too! otherwise the filling of the TTrees will be wrong!
  }
 
  return diffIds;
}

◆ 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.

225{return m_logConfig;}

◆ getMCParticleIDs()

std::vector< int > getMCParticleIDs ( Belle2::StoreArray< TrackCandType > trackCands )

protected

get all MCPartileIDs of tracks

Definition at line 235 of file PhaseSpaceAnalysisModule.cc.

{
  const int nTrackCands = trackCands.getEntries();
  B2DEBUG(25, "In StoreArray " << trackCands.getName() << ": " << nTrackCands << " track candidates for this event");
  std::vector<int> mcPartIds;
  for (int i = 0; i < nTrackCands; ++i) mcPartIds.push_back(trackCands[i]->getMcTrackId());
  // COULDDO: more debug output
  return mcPartIds;
}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

506{ 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.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{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.

363{ 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.

381{ 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;
}

◆ getValuesForRoot()

void getValuesForRoot	(	Belle2::MCParticle *	mcParticle,
		RootVariables &	rootVariables
	)

protected

collect the values for root output

Definition at line 202 of file PhaseSpaceAnalysisModule.cc.

{
  B2DEBUG(25, "Collecting values for MCParticle " << mcParticle->getArrayIndex());
  // collect all the momentum
  const ROOT::Math::XYZVector momentum = mcParticle->getMomentum();
  rootVariables.MomX.push_back(momentum.X());
  rootVariables.MomY.push_back(momentum.Y());
  rootVariables.MomZ.push_back(momentum.Z());
 
  rootVariables.pT.push_back(momentum.Rho());
  rootVariables.Eta.push_back(momentum.Eta());
 
  B2DEBUG(25, "XYZVector momentum: (" << momentum.X() << "," << momentum.Y() << "," << momentum.Z() << \
          "). This leads to p_T = " << momentum.Rho() << " and eta = " << momentum.Eta());
 
  const ROOT::Math::XYZVector vertex = mcParticle->getVertex();
  rootVariables.VertX.push_back(vertex.Y());
  rootVariables.VertY.push_back(vertex.Y());
  rootVariables.VertZ.push_back(vertex.Z());
 
  B2DEBUG(25, "vertex: (" << vertex.X() << "," << vertex.Y() << "," << vertex.Z() << ")");
 
  rootVariables.Charge.push_back(mcParticle->getCharge());
  rootVariables.Energy.push_back(mcParticle->getEnergy());
  rootVariables.PDG.push_back(mcParticle->getPDG());
  rootVariables.Mass.push_back(mcParticle->getMass());
 
  B2DEBUG(25, "Charge " << mcParticle->getCharge() << ", PDG code" << mcParticle->getPDG() << ", Energy " << \
          mcParticle->getEnergy() << ", Mass " << mcParticle->getMass());
}

◆ 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.

311{ 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.

378{ 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

initialize

Reimplemented from Module.

Definition at line 45 of file PhaseSpaceAnalysisModule.cc.

{
  B2INFO("PhaseSpaceAnalysis ------------------------ initialize --------------------------");
 
  m_MCParticles.isRequired();
 
  size_t nNames = m_PARAMcontainerNames.size();
  size_t nTypes = m_PARAMtrackCandTypes.size();
 
  if (nTypes > nNames) { B2FATAL("Passed " << nTypes << " trackCandTypese but only " << nNames << " containerNames!"); }
 
  for (size_t iName = 0; iName < nNames; ++iName) {
    size_t iType = iName < nTypes ? iName : nTypes - 1; // only acces values that are possible
    std::string tcType = m_PARAMtrackCandTypes.at(iType);
    if (tcType.compare(std::string("GFTC")) != 0 && tcType.compare(std::string("SPTC")) != 0) {
      B2FATAL("Found id " << tcType << " in 'trackCandTypes' but only 'GFTC' and 'SPTC' are allowed!");
    }
 
    std::string contName = m_PARAMcontainerNames.at(iName);
    if (tcType.compare(std::string("GFTC")) == 0) {
      m_GenfitTrackCands.isRequired(contName);
      m_tcStoreArrays.push_back(std::make_pair(m_GenfitTrackCands, c_gftc));
    } else {
      m_SpacePointTrackCands.isRequired(contName);
      m_tcStoreArrays.push_back(std::make_pair(m_SpacePointTrackCands, c_sptc));
    }
    if (m_PARAMrootFileName.size() != 2 || (m_PARAMrootFileName[1] != "UPDATE" && m_PARAMrootFileName[1] != "RECREATE")) {
      std::string output;
      for (std::string id : m_PARAMrootFileName) {
        output += "'" + id + "' ";
      }
      B2FATAL("PhaseSpaceAnalysis::initialize() : rootFileName is set wrong: entries are: " << output);
    }
 
    m_treeNames.push_back(contName);
    if (m_PARAMdiffAnalysis && iName != 0) m_treeNames.push_back(contName + "_diff");
  }
 
  initializeRootFile(m_PARAMrootFileName[0] + std::string(".root"), m_PARAMrootFileName[1], m_treeNames);
  initializeCounters(m_treeNames.size());
}

◆ initializeCounters()

void initializeCounters ( size_t nContainers )

inlineprotected

initialize all counters to 0 to avoid undefined behavior

Definition at line 107 of file PhaseSpaceAnalysisModule.h.

    {
      m_noMcPartCtr = 0;
      m_skippedTCsCtr = 0;
 
      m_mcPartCtr = std::vector<unsigned int>(nContainers, 0);
    }

◆ initializeRootFile()

void initializeRootFile	(	std::string	fileName,
		std::string	writeOption,
		std::vector< std::string >	treeNames
	)

protected

create a root file with file name

Parameters

fileName	name of the file
writeOption	root option for opening the file 'UPDATE' or 'RECREATE'
treeNames	: list of names of the trees contained in the root file to be initialized

Definition at line 173 of file PhaseSpaceAnalysisModule.cc.

{
  B2DEBUG(25, "initializing root file. fileName: " << fileName << ", writeOption: " << writeOption);
  m_rootFilePtr = new TFile(fileName.c_str(), writeOption.c_str());
 
  for (size_t i = 0; i < treeNames.size(); ++i) {
    TTree* tree = new TTree(treeNames[i].c_str(), "data of mc particles");
    tree->Branch("momentum_X", &m_rootVariables.MomX);
    tree->Branch("momentum_Y", &m_rootVariables.MomY);
    tree->Branch("momentum_Z", &m_rootVariables.MomZ);
 
    tree->Branch("eta", &m_rootVariables.Eta);
    tree->Branch("p_T", &m_rootVariables.pT);
 
    tree->Branch("vertex_X", &m_rootVariables.VertX);
    tree->Branch("vertex_Y", &m_rootVariables.VertY);
    tree->Branch("vertex_Z", &m_rootVariables.VertZ);
 
    tree->Branch("energy", &m_rootVariables.Energy);
    tree->Branch("mass", &m_rootVariables.Mass);
 
    tree->Branch("charge", &m_rootVariables.Charge);
    tree->Branch("pdg_code", &m_rootVariables.PDG);
 
    m_treePtrs.push_back(tree);
  }
}

◆ 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.

230{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.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ 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

terminate

Reimplemented from Module.

Definition at line 145 of file PhaseSpaceAnalysisModule.cc.

{
  std::stringstream furtherInfo;
  if (m_skippedTCsCtr || m_noMcPartCtr) {
    furtherInfo << " There were " << m_skippedTCsCtr << " negative mcParticle IDs and " << m_noMcPartCtr <<
                " nullptr pointers to MCParticles";
  }
  unsigned int nMCParts = accumulate(m_mcPartCtr.begin(), m_mcPartCtr.end(), 0);
  B2INFO("PhaseSpaceAnalysis::terminate(): Collected mcParticle info in " << m_PARAMcontainerNames.size() << " containers."\
         " Collected information from " << nMCParts << " MCParticles and wrote them into " << m_treeNames.size() << " different trees."\
         << furtherInfo.str());
 
  if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Debug, 1, PACKAGENAME())) {
    std::stringstream output;
    output << "tree-wise summary (no of mcParticles):";
    for (unsigned int ctr : m_mcPartCtr) output << " " << ctr;
    B2DEBUG(25, output.str());
  }
 
  // do ROOT stuff
  if (m_rootFilePtr != nullptr) {
    m_rootFilePtr->cd(); //important! without this the famework root I/O could mix with the root I/O of this module
    for (TTree* tree : m_treePtrs) { tree->Write(); }
    m_rootFilePtr->Close();
  }
}

Counter for negative MC particle ids (should always be zero.

safety measure)

Definition at line 102 of file PhaseSpaceAnalysisModule.h.

◆ m_SpacePointTrackCands

StoreArray<SpacePointTrackCand> m_SpacePointTrackCands

protected

SpacePointTrackCands StoreArray.

Definition at line 138 of file PhaseSpaceAnalysisModule.h.

◆ m_tcStoreArrays

std::vector<std::pair<boost::any, e_trackCandType> > m_tcStoreArrays

protected

StoreArrays of the containers.

Definition at line 90 of file PhaseSpaceAnalysisModule.h.

◆ m_treeNames

std::vector<std::string> m_treeNames

protected

names of the trees that are stored in the root file

Definition at line 98 of file PhaseSpaceAnalysisModule.h.

◆ m_treePtrs

std::vector<TTree*> m_treePtrs

protected

each container name gets its own tree in the root file

Definition at line 94 of file PhaseSpaceAnalysisModule.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:

tracking/modules/spacePointCreator/include/PhaseSpaceAnalysisModule.h
tracking/modules/spacePointCreator/src/PhaseSpaceAnalysisModule.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ e_trackCandType

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ PhaseSpaceAnalysisModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getDiffIds()

◆ getFileNames()

◆ getLogConfig()

◆ getMCParticleIDs()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ getValuesForRoot()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ initializeCounters()

◆ initializeRootFile()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ m_conditions

◆ m_description

◆ m_GenfitTrackCands

◆ m_hasReturnValue

◆ m_logConfig

◆ m_mcPartCtr

◆ m_MCParticles