MCMatcherParticlesModule Class Reference

MC matching module: module performs MC matching (sets the relation Particle -> MCParticle) for all particles and its (grand)^N-daughter particles in the user-specified ParticleList. More...

#include <MCMatcherParticlesModule.h>

Inheritance diagram for MCMatcherParticlesModule:

Collaboration diagram for MCMatcherParticlesModule:

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
	MCMatcherParticlesModule ()
	Constructor.
virtual void	initialize () override
	Initialize the Module.
virtual void	event () override
	Event processor.
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.
virtual void	terminate ()
	This method is called at the end of the event processing.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
LogConfig &	getLogConfig ()
	Returns the log system configuration.
void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.
void	setLogLevel (int logLevel)
	Configure the log level.
void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.
void	setAbortLevel (int abortLevel)
	Configure the abort log level.
void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.
void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module.
void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module.
void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module.
bool	hasCondition () const
	Returns true if at least one condition was set for the module.
const ModuleCondition *	getCondition () const
	Return a pointer to the first condition (or nullptr, if none was set)
const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.
bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished.
std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).
bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module.
bool	hasUnsetForcedParams () const
	Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
const ModuleParamList &	getParamList () const
	Return module param list.
template<typename T>
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter.
bool	hasReturnValue () const
	Return true if this module has a valid return value set.
int	getReturnValue () const
	Return the return value set by this module.
std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module.
std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters.

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

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python.
virtual void	def_beginRun ()
	Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
virtual void	def_event ()
	Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side.
virtual void	def_terminate ()
	Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
void	setDescription (const std::string &description)
	Sets the description of the module.
void	setType (const std::string &type)
	Set the module type.
template<typename T>
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module.
template<typename T>
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module.
void	setReturnValue (int value)
	Sets the return value for this module as integer.
void	setReturnValue (bool value)
	Sets the return value for this module as bool.
void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
void	setLooseMCMatch (const Particle *particle)
	Finds common mother of the majority of daughters.
int	ccbarTagPartialHelper (const MCParticle *mcParticle, std::vector< const Particle * > &fspParticles, std::vector< const MCParticle * > &missedParticles)
	returns 1 if the eventParticle daughters were all caught in recParticles, 2 if partially and 0 if none.
int	ccbarTagPartialHelper (const MCParticle *mcParticle, const std::vector< const Particle * > &fspParticles)
	returns 1 if the mcParticle daughters were all caught in tag, 2 if partially and 0 if none.
void	setCCbarTagMatch (const Particle *particle)
	Investigates the composition of the tag and remaining signal side and saves the inforamtion to extraInfo.
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_listName
	steering variable: name of the input ParticleList
StoreObjPtr< ParticleList >	m_plist
	the input ParticleList.
StoreArray< MCParticle >	m_mcparticles
	the array of MCParticles.
StoreArray< Particle >	m_particles
	the array of Particles.
bool	m_looseMatching
	perform loose mc matching
bool	m_ccbarTagMatching
	perform ccbar tag matching
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

MC matching module: module performs MC matching (sets the relation Particle -> MCParticle) for all particles and its (grand)^N-daughter particles in the user-specified ParticleList.

The MC matching algorithm is implemented in the MCMatching namespace.

In addition to the usual mc matching algorithm the module can run also loose mc matching. The difference between loose and normal mc matching algorithm is that the loose algorithm will find the common mother of the majority of daughter particles while the normal algorithm finds the common mother of all daughters. In the case one of the daughters has no generated mother (or mc association) the normal mc matching algorithm will tag such candidate as background (no mc match), while the loose algorithm will find the common mother of remaining daughters. This is useful for identifying for example self cross-feed candidates, where usually one of the photons is wrong, but the rest of the decay chain is correctly reconstructed. The results of loose mc matching algorithm are stored to the following extraInfo items:

• looseMCMotherPDG: PDG code of most common mother
• looseMCMotherIndex: 1-based StoreArray<MCParticle> index of most common mother
• looseMCWrongDaughterN: number of daughters that don't originate from the most common mother
• looseMCWrongDaughterPDG: PDG code of the daughter that doesn't originate from the most common mother (only if looseMCWrongDaughterN = 1)
• looseMCWrongDaughterBiB: 1 if the wrong daughter is Beam Induced Background Particle

In addition can perform tag matching for (ccbar) tags, requires that normal MC matching has already been performed and set relations. Low energy photons with energy < 0.1 GeV and ISR are ignored. The results of (ccbar) tag matching algorithm are stored to the following extraInfo items:

• ccbarTagSignal: 1st digit is status of signal particle, 2nd digit is Nleft-1, 3rd digit is NextraFSP.
• ccbarTagMCpdg: PDG code of (charm) hadron outside tag (signal side).
• ccbarTagMCpdgMother: PDG code of the mother of the (charm) hadron outside tag (signal side).
• ccbarTagNleft: number of particles (composites have priority) left outisde tag.
• ccbarTagNextraFSP: number of extra FSP particles attached to the tag.
• ccbarTagSignalStatus: status of the targeted signal side particle.
• ccbarTagNwoMC: number of daughters without MC match.
• ccbarTagNwoMCMother: number of daughters without MC mother.
• ccbarTagNnoAllMother: number of daughters without common allmother.
• ccbarTagNmissGamma: number of daughters with missing gamma mc error.
• ccbarTagNmissNeutrino: number of daughters with missing neutrino mc error.
• ccbarTagNdecayInFlight: number of daughters with decay in flight mc error.
• ccbarTagNsevereMCError: number of daughters with severe mc error.
• ccbarTagNmissRecoDaughters: number of daughters with any mc error.
• ccbarTagNleft2ndPDG: PDG of one particle left additionally to the signal particle.
• ccbarTagAllMotherPDG: PDG code of the allmother (Z0 or virtual photon).
  

Definition at line 77 of file MCMatcherParticlesModule.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

MCMatcherParticlesModule()

MCMatcherParticlesModule

(

)

Constructor.

Definition at line 33 of file MCMatcherParticlesModule.cc.

                                                   : Module()
{
  setDescription("Performs MC matching (sets relation Particle->MCParticle) for all particles\n"
                 "(and its (grand)^N-daughter particles) in the ParticleList. The relation can\n"
                 "be used in conjunction with MCMatching::MCErrorFlags flags, e.g. using the\n"
                 "isSignal or mcPDG & mcErrors variables.\n"
                 "\n"
                 "In addition to the usual mc matching algorithm the module can run also loose mc\n"
                 "matching. The difference between loose and normal mc matching algorithm is that\n"
                 "the loose algorithm will find the common mother of the majority of daughter\n"
                 "particles while the normal algorithm finds the common mother of all daughters.\n"
                 "The results of loose mc matching algorithm are stored to the following extraInfo\n"
                 "items:\n\n"
                 "- looseMCMotherPDG: PDG code of most common mother\n"
                 "- looseMCMotherIndex: 1-based StoreArray<MCParticle> index of most common mother\n"
                 "- looseMCWrongDaughterN: number of daughters that don't originate from the most"
                 "  common mother\n"
                 "- looseMCWrongDaughterPDG: PDG code of the daughter that doesn't originate from\n"
                 "  the most common mother (only if looseMCWrongDaughterN = 1)\n"
                 "- looseMCWrongDaughterBiB: 1 if the wrong daughter is Beam Induced Background Particle\n"
                 "\n"
                 "Can also perform tag matching for (ccbar) tags. Requires that normal MC\n"
                 "matching has already been performed and set relations.\n"
                 "Low energy photons with energy < 0.1 GeV and ISR are ignored.\n"
                 "The results of (ccbar) tag matching algorithm are stored to the following extraInfo\n"
                 "items:\n\n"
                 "- ccbarTagSignal: 1st digit is status of signal particle, 2nd digit is Nleft-1, 3rd digit is NextraFSP.\n"
                 "- ccbarTagMCpdg: PDG code of (charm) hadron outside tag (signal side).\n"
                 "- ccbarTagMCpdgMother: PDG code of the mother of the (charm) hadron outside tag (signal side).\n"
                 "- ccbarTagNleft: number of particles (composites have priority) left outisde tag.\n"
                 "- ccbarTagNextraFSP: number of extra FSP particles attached to the tag.\n"
                 "- ccbarTagSignalStatus: status of the targeted signal side particle.\n"
                 "- ccbarTagNwoMC: number of daughters without MC match.\n"
                 "- ccbarTagNwoMCMother: number of daughters without MC mother.\n"
                 "- ccbarTagNnoAllMother: number of daughters without common allmother.\n"
                 "- ccbarTagNmissGamma: number of daughters with missing gamma mc error.\n"
                 "- ccbarTagNmissNeutrino: number of daughters with missing neutrino mc error.\n"
                 "- ccbarTagNdecayInFlight: number of daughters with decay in flight mc error.\n"
                 "- ccbarTagNsevereMCError: number of daughters with severe mc error.\n"
                 "- ccbarTagNmissRecoDaughters: number of daughters with any mc error.\n"
                 "- ccbarTagNleft2ndPDG: PDG of one particle left additionally to the signal particle.\n"
                 "- ccbarTagAllMotherPDG: PDG code of the allmother (Z0 or virtual photon).");
 
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("listName", m_listName, "Name of the input ParticleList.");
  addParam("looseMCMatching", m_looseMatching, "Perform loose mc matching", false);
  addParam("ccbarTagMatching", m_ccbarTagMatching, "Perform ccbar tag matching", false);
}

Member Function Documentation

beginRun()

virtual void beginRun ( )

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.

Reimplemented in AWESOMEBasicModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BelleMCOutputModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CreateFieldMapModule, CurlTaggerModule, EnergyBiasCorrectionModule, EventInfoPrinterModule, EventLimiterModule, ExportGeometryModule, GearboxModule, HistoManagerModule, HistoModule, IoVDependentConditionModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, ProgressModule, PyModule, RandomBarrierModule, RxModule, SeqRootInputModule, SeqRootOutputModule, StatisticsSummaryModule, SubEventModule, SwitchDataStoreModule, TagVertexModule, TrackingEnergyLossCorrectionModule, TrackingMomentumScaleFactorsModule, TreeFitterModule, and TxModule.

Definition at line 146 of file Module.h.

{};

ccbarTagPartialHelper() [1/2]

int ccbarTagPartialHelper ( const MCParticle * mcParticle, const std::vector< const Particle * > & fspParticles )

private

returns 1 if the mcParticle daughters were all caught in tag, 2 if partially and 0 if none.

it is used to check what if the signal side particle has been particle absorbed in the tag.

Definition at line 290 of file MCMatcherParticlesModule.cc.

{
  bool CaughtAll = true;
  bool missedAll = true;
  for (auto& mcDaughter : mcParticle->getDaughters()) {
    if (mcDaughter->getPDG() == Const::photon.getPDGCode()
        && mcDaughter->getEnergy() < 0.1) continue; // ignore radiative photons with energy < 0.1 GeV as if they are not in the event
    auto it = std::find_if(fspParticles.begin(), fspParticles.end(), [mcDaughter](const Particle * fsp) { return fsp->getMCParticle() == mcDaughter; });
    if (it != fspParticles.end()) missedAll = false;
    else if (mcDaughter->getNDaughters() == 0) CaughtAll = false;
    else {
      int status = ccbarTagPartialHelper(mcDaughter, fspParticles);
      if (status == 0) CaughtAll = false;
      else if (status == 1) missedAll = false;
      else {
        missedAll = false;
        CaughtAll = false;
      }
    }
  }
  if (missedAll) return 0;
  else if (CaughtAll) return 1;
  else return 2;
}

ccbarTagPartialHelper() [2/2]

int ccbarTagPartialHelper ( const MCParticle * mcParticle, std::vector< const Particle * > & fspParticles, std::vector< const MCParticle * > & missedParticles )

private

returns 1 if the eventParticle daughters were all caught in recParticles, 2 if partially and 0 if none.

it is used to check if a signal particle is still left on the signal side of the event (what is not caught by the tag side).

Definition at line 234 of file MCMatcherParticlesModule.cc.

{
  bool CaughtAll = true;
  bool missedAll = true;
  for (auto& mcDaughter : mcParticle->getDaughters()) {
 
    auto it = std::find_if(fspParticles.begin(), fspParticles.end(), [mcDaughter](const Particle * fsp) { return fsp->getMCParticle() == mcDaughter; });
    if (it != fspParticles.end()) {
      fspParticles.erase(it);
      missedAll = false;
    } else {
      if (mcDaughter->getPDG() == Const::photon.getPDGCode() && (mcDaughter->getEnergy() < 0.1
                                                                 or mcDaughter->hasStatus(MCParticle::c_IsISRPhoton))) {
        continue; // ignore radiative photons with energy < 0.1 GeV and ISR as if they are not in the event
      }
      // Belle MC legacy remnants
      if (abs(mcDaughter->getPDG()) == 21) continue; // ignore gluons
      if (abs(mcDaughter->getPDG()) == 1) continue; // ignore down quarks
      if (abs(mcDaughter->getPDG()) == 2) continue; // ignore up quarks
      if (abs(mcDaughter->getPDG()) == 3) continue; // ignore strange quarks
      if (abs(mcDaughter->getPDG()) == 4) continue; // ignore charm quarks
      if (abs(mcDaughter->getPDG()) == 5) continue; // ignore bottom quarks
      if (abs(mcDaughter->getPDG()) == 6) continue; // ignore top quarks
      // TODO are there any other particles that should be ignored, due to Belle MC generation?
 
      else if (mcDaughter->getNDaughters() == 0) {
        missedParticles.push_back(mcDaughter);
        CaughtAll = false;
      } else {
        std::vector<const MCParticle*> tempMissedParticles;
        int status = ccbarTagPartialHelper(mcDaughter, fspParticles, tempMissedParticles);
        if (status == 0) {
          missedParticles.push_back(mcDaughter);
          CaughtAll = false;
        } else if (status == 1) {
          missedAll = false; // tempMissedParticles is empty
        } else {
          missedAll = false;
          CaughtAll = false;
          missedParticles.insert(missedParticles.end(), tempMissedParticles.begin(), tempMissedParticles.end());
        }
      }
    }
 
  }
 
  if (missedAll) return 0;
  else if (CaughtAll) return 1;
  else return 2;
}

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 425 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 438 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 431 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 419 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 444 of file Module.h.

{ terminate(); }

endRun()

virtual void endRun ( )

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.

Reimplemented in AWESOMEBasicModule, B2BIIConvertMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BelleMCOutputModule, CurlTaggerModule, EventInfoPrinterModule, HistoManagerModule, HistoModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, PyModule, RandomBarrierModule, RxModule, SeqRootInputModule, SeqRootOutputModule, StatisticsSummaryModule, SubEventModule, SwitchDataStoreModule, TxModule, ZMQTxInputModule, and ZMQTxWorkerModule.

Definition at line 165 of file Module.h.

{};

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

overridevirtual

Event processor.

Reimplemented from Module.

Definition at line 109 of file MCMatcherParticlesModule.cc.

{
  // if no MCParticles then silently skip
  if (!m_mcparticles.isValid())
    return;
  if (!m_plist) {
    B2ERROR("ParticleList " << m_listName << " not found");
    return;
  }
 
  const unsigned int n = m_plist->getListSize();
  for (unsigned i = 0; i < n; i++) {
    const Particle* part = m_plist->getParticle(i);
 
    MCMatching::setMCTruth(part);
 
    if (m_looseMatching)
      setLooseMCMatch(part);
 
    if (m_ccbarTagMatching)
      setCCbarTagMatch(part);
  }
}

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

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 323 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 313 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 201 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, and RootOutputModule.

Definition at line 133 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 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 186 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 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 362 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 380 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 310 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 377 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

{
  if_value("<1", path, afterConditionPath);
}

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

{
  if_value(">=1", path, afterConditionPath);
}

if_value()

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

inherited

Add a condition to the module.

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

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 84 of file MCMatcherParticlesModule.cc.

{
  // check that there are MCParticles: shout if not
  if (!m_mcparticles.isValid()) {
    B2WARNING("No MCParticles array found!"
              << " This is obvously fine if you're analysing real data,"
              << " but you have added the MCMatcher module to your path,"
              << " did you mean to do this?");
    return;
  }
 
  // if we have MCParticles then continue with the initialisation
  m_particles.isRequired();
  m_particles.registerRelationTo(m_mcparticles);
  m_plist.isRequired(m_listName);
 
  bool legacyAlgorithm = AnalysisConfiguration::instance()->useLegacyMCMatching();
  B2INFO("MCMatcher module will search for Particle -> MCParticle associations for the ParticleList " << m_listName << ".");
  if (legacyAlgorithm)
    B2INFO(" - The MCMatcher will use legacy algorithm suitable for analysis of Belle MC.");
  else
    B2INFO("  - The MCMatcher will use default algorithm suitable for analysis of Belle II MC.");
}

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

setCCbarTagMatch()

void setCCbarTagMatch ( const Particle * particle )

private

Investigates the composition of the tag and remaining signal side and saves the inforamtion to extraInfo.

Definition at line 319 of file MCMatcherParticlesModule.cc.

{
  if (particle->hasExtraInfo("ccbarTagSignalStatus")) // nothing to do; already set
    return;
  int ccbarTagSignal = 0;
  Particle* thisParticle = m_particles[particle->getArrayIndex()];
 
  // get Z0, virtual photon
  StoreArray<MCParticle> mcparticles;
  const MCParticle* allMother = nullptr;
  for (int i = 0; i < mcparticles.getEntries(); i++) {
    if (abs(mcparticles[i]->getPDG()) == 23 ||
        abs(mcparticles[i]->getPDG()) == 553 ||
        abs(mcparticles[i]->getPDG()) == 100553 ||
        abs(mcparticles[i]->getPDG()) == 200553 ||
        abs(mcparticles[i]->getPDG()) == 300553 ||
        abs(mcparticles[i]->getPDG()) == 9000553 ||
        abs(mcparticles[i]->getPDG()) == 9010553 ||
        abs(mcparticles[i]->getPDG()) == 10022) {
      allMother = mcparticles[i];
      break;
    }
  }
  if (!allMother) {
    B2WARNING("MCMatcherParticlesModule; tag matching - event has no AllMother?");
    return;
  }
  thisParticle->addExtraInfo("ccbarTagAllMotherPDG", allMother->getPDG());
 
  int sigPDGCode = particle->getPDGCode() * (-1); // get info about signal particles
  int eventStatus = 0; // default: signal particle is missing
  for (int i = 0; i < mcparticles.getEntries(); i++) {
    if (mcparticles[i]->getPDG() == sigPDGCode) {
      int recStatus = ccbarTagPartialHelper(mcparticles[i], particle->getFinalStateDaughters());
      if (recStatus == 0) {
        eventStatus = 1; // 1 still present in event
        break;
      } else if (recStatus == 2) eventStatus = 2; // 2 partially reconstructed by tag
      else if (recStatus == 1 && eventStatus != 2) eventStatus = 3; // 3 fully absorbed by tag
    }
  }
  thisParticle->addExtraInfo("ccbarTagSignalStatus", eventStatus);
  ccbarTagSignal += eventStatus;
 
  // recursive TagMCpdg, Nleft particles ---------------------------------
  std::vector<const Particle*> fspDaughters = particle->getFinalStateDaughters();
  std::vector<const MCParticle*> missedParticles;
  ccbarTagPartialHelper(allMother, fspDaughters, missedParticles);
  bool foundCharm = false;
  for (auto* mcpart : missedParticles) {
    int pdg = abs(mcpart->getPDG());
    if ((pdg > 400 && pdg < 500) || (pdg > 4000 && pdg < 5000) || (pdg > 10400 && pdg < 10500) || (pdg > 20400 && pdg < 20500)) {
      foundCharm = true;
      thisParticle->addExtraInfo("ccbarTagMCpdg", mcpart->getPDG());
      const MCParticle* mcpartMother = mcpart->getMother();
      int mcpartMotherPDG = 0;
      if (mcpartMother) mcpartMotherPDG = mcpartMother->getPDG();
      thisParticle->addExtraInfo("ccbarTagMCpdgMother", mcpartMotherPDG);
      break;
    }
  }
  if (!foundCharm) {
    thisParticle->addExtraInfo("ccbarTagMCpdg", 0);
    thisParticle->addExtraInfo("ccbarTagMCpdgMother", 0);
  }
  thisParticle->addExtraInfo("ccbarTagNextraFSP", fspDaughters.size());
  ccbarTagSignal += 10 * fspDaughters.size();
  thisParticle->addExtraInfo("ccbarTagNleft", missedParticles.size());
  ccbarTagSignal += 100 * (missedParticles.size() - 1);
  thisParticle->addExtraInfo("ccbarTagSignal", ccbarTagSignal);
 
  // debugging purposes only, to be removed, probably
  int secondLeftParticle = 0;
  if (missedParticles.size() == 2) {
    if (missedParticles[0]->getPDG() == sigPDGCode) secondLeftParticle = missedParticles[1]->getPDG();
    else if (missedParticles[1]->getPDG() == sigPDGCode) secondLeftParticle = missedParticles[0]->getPDG();
  }
  thisParticle->addExtraInfo("ccbarTagNleft2ndPDG", secondLeftParticle);
 
 
  // daughter and allmother checks
  int nWOmcParticles = 0;
  int nWOmother = 0;
  int nNonCommonAllMother = 0;
  for (auto& daughter : particle->getDaughters()) {
    if (!daughter->getMCParticle()) {
      nWOmcParticles++;
      continue;
    }
    const MCParticle* curMCMother = daughter->getMCParticle()->getMother();
    if (curMCMother == nullptr) {
      nWOmother++;
      continue;
    }
 
    const MCParticle* grandMother = curMCMother->getMother();
    while (grandMother != nullptr) {
      curMCMother = grandMother;
      grandMother = curMCMother->getMother();
    }
    if (curMCMother->getPDG() != Const::photon.getPDGCode() && curMCMother->getPDG() != 23
        && curMCMother->getPDG() != 10022) nNonCommonAllMother++;
    else if (allMother != curMCMother) nNonCommonAllMother++;
  }
  thisParticle->addExtraInfo("ccbarTagNwoMC", nWOmcParticles);
  thisParticle->addExtraInfo("ccbarTagNwoMCMother", nWOmother);
  thisParticle->addExtraInfo("ccbarTagNnoAllMother", nNonCommonAllMother);
 
  // daughter mcErrors ---------------------------------
  int nHasMissingGamma = 0;
  int nHasMissingNeutrino = 0;
  int nHasDecayInFlight = 0;
  int nHasSevereMCError = 0;
  int nMissRecoDaughters = 0;
  for (auto& daughter : particle->getDaughters()) { // TODO think about less strict conditions
    if (daughter->hasExtraInfo("ccbarTagNmissRecoDaughters")) {
      nHasMissingGamma    += daughter->getExtraInfo("ccbarTagNmissGamma");
      nHasMissingNeutrino += daughter->getExtraInfo("ccbarTagNmissNeutrino");
      nHasDecayInFlight   += daughter->getExtraInfo("ccbarTagNdecayInFlight");
      nHasSevereMCError   += daughter->getExtraInfo("ccbarTagNsevereMCError");
      nMissRecoDaughters  += daughter->getExtraInfo("ccbarTagNmissRecoDaughters");
      continue;
    }
 
    int mcError = MCMatching::getMCErrors(daughter, daughter->getMCParticle());
    nMissRecoDaughters += 1;
    if (mcError == MCMatching::c_Correct || mcError == MCMatching::c_MissingResonance) {
      nMissRecoDaughters -= 1;
      continue;
    } else if (mcError == MCMatching::c_MissGamma || mcError == MCMatching::c_MissFSR
               || mcError == MCMatching::c_MissPHOTOS) nHasMissingGamma += 1;
    else if (mcError == MCMatching::c_MissNeutrino) nHasMissingNeutrino += 1;
    else if (mcError == MCMatching::c_DecayInFlight) nHasDecayInFlight += 1;
    else nHasSevereMCError += 1;
  }
  thisParticle->addExtraInfo("ccbarTagNmissGamma", nHasMissingGamma);
  thisParticle->addExtraInfo("ccbarTagNmissNeutrino", nHasMissingNeutrino);
  thisParticle->addExtraInfo("ccbarTagNdecayInFlight", nHasDecayInFlight);
  thisParticle->addExtraInfo("ccbarTagNsevereMCError", nHasSevereMCError);
  thisParticle->addExtraInfo("ccbarTagNmissRecoDaughters", nMissRecoDaughters);
}

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

setLooseMCMatch()

void setLooseMCMatch ( const Particle * particle )

private

Finds common mother of the majority of daughters.

The results are stored to extraInfo.

Definition at line 133 of file MCMatcherParticlesModule.cc.

{
  if (particle->hasExtraInfo("looseMCMotherPDG")) // nothing to do; already set
    return;
 
  // get all FS daughters
  vector<const Particle*> fsDaughters = particle->getFinalStateDaughters();
 
  // map for counting how many times given mcparticle is mother of daughters
  CounterMap motherCount;
 
  for (auto daughter : fsDaughters) {
    const MCParticle* mcDaughter = daughter->getRelatedTo<MCParticle>();
    if (!mcDaughter)
      continue;
 
    vector<int> genMothers;
    MCMatching::fillGenMothers(mcDaughter, genMothers);
 
    for (auto motherIndex : genMothers) {
      // exclude ROOT particles: Upsilon(nS), virtual photon
      int motherPDG =  m_mcparticles[motherIndex - 1]->getPDG();
      if ((motherPDG == 553) ||
          (motherPDG == 100553) ||
          (motherPDG == 200553) ||
          (motherPDG == 300553) ||
          (motherPDG == 9000553) ||
          (motherPDG == 9010553) ||
          (motherPDG == 10022))
        continue;
 
      motherCount[motherIndex]++;
    }
  }
 
  // find first most common mother
  auto commonMother = std::max_element
                      (
                        motherCount.begin(), motherCount.end(),
  [](std::pair <unsigned int, unsigned int> p1, std::pair <unsigned int, unsigned int> p2) {
    bool returnValue = false;
    if (p1.second < p2.second)
      returnValue = true;
    else if (p1.second == p2.second)
      returnValue = p2.first > p1.first;
 
    return returnValue;
  }
                      );
 
  // No common mother found, all daughters have no associated MC Particle
  if (commonMother == motherCount.end()) {
    Particle* thisParticle = m_particles[particle->getArrayIndex()];
    thisParticle->addExtraInfo("looseMCMotherPDG",   -1);
    thisParticle->addExtraInfo("looseMCMotherIndex", -1);
    thisParticle->addExtraInfo("looseMCWrongDaughterN", -1);
    thisParticle->addExtraInfo("looseMCWrongDaughterPDG", -1);
    thisParticle->addExtraInfo("looseMCWrongDaughterBiB", -1);
    return;
  }
 
  const MCParticle* mcMother = m_mcparticles[commonMother->first - 1];
 
  Particle* thisParticle = m_particles[particle->getArrayIndex()];
  thisParticle->addExtraInfo("looseMCMotherPDG",   mcMother->getPDG());
  thisParticle->addExtraInfo("looseMCMotherIndex", mcMother->getArrayIndex());
  thisParticle->addExtraInfo("looseMCWrongDaughterN", fsDaughters.size() - commonMother->second);
 
  // find out what kind of particle was wrongly added
  // only for the case where there is only one such particle
  // This is the most interesting case. If two or more
  // particles are wrongly added, then a candidate looks
  // like background
  int wrongParticlePDG = 0; // PDG code of the wrongly matched particle
  int wrongParticleBiB = 0; // true (false) if particle doesn't (does) have MCParticle relation
  if (fsDaughters.size() - commonMother->second == 1) {
    for (auto daughter : fsDaughters) {
      const MCParticle* mcDaughter = daughter->getRelatedTo<MCParticle>();
      if (!mcDaughter) {
        wrongParticlePDG  = daughter->getPDGCode();
        wrongParticleBiB = 1;
      }
 
      vector<int> genMothers;
      MCMatching::fillGenMothers(mcDaughter, genMothers);
 
      // check if current daughter descends from common mother
      if (find(genMothers.begin(), genMothers.end(), commonMother->first) != genMothers.end())
        continue;
 
      // daughter is not a child of common mother
      wrongParticlePDG = daughter->getPDGCode();
    }
  }
 
  thisParticle->addExtraInfo("looseMCWrongDaughterPDG", wrongParticlePDG);
  thisParticle->addExtraInfo("looseMCWrongDaughterBiB", wrongParticleBiB);
 
}

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 213 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

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

virtual void terminate ( )

inlinevirtualinherited

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

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Reimplemented in AsyncWrapper, AWESOMEBasicModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BelleMCOutputModule, CurlTaggerModule, EventKinematicsModule, FlavorTaggerInfoFillerModule, GeometryModule, HistoManagerModule, HistoModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MergeDataStoreModule, MVAExpertModule, MVAMultipleExpertsModule, ParticleKinematicFitterModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMassUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, ProfileModule, ProgressBarModule, PyModule, RandomBarrierModule, RemoveParticlesNotInListsModule, RootInputModule, RootOutputModule, RxModule, SeqRootInputModule, SeqRootOutputModule, SkimFilterModule, SubEventModule, SwitchDataStoreModule, TreeFitterModule, TxModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, and ZMQTxWorkerModule.

Definition at line 175 of file Module.h.

{};

Member Data Documentation

m_ccbarTagMatching

bool m_ccbarTagMatching

private

perform ccbar tag matching

Definition at line 105 of file MCMatcherParticlesModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

m_listName

std::string m_listName

private

steering variable: name of the input ParticleList

Definition at line 99 of file MCMatcherParticlesModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

m_looseMatching

bool m_looseMatching

private

perform loose mc matching

Definition at line 104 of file MCMatcherParticlesModule.h.

m_mcparticles

StoreArray<MCParticle> m_mcparticles

private

the array of MCParticles.

Definition at line 101 of file MCMatcherParticlesModule.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

m_name

std::string m_name

privateinherited

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

Definition at line 507 of file Module.h.

m_package

std::string m_package

privateinherited

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

Definition at line 509 of file Module.h.

m_particles

StoreArray<Particle> m_particles

private

the array of Particles.

Definition at line 102 of file MCMatcherParticlesModule.h.

m_plist

StoreObjPtr<ParticleList> m_plist

private

the input ParticleList.

Definition at line 100 of file MCMatcherParticlesModule.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 511 of file Module.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

---

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

• analysis/modules/MCMatcherParticles/include/MCMatcherParticlesModule.h
• analysis/modules/MCMatcherParticles/src/MCMatcherParticlesModule.cc