ParticleLoaderModule Class Reference

Loads MDST dataobjects as Particle objects to the StoreArray<Particle> and collects them in specified ParticleList. More...

#include <ParticleLoaderModule.h>

Inheritance diagram for ParticleLoaderModule:

Collaboration diagram for ParticleLoaderModule:

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
	ParticleLoaderModule ()
	Constructor.
virtual void	initialize () override
	Initialize the Module.
virtual void	event () override
	Event processor.
virtual void	terminate () override
	Terminate the Module.
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
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 Types
enum	PListIndex {   c_PListPDGCode ,   c_PListName ,   c_AntiPListName ,   c_IsPListSelfConjugated }
	Enum for describing each element in the above tuple. More...
typedef std::tuple< int, std::string, std::string, bool >	PList
	tuple for collecting everything we know about the ParticlList to be created.

Private Member Functions
void	mcParticlesToParticles ()
	Loads specified MCParticles as Particle to StoreArray<Particle>
void	mdstToParticle ()
	Loads specified MSDT object as Particle to StoreArray<Particle>
void	tracksToParticles ()
	Loads Track object as Particle to StoreArray<Particle> and adds it to the ParticleList.
void	eclAndKLMClustersToParticles ()
	Loads ECLCluster and KLMCluster object as Particle to StoreArray<Particle> and adds it to the ParticleList.
bool	isValidECLCluster (const ECLCluster *cluster, const int pdgCode, bool onlyNeutral) const
	Checks if the given ECLCluster is valid for the pdgCode.
void	assignMCParticleFromECLCluster (Particle *newPart, const ECLCluster *cluster) const
	Assigns the MCParticle relation to the newPart.
void	chargedClustersToParticles ()
	Loads ECLCluster and KLMCluster objects that are being matched with Track as Particle to StoreArray<Particle> and adds it to the ParticleList.
void	v0sToParticles ()
	Loads V0 object as Particle of specified type to StoreArray<Particle> and adds it to the ParticleList.
void	roeToParticles ()
	Loads ROE object as Particle of specified type to StoreArray<Particle> and adds it to the ParticleList.
void	addROEToParticleList (RestOfEvent *roe, int mdstIndex, int pdgCode=0, bool isSelfConjugatedParticle=true)
	Helper method to load ROE object as Particle.
void	dummyToParticles ()
	Loads dummy object as Particle of specified type to StoreArray<Particle> and adds it to the ParticleList.
bool	isValidPDGCode (const int pdgCode)
	returns true if the PDG code determined from the decayString is valid
void	appendDaughtersRecursive (Particle *mother)
	recursively append bottom of a particle's decay chain (daughters of mother, granddaughters of daughter and so on).
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
StoreArray< Particle >	m_particles
	StoreArray of Particles.
StoreArray< MCParticle >	m_mcparticles
	StoreArray of MCParticles.
StoreArray< ECLCluster >	m_eclclusters
	StoreArray of ECLCluster.
StoreArray< KLMCluster >	m_klmclusters
	StoreArray of KLMCluster.
StoreArray< PIDLikelihood >	m_pidlikelihoods
	StoreArray of PIDLikelihoods.
StoreArray< Track >	m_tracks
	StoreArray of Tracks.
StoreArray< TrackFitResult >	m_trackfitresults
	StoreArray of TrackFitResults.
StoreObjPtr< EventExtraInfo >	m_eventExtraInfo
	object pointer to event extra info
StoreObjPtr< ParticleExtraInfoMap >	m_particleExtraInfoMap
	object pointer to extra info map
StoreArray< RestOfEvent >	m_roes
	StoreArray of ROEs.
StoreArray< V0 >	m_v0s
	StoreArray of V0s.
bool	m_useMCParticles
	Load MCParticle as Particle instead of the corresponding MDST dataobject.
bool	m_useROEs
	Switch to load ROE as Particle.
bool	m_useDummy
	Switch to load dummy as Particle.
bool	m_loadChargedCluster
	Switch to load charged-cluster
bool	m_useOnlyMostEnergeticECLCluster
	If true, only the most energetic ECLCluster is used.
DecayDescriptor	m_decaydescriptor
	Decay descriptor for parsing the user specified DecayString.
int	m_properties
	Particle property to be assigned only on V0s.
std::vector< std::string >	m_decayStrings
	Input decay strings specifying the particles being created/loaded.
std::vector< PList >	m_MCParticles2Plists
	Collection of PLists that will collect Particles created from MCParticles.
std::vector< PList >	m_Tracks2Plists
	Collection of PLists that will collect Particles created from Tracks.
std::vector< PList >	m_V02Plists
	Collection of PLists that will collect Particles created from V0.
std::vector< PList >	m_ROE2Plists
	Collection of PLists that will collect Particles created from V0.
std::vector< PList >	m_ECLKLMClusters2Plists
	Collection of PLists that will collect Particles created from ECLClusters and KLMClusters.
std::vector< PList >	m_Dummies2Plists
	Collection of PLists that will collect Particles created from Dummies.
std::vector< PList >	m_ChargedCluster2Plists
	Collection of PLists that will collect Particles created from charged-cluster.
bool	m_writeOut
	toggle particle list btw.
bool	m_skipInitial
	toggle skip of initial MC particles
bool	m_skipNonPrimary
	toggle skip of secondary MC particle
bool	m_addDaughters
	toggle addition of the bottom part of the particle's decay chain
bool	m_skipNonPrimaryDaughters
	toggle skip of secondary MC daughters
std::string	m_roeMaskName
	ROE mask name to load.
std::string	m_sourceParticleListName
	Particle list name from which we need to get related ROEs.
bool	m_useMissing
	Use missing momentum to build a particle.
int	m_trackHypothesis
	pdg code for track hypothesis that should be used to create the particle
int	m_dummyMDSTIndex
	mdst index for dummy particles
double	m_dummyCovMatrix
	diag value of cov matrix for dummy particles
bool	m_dummyTreatAsInvisible
	should treeFitter treat the particle as invisible?
bool	m_enforceFitHypothesis
	If true, a Particle is only created if a track fit with the particle hypothesis passed to the ParticleLoader is available.
std::vector< int >	m_chargeZeroTrackCounts
	internally used to count number of tracks with charge zero
std::vector< int >	m_sameChargeDaughtersV0Counts
	internally used to count the number of V0s with same charge daughters
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

Loads MDST dataobjects as Particle objects to the StoreArray<Particle> and collects them in specified ParticleList.

Charge conjugated particles are loaded as well and collected in the anti-ParticleList.

The type of the particle to be loaded is specified via the decayString module parameter. The type of the MDST dataobject that is used as an input is determined from the type of the particle.

The following types of the particles can be loaded:

o) charged final state particles (input MDST type = Tracks)

• e+, mu+, pi+, K+, p, deuteron (and charge conjugated particles)

o) neutral final state particles

• gamma (input MDST type = ECLCluster with 'n photons' ECLCluster::Hypothesis::c_nPhotons)
• K_S0, Lambda0, converted photons (input MDST type = V0)
• K_L0, n0 (input MDST type = KLMCluster, or ECLCluster with neutral hadron hypothesis)

The following basf2 relations are set by the ParticleLoader:

o) in the case of charged final state particles

• Particle <-> MCParticle
• Particle <-> PIDLikelihood

o) in the case of neutral final state particles

• Particle <-> MCParticle

In the case the useMCParticles module parameter is set to true the module loads specific MCParticle(s) as Particle(s) instead of the MDST dataobjects. In this case any particle type can be specified via the decayString module parameter.

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

PList

typedef std::tuple<int, std::string, std::string, bool> PList

private

tuple for collecting everything we know about the ParticlList to be created.

The elements are: PDGCode, name, anti-list name, and isListSelfConjugated

Definition at line 83 of file ParticleLoaderModule.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,  
    };

PListIndex

enum PListIndex

private

Enum for describing each element in the above tuple.

Definition at line 87 of file ParticleLoaderModule.h.

                    {
      c_PListPDGCode, c_PListName, c_AntiPListName, c_IsPListSelfConjugated
    };

Constructor & Destructor Documentation

ParticleLoaderModule()

ParticleLoaderModule

(

)

Constructor.

Definition at line 36 of file ParticleLoaderModule.cc.

                                           : Module()
 
{
  setDescription("Loads MDST dataobjects as Particle objects to the StoreArray<Particle> and collects them in specified ParticleList.");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // Add parameters
  addParam("decayStrings", m_decayStrings,
           "List of decay strings (see :ref:`DecayString` for syntax) that specify all output ParticleLists to be created by the module.",
           {});
 
  addParam("useMCParticles", m_useMCParticles,
           "Use MCParticles instead of reconstructed MDST dataobjects (tracks, ECL, KLM, clusters, V0s, ...)", false);
 
  addParam("useROEs", m_useROEs,
           "Use ROE instead of reconstructed MDST dataobjects (tracks, ECL, KLM, clusters, V0s, ...)", false);
 
  addParam("roeMaskName", m_roeMaskName,
           "ROE mask name to load", std::string(RestOfEvent::c_defaultMaskName));
 
  addParam("sourceParticleListName", m_sourceParticleListName,
           "Particle list name from which we need to get ROEs", std::string(""));
 
  addParam("useMissing", m_useMissing,
           "If true, the Particle List will be filled with missing momentum from the ROE and signal particle.", false);
 
  addParam("writeOut", m_writeOut,
           "If true, the output ParticleList will be saved by RootOutput. If false, it will be ignored when writing the file.", false);
 
  addParam("skipInitial", m_skipInitial,
           "If true, initial MCParticles will be skipped (default). If false, initial MCParticles will be included.", true);
 
  addParam("skipNonPrimary", m_skipNonPrimary,
           "If true, the secondary MC particle will be skipped, default is false",
           false);
 
  addParam("addDaughters", m_addDaughters,
           "If true, the particles from the bottom part of the selected particle's decay chain will also be created in the datastore and mother-daughter relations are recursively set",
           false);
 
  addParam("skipNonPrimaryDaughters", m_skipNonPrimaryDaughters,
           "If true, the secondary MC daughters will be skipped, default is false",
           false);
 
  addParam("trackHypothesis", m_trackHypothesis,
           "Track hypothesis to use when loading the particle. By default, use the particle's own hypothesis.",
           0);
 
  addParam("enforceFitHypothesis", m_enforceFitHypothesis,
           "If true, a Particle is only created if a track fit with the particle hypothesis passed to the ParticleLoader is available.",
           m_enforceFitHypothesis);
 
  addParam("useDummy", m_useDummy,
           "Use Dummy instead of reconstructed MDST dataobjects (tracks, ECL, KLM, clusters, V0s, ...)", false);
 
  addParam("dummyMDSTIndex", m_dummyMDSTIndex,
           "mdst index to use for dummy particle", 0);
 
  addParam("dummyCovMatrix", m_dummyCovMatrix,
           "Diagonal value of covariance matrix to use for dummy particle", 10000.);
 
  addParam("dummyTreatAsInvisible", m_dummyTreatAsInvisible,
           "Should treeFitter treat the particle as invisible?", true);
 
  addParam("loadChargedCluster", m_loadChargedCluster,
           "Load neutral Particles from the clusters being matched with the track of the sourceParticleList",
           false);
  addParam("useOnlyMostEnergeticECLCluster", m_useOnlyMostEnergeticECLCluster,
           "If true, the most energetic ECLCluster among ones matching with the Track is used. "
           "If false, all matched ECLCluster are used. "
           "This option is checked only when loadChargedCluster=True.",
           true);
}

Member Function Documentation

addROEToParticleList()

void addROEToParticleList ( RestOfEvent *  roe, int  mdstIndex, int  pdgCode = 0, bool  isSelfConjugatedParticle = true  )

private

Helper method to load ROE object as Particle.

Definition at line 437 of file ParticleLoaderModule.cc.

{
 
  Particle* newPart = nullptr;
  if (!m_useMissing) {
    // Convert ROE to particle
    newPart = roe->convertToParticle(m_roeMaskName, pdgCode, isSelfConjugatedParticle);
  } else {
    // Create a particle from missing momentum
    auto* signalSideParticle = roe->getRelatedFrom<Particle>();
    PCmsLabTransform T;
    ROOT::Math::PxPyPzEVector boost4Vector = T.getBeamFourMomentum();
 
    ROOT::Math::PxPyPzEVector signal4Vector = signalSideParticle->get4Vector();
    ROOT::Math::PxPyPzEVector roe4Vector = roe->get4Vector(m_roeMaskName);
    ROOT::Math::PxPyPzEVector missing4Vector = boost4Vector - signal4Vector - roe4Vector;
    auto isFlavored = (isSelfConjugatedParticle) ? Particle::EFlavorType::c_Unflavored : Particle::EFlavorType::c_Flavored;
    newPart = m_particles.appendNew(missing4Vector, pdgCode, isFlavored, Particle::EParticleSourceObject::c_Undefined, mdstIndex);
  }
 
  roe->addRelationTo(newPart);
 
  for (auto roe2Plist : m_ROE2Plists) {
    string listName = get<c_PListName>(roe2Plist);
    StoreObjPtr<ParticleList> plist(listName);
    plist->addParticle(newPart);
  }
}

appendDaughtersRecursive()

void appendDaughtersRecursive ( Particle *  mother )

private

recursively append bottom of a particle's decay chain (daughters of mother, granddaughters of daughter and so on).

Definition at line 1025 of file ParticleLoaderModule.cc.

{
  auto* mcmother = mother->getRelated<MCParticle>();
 
  if (!mcmother)
    return;
 
  vector<MCParticle*> mcdaughters = mcmother->getDaughters();
 
  for (auto& mcdaughter : mcdaughters) {
    if (!mcdaughter->hasStatus(MCParticle::c_PrimaryParticle) and m_skipNonPrimaryDaughters) continue;
    Particle particle(mcdaughter);
    Particle* daughter = m_particles.appendNew(particle);
    daughter->addRelationTo(mcdaughter);
    mother->appendDaughter(daughter, false);
 
    if (mcdaughter->getNDaughters() > 0)
      appendDaughtersRecursive(daughter);
  }
}

assignMCParticleFromECLCluster()

void assignMCParticleFromECLCluster ( Particle *  newPart, const ECLCluster *  cluster  ) const

private

Assigns the MCParticle relation to the newPart.

The given cluster is used to find the best MCParticle matching.

Definition at line 811 of file ParticleLoaderModule.cc.

{
  // ECLCluster can be matched to multiple MCParticles
  // order the relations by weights and set Particle -> multiple MCParticle relation
  // preserve the weight
  const RelationVector<MCParticle> mcRelations = cluster->getRelationsTo<MCParticle>();
 
  // order relations by weights
  std::vector<std::pair<double, int>> weightsAndIndices;
  for (unsigned int iMCParticle = 0; iMCParticle < mcRelations.size(); iMCParticle++) {
    const MCParticle* relMCParticle = mcRelations[iMCParticle];
    if (relMCParticle) {
      double weight = mcRelations.weight(iMCParticle);
      weightsAndIndices.emplace_back(weight, relMCParticle->getArrayIndex());
    }
  }
 
  // sort descending by weight
  std::sort(weightsAndIndices.begin(), weightsAndIndices.end(),
            ValueIndexPairSorting::higherPair<decltype(weightsAndIndices)::value_type>);
 
  // set relations to mcparticles
  for (auto& weightsAndIndex : weightsAndIndices) {
    const MCParticle* relMCParticle = m_mcparticles[weightsAndIndex.second];
    double weight = weightsAndIndex.first;
 
    // TODO: study this further and avoid hard-coded values
    // set the relation only if the MCParticle(reconstructed Particle)'s
    // energy contribution to this cluster amounts to at least 30(20)%
    if (relMCParticle)
      if (weight / newPart->getECLClusterEnergy() > 0.20
          && weight / relMCParticle->getEnergy() > 0.30)
        newPart->addRelationTo(relMCParticle, weight);
  }
 
}

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 EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, CreateFieldMapModule, ExportGeometryModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, and PyModule.

Definition at line 147 of file Module.h.

{};

chargedClustersToParticles()

void chargedClustersToParticles ( )

private

Loads ECLCluster and KLMCluster objects that are being matched with Track as Particle to StoreArray<Particle> and adds it to the ParticleList.

Definition at line 848 of file ParticleLoaderModule.cc.

{
  if (m_ChargedCluster2Plists.empty()) // nothing to do
    return;
 
  // loop over all ParticleLists
  for (auto chargedCluster2Plist : m_ChargedCluster2Plists) {
 
    string listName = get<c_PListName>(chargedCluster2Plist);
    string antiListName = get<c_AntiPListName>(chargedCluster2Plist);
    int pdgCode = get<c_PListPDGCode>(chargedCluster2Plist);
    bool isSelfConjugatedParticle = get<c_IsPListSelfConjugated>(chargedCluster2Plist);
    Const::ParticleType thisType(pdgCode);
 
    StoreObjPtr<ParticleList> plist(listName);
    // since a particle list in the ParticleLoader always contains all possible objects
    // we check whether it already exists in this path and can skip any further steps if it does
    if (plist.isValid())
      continue;
    plist.create();
    plist->initialize(pdgCode, listName);
 
    // create anti-particle list if necessary
    if (!isSelfConjugatedParticle) {
      StoreObjPtr<ParticleList> antiPlist(antiListName);
      antiPlist.create();
      antiPlist->initialize(-1 * pdgCode, antiListName);
 
      antiPlist->bindAntiParticleList(*(plist));
    }
 
    const StoreObjPtr<ParticleList> sourceList(m_sourceParticleListName);
    if (!sourceList.isValid())
      B2FATAL("ParticleList " << m_sourceParticleListName << " could not be found or is not valid!");
 
    for (unsigned int iPart = 0; iPart < sourceList->getListSize(); iPart++) {
 
      const Particle* sourcePart = sourceList->getParticle(iPart);
      const Track* sourceTrack = sourceList->getParticle(iPart)->getTrack();
      if (!sourceTrack)
        continue;
 
      // ECL clusters
      if (m_useOnlyMostEnergeticECLCluster) {
 
        const ECLCluster* cluster = sourcePart->getECLCluster();
        if (isValidECLCluster(cluster, pdgCode, false)) {
          Particle particle(cluster, thisType);
          if (particle.getParticleSource() != Particle::c_ECLCluster) {
            B2FATAL("Particle created from ECLCluster does not have ECLCluster type.");
          }
          Particle* newPart = m_particles.appendNew(particle);
          assignMCParticleFromECLCluster(newPart, cluster);
          plist->addParticle(newPart);
        }
      } else {
 
        // loop over all clusters matched to this track
        const RelationVector<ECLCluster> clusters =  sourceTrack->getRelationsTo<ECLCluster>();
        for (unsigned int iCluster = 0; iCluster < clusters.size(); iCluster++) {
          const ECLCluster* cluster = clusters[iCluster];
          if (!isValidECLCluster(cluster, pdgCode, false))
            continue; // go to next iCluster
 
          Particle particle(cluster, thisType);
          if (particle.getParticleSource() != Particle::c_ECLCluster) {
            B2FATAL("Particle created from ECLCluster does not have ECLCluster type.");
          }
          Particle* newPart = m_particles.appendNew(particle);
          assignMCParticleFromECLCluster(newPart, cluster);
          plist->addParticle(newPart);
        }
      }
 
      // KLM clusters
      const KLMCluster* cluster = sourcePart->getKLMCluster();
      if (!cluster) continue; // go to next iPart
 
      if (std::isnan(cluster->getMomentumMag())) {
        B2DEBUG(19, "Skipping KLMCluster because its momentum is NaN. "
                "This can happen if the timing calibration is missing or wrong, so that the velocity is calculated to be negative.");
        continue;
      }
 
      // create particle and check its type before adding it to list
      Particle particle(cluster, pdgCode);
      if (particle.getParticleSource() != Particle::c_KLMCluster) {
        B2FATAL("Particle created from KLMCluster does not have KLMCluster type.");
      }
      Particle* newPart = m_particles.appendNew(particle);
 
      const MCParticle* mcParticle = cluster->getRelated<MCParticle>();
      if (mcParticle) newPart->addRelationTo(mcParticle);
 
      plist->addParticle(newPart);
    }
 
  } // loop over particle lists
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

dummyToParticles()

void dummyToParticles ( )

private

Loads dummy object as Particle of specified type to StoreArray<Particle> and adds it to the ParticleList.

Definition at line 331 of file ParticleLoaderModule.cc.

{
  if (m_Dummies2Plists.empty()) // nothing to do
    return;
  if (m_Dummies2Plists.size() != 1)
    B2ERROR("ParticleLoaderModule::dummyToParticles Multiple particle lists are not supported!");
  auto dummy2Plist = m_Dummies2Plists[0];
  string dummyListName = get<c_PListName>(dummy2Plist);
  string antiDummyListName = get<c_AntiPListName>(dummy2Plist);
  int pdgCode = get<c_PListPDGCode>(dummy2Plist);
  bool isSelfConjugatedParticle = get<c_IsPListSelfConjugated>(dummy2Plist);
 
  StoreObjPtr<ParticleList> plist(dummyListName);
  plist.create();
  plist->initialize(pdgCode, dummyListName);
 
  if (!isSelfConjugatedParticle) {
    StoreObjPtr<ParticleList> antiPlist(antiDummyListName);
    antiPlist.create();
    antiPlist->initialize(-1 * pdgCode, antiDummyListName);
    antiPlist->bindAntiParticleList(*(plist));
  }
 
  TMatrixFSym covariance(7);
  for (int row = 0; row < 7; ++row) { //diag
    covariance(row, row) = m_dummyCovMatrix;
  }
 
  Particle* newPart = nullptr;
  Particle* newAntiPart = nullptr;
 
  auto isFlavored = (isSelfConjugatedParticle) ? Particle::EFlavorType::c_Unflavored : Particle::EFlavorType::c_Flavored;
 
  ROOT::Math::PxPyPzEVector zero4Vector = {0., 0., 0., 0.};
 
  newPart = m_particles.appendNew(zero4Vector, pdgCode, isFlavored, Particle::EParticleSourceObject::c_NoMDSTSource,
                                  m_dummyMDSTIndex);
  if (m_dummyCovMatrix > 0.) newPart->setMomentumVertexErrorMatrix(covariance);
  if (m_dummyTreatAsInvisible) newPart->writeExtraInfo("treeFitterTreatMeAsInvisible", 1);
  plist->addParticle(newPart);
 
  if (!isSelfConjugatedParticle) {
    newAntiPart = m_particles.appendNew(zero4Vector, -pdgCode, isFlavored, Particle::EParticleSourceObject::c_NoMDSTSource,
                                        m_dummyMDSTIndex);
    if (m_dummyCovMatrix > 0.) newAntiPart->setMomentumVertexErrorMatrix(covariance);
    if (m_dummyTreatAsInvisible) newAntiPart->writeExtraInfo("treeFitterTreatMeAsInvisible", 1);
    plist->addParticle(newAntiPart);
  }
 
}

eclAndKLMClustersToParticles()

void eclAndKLMClustersToParticles ( )

private

Loads ECLCluster and KLMCluster object as Particle to StoreArray<Particle> and adds it to the ParticleList.

Definition at line 698 of file ParticleLoaderModule.cc.

{
  if (m_ECLKLMClusters2Plists.empty()) // nothing to do
    return;
 
  // loop over all ParticleLists
  for (auto eclKLMCluster2Plist : m_ECLKLMClusters2Plists) {
    string listName = get<c_PListName>(eclKLMCluster2Plist);
    string antiListName = get<c_AntiPListName>(eclKLMCluster2Plist);
    int pdgCode = get<c_PListPDGCode>(eclKLMCluster2Plist);
    bool isSelfConjugatedParticle = get<c_IsPListSelfConjugated>(eclKLMCluster2Plist);
    Const::ParticleType thisType(pdgCode);
 
    StoreObjPtr<ParticleList> plist(listName);
    // since a particle list in the ParticleLoader always contains all possible objects
    // we check whether it already exists in this path and can skip any further steps if it does
    if (plist.isValid())
      continue;
    plist.create();
    plist->initialize(pdgCode, listName);
 
    // create anti-particle list if necessary
    if (!isSelfConjugatedParticle) {
      StoreObjPtr<ParticleList> antiPlist(antiListName);
      antiPlist.create();
      antiPlist->initialize(-1 * pdgCode, antiListName);
 
      antiPlist->bindAntiParticleList(*(plist));
    }
 
    plist->setEditable(true); // :all list is originally reserved. we have to set it as editable.
 
    // load reconstructed neutral ECL clusters as photons or Klongs or neutrons
    for (int i = 0; i < m_eclclusters.getEntries(); i++) {
      const ECLCluster* cluster      = m_eclclusters[i];
 
      if (!isValidECLCluster(cluster, pdgCode, true))
        continue;
 
      // create particle and check it before adding to list
      Particle particle(cluster, thisType);
      if (particle.getParticleSource() != Particle::c_ECLCluster) {
        B2FATAL("Particle created from ECLCluster does not have ECLCluster type.");
        continue;
      }
      Particle* newPart = m_particles.appendNew(particle);
 
      assignMCParticleFromECLCluster(newPart, cluster);
 
      // add particle to list
      plist->addParticle(newPart);
    }
 
    // load reconstructed KLM clusters as Klongs or neutrons or photons
    for (int i = 0; i < m_klmclusters.getEntries(); i++) {
      const KLMCluster* cluster      = m_klmclusters[i];
 
      if (std::isnan(cluster->getMomentumMag())) {
        B2DEBUG(19, "Skipping KLMCluster because its momentum is NaN. "
                "This can happen if the timing calibration is missing or wrong, so that the velocity is calculated to be negative.");
        continue;
      }
 
      const MCParticle* mcParticle = cluster->getRelated<MCParticle>();
 
      // create particle and check its type before adding it to list
      Particle particle(cluster, pdgCode);
      if (particle.getParticleSource() != Particle::c_KLMCluster) {
        B2FATAL("Particle created from KLMCluster does not have KLMCluster type.");
      }
      Particle* newPart = m_particles.appendNew(particle);
 
      if (mcParticle)
        newPart->addRelationTo(mcParticle);
 
      // add particle to list
      plist->addParticle(newPart);
    }
 
    plist->setEditable(false); // set the :all list as not editable.
  } // loop over particle lists
}

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 CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, AWESOMEBasicModule, and PyModule.

Definition at line 166 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 289 of file ParticleLoaderModule.cc.

{
  if (not m_particleExtraInfoMap) {
    m_particleExtraInfoMap.create();
  }
 
  if (m_useROEs)
    roeToParticles();
  else if (m_useDummy)
    dummyToParticles();
  else if (m_useMCParticles)
    mcParticlesToParticles();
  else if (m_loadChargedCluster)
    chargedClustersToParticles();
  else {
    tracksToParticles();
    eclAndKLMClustersToParticles();
    v0sToParticles();
  }
}

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.

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

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 111 of file ParticleLoaderModule.cc.

{
  B2INFO("ParticleLoader's Summary of Actions:");
 
  if ((int)m_useMCParticles + (int)m_useROEs + (int)m_useDummy + (int)m_loadChargedCluster > 1)
    B2FATAL("The options on how to load the Particle are not valid. The incompatible combination of options is selected. "
            << "useMCParticles: " << m_useMCParticles << ", useROEs: " << m_useROEs << ", useDummy: " << m_useDummy
            << ", loadChargedCluster: " << m_loadChargedCluster);
 
  m_particles.registerInDataStore();
  m_particleExtraInfoMap.registerInDataStore();
  m_eventExtraInfo.registerInDataStore();
  //register relations if these things exists
  if (m_mcparticles.isOptional()) {
    m_particles.registerRelationTo(m_mcparticles);
  }
  if (m_pidlikelihoods.isOptional()) {
    m_particles.registerRelationTo(m_pidlikelihoods);
  }
  if (m_trackfitresults.isOptional()) {
    m_particles.registerRelationTo(m_trackfitresults);
  }
 
  if (m_useMCParticles) {
    m_mcparticles.isRequired();
  }
 
  if (m_useROEs) {
    m_roes.isRequired();
    m_roes.registerRelationTo(m_particles);
 
    StoreArray<RestOfEvent> nestedRoes("NestedRestOfEvents");
    if (nestedRoes.isOptional())
      nestedRoes.registerRelationTo(m_particles);
  }
 
  if (m_decayStrings.empty()) {
    B2WARNING("Obsolete usage of the ParticleLoader module (load all MDST objects as all possible Particle object types). Specify the particle type via decayStrings module parameter instead.");
  } else {
    for (auto decayString : m_decayStrings) {
 
      // obtain the output particle lists from the decay string
      const bool valid = m_decaydescriptor.init(decayString);
      if (!valid)
        B2ERROR("ParticleLoaderModule::initialize Invalid input DecayString: " << decayString);
 
      // Mother particle
      const DecayDescriptorParticle* mother = m_decaydescriptor.getMother();
      int nProducts = m_decaydescriptor.getNDaughters();
 
      int pdgCode  = mother->getPDGCode();
      // The default list name is "all"
      string listName = mother->getName() + ":all";
 
      // Full name for ROE, dummy, MCParticle, chargedCluster particles
      if (m_useROEs or m_useDummy or m_useMCParticles or m_loadChargedCluster)
        listName = mother->getFullName();
      // V0s get the label "V0"
      else if (nProducts > 0)
        listName = mother->getName() + ":V0";
 
      string antiListName = ParticleListName::antiParticleListName(listName);
      bool isSelfConjugatedParticle = (listName == antiListName);
 
      StoreObjPtr<ParticleList> particleList(listName);
      // if the particle list doesn't exist, we have to register it
      if (!particleList.isOptional()) {
        DataStore::EStoreFlags flags = m_writeOut ? DataStore::c_WriteOut : DataStore::c_DontWriteOut;
        particleList.registerInDataStore(flags);
        if (!isSelfConjugatedParticle) {
          StoreObjPtr<ParticleList> antiParticleList(antiListName);
          antiParticleList.registerInDataStore(flags);
        }
      } else if (m_useMCParticles) {
        B2WARNING("ParticleList " << listName << " already exists and will not be created again. " <<
                  "Please note that the given options (addDaughters, skipNonPrimaryDaughters, skipNonPrimary, skipInitial) do not apply to "
                  << listName);
      } else if (m_loadChargedCluster) {
        B2WARNING("ParticleList " << listName << " already exists and will not be created again. " <<
                  "Please note that the given option, useOnlyMostEnergeticECLCluster, does not apply to "
                  << listName);
      }
 
      if (not isValidPDGCode(pdgCode) and (m_useMCParticles == false and m_useROEs == false and m_useDummy == false))
        B2ERROR("Invalid particle type requested to be loaded. Set a valid decayString module parameter.");
 
      // if we're not loading MCParticles and we are loading K0S, Lambdas, or photons --> ee then this decaystring is a V0
      bool mdstSourceIsV0 = false;
      if (!m_useMCParticles &&
          (abs(pdgCode) == abs(Const::Kshort.getPDGCode()) || abs(pdgCode) == abs(Const::Lambda.getPDGCode())
           || (abs(pdgCode) == abs(Const::photon.getPDGCode()) && m_addDaughters == true)))
        mdstSourceIsV0 = true;
 
      if (mdstSourceIsV0) {
        if (nProducts == 2) {
          m_properties = m_decaydescriptor.getProperty() | mother->getProperty(); // only used for V0s
          if (m_decaydescriptor.getDaughter(0)->getMother()->getPDGCode() * m_decaydescriptor.getDaughter(1)->getMother()->getPDGCode() > 0)
            B2ERROR("MDST source of the particle list is V0, the two daughters should have opposite charge");
        } else {
          B2ERROR("ParticleLoaderModule::initialize Invalid input DecayString " << decayString
                  << ". MDST source of the particle list is V0, DecayString should contain exactly two daughters, as well as the mother particle.");
        }
      } else {
        if (nProducts > 0) {
          if (m_useROEs or m_useDummy) {
            B2INFO("ParticleLoaderModule: Replacing the source particle list name by " <<
                   m_decaydescriptor.getDaughter(0)->getMother()->getFullName()
                   << " all other daughters will be ignored.");
            m_sourceParticleListName = m_decaydescriptor.getDaughter(0)->getMother()->getFullName();
          } else {
            B2ERROR("ParticleLoaderModule::initialize Invalid input DecayString " << decayString
                    << ". DecayString should not contain any daughters, only the mother particle.");
          }
        }
      }
 
      if (m_loadChargedCluster and m_sourceParticleListName == "")
        B2ERROR("The sourceParticleListName is not given. The charged ParticleList is required for the chargedCluster loading.");
 
      // add PList to corresponding collection of Lists
      B2INFO(" o) creating (anti-)ParticleList with name: " << listName << " (" << antiListName << ")");
      if (m_useROEs) {
        B2INFO("   -> MDST source: RestOfEvents");
        m_ROE2Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
      } else if (m_useDummy) {
        B2INFO("   -> MDST source: No MDST source");
        m_Dummies2Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
      } else if (m_useMCParticles) {
        B2INFO("   -> MDST source: MCParticles");
        m_MCParticles2Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
      } else if (m_loadChargedCluster) {
        if (abs(pdgCode) == abs(Const::photon.getPDGCode()) || abs(pdgCode) == abs(Const::Klong.getPDGCode())
            || abs(pdgCode) == abs(Const::neutron.getPDGCode())) {
          m_ChargedCluster2Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
          B2INFO("   -> MDST source: ECLClusters and KLMClusters being matched with Tracks");
        } else {
          B2ERROR("The Particle type must be gamma, K_L0, or (anti-)n0 for the loadChargedCluster option.");
        }
      } else {
        bool chargedFSP = Const::chargedStableSet.contains(Const::ParticleType(abs(pdgCode)));
        if (chargedFSP) {
          B2INFO("   -> MDST source: Tracks");
          m_Tracks2Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
        }
 
        if (abs(pdgCode) == abs(Const::photon.getPDGCode())) {
          if (m_addDaughters == false) {
            m_ECLKLMClusters2Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
            B2INFO("   -> MDST source: ECLClusters and KLMClusters");
          } else {
            B2INFO("   -> MDST source: V0");
            m_V02Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
          }
        }
 
        if (abs(pdgCode) == abs(Const::Kshort.getPDGCode())) {
          B2INFO("   -> MDST source: V0");
          m_V02Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
        }
 
        if (abs(pdgCode) == abs(Const::Klong.getPDGCode()) || abs(pdgCode) == abs(Const::neutron.getPDGCode())) {
          B2INFO("   -> MDST source: exclusively KLMClusters or exclusively ECLClusters (matching between those not used)");
          m_ECLKLMClusters2Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
        }
 
        if (abs(pdgCode) == abs(Const::Lambda.getPDGCode())) {
          B2INFO("   -> MDST source: V0");
          m_V02Plists.emplace_back(pdgCode, listName, antiListName, isSelfConjugatedParticle);
        }
      }
    }
  }
 
 
  m_chargeZeroTrackCounts = std::vector<int>(m_Tracks2Plists.size(), 0);
  m_sameChargeDaughtersV0Counts = std::vector<int>(m_V02Plists.size(), 0);
}

isValidECLCluster()

bool isValidECLCluster ( const ECLCluster *  cluster, const int  pdgCode, bool  onlyNeutral  ) const

private

Checks if the given ECLCluster is valid for the pdgCode.

Definition at line 781 of file ParticleLoaderModule.cc.

{
  if (!cluster)
    return false;
 
  // ECLClusters can be reconstructed under different hypotheses, for
  // example photons or neutral hadrons, we only load particles from these
  // for now
  if (!cluster->isNeutral() and onlyNeutral)
    return false;
 
  if (not cluster->hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons)
      and not cluster->hasHypothesis(ECLCluster::EHypothesisBit::c_neutralHadron))
    return false;
 
  // don't fill photon list with clusters that don't have
  // the nPhotons hypothesis (ECL people call this N1)
  if (pdgCode == Const::photon.getPDGCode()
      and not cluster->hasHypothesis(ECLCluster::EHypothesisBit::c_nPhotons))
    return false;
 
  // don't fill a KLong nor a (anti-)neutron list with clusters that don't have the neutral
  // hadron hypothesis set (ECL people call this N2)
  if ((pdgCode == Const::Klong.getPDGCode() or abs(pdgCode) == Const::neutron.getPDGCode())
      and not cluster->hasHypothesis(ECLCluster::EHypothesisBit::c_neutralHadron))
    return false;
 
  return true;
}

isValidPDGCode()

bool isValidPDGCode ( const int  pdgCode )

private

returns true if the PDG code determined from the decayString is valid

Definition at line 999 of file ParticleLoaderModule.cc.

{
  bool result = false;
 
  // is particle type = charged final state particle?
  if (Const::chargedStableSet.find(abs(pdgCode)) != Const::invalidParticle)
    return true;
 
  if (abs(pdgCode) == abs(Const::photon.getPDGCode()))
    return true;
 
  if (abs(pdgCode) == abs(Const::Kshort.getPDGCode()))
    return true;
 
  if (abs(pdgCode) == abs(Const::Klong.getPDGCode()))
    return true;
 
  if (abs(pdgCode) == abs(Const::Lambda.getPDGCode()))
    return true;
 
  if (abs(pdgCode) == abs(Const::neutron.getPDGCode()))
    return true;
 
  return result;
}

mcParticlesToParticles()

void mcParticlesToParticles ( )

private

Loads specified MCParticles as Particle to StoreArray<Particle>

Definition at line 948 of file ParticleLoaderModule.cc.

{
  if (m_MCParticles2Plists.empty()) // nothing to do
    return;
 
  // create all lists
  for (auto mcParticle2Plist : m_MCParticles2Plists) {
    string listName = get<c_PListName>(mcParticle2Plist);
    string antiListName = get<c_AntiPListName>(mcParticle2Plist);
    int pdgCode = get<c_PListPDGCode>(mcParticle2Plist);
    bool isSelfConjugatedParticle = get<c_IsPListSelfConjugated>(mcParticle2Plist);
 
    StoreObjPtr<ParticleList> plist(listName);
    if (plist.isValid())
      continue;
    plist.create();
    plist->initialize(pdgCode, listName);
 
    if (!isSelfConjugatedParticle) {
      StoreObjPtr<ParticleList> antiPlist(antiListName);
      antiPlist.create();
      antiPlist->initialize(-1 * pdgCode, antiListName);
 
      antiPlist->bindAntiParticleList(*(plist));
    }
 
    for (int i = 0; i < m_mcparticles.getEntries(); i++) {
      const MCParticle* mcParticle = m_mcparticles[i];
 
      if (abs(pdgCode) != abs(mcParticle->getPDG()))
        continue;
 
      if (m_skipNonPrimary and !mcParticle->hasStatus(MCParticle::c_PrimaryParticle))
        continue;
 
      if (m_skipInitial and mcParticle->isInitial())
        continue;
 
      Particle particle(mcParticle);
      Particle* newPart = m_particles.appendNew(particle);
      newPart->addRelationTo(mcParticle);
 
      //append the whole bottom part of the decay tree to this particle
      if (m_addDaughters) appendDaughtersRecursive(newPart);
 
      plist->addParticle(newPart);
    }
 
  }
}

roeToParticles()

void roeToParticles ( )

private

Loads ROE object as Particle of specified type to StoreArray<Particle> and adds it to the ParticleList.

Definition at line 383 of file ParticleLoaderModule.cc.

{
  if (m_ROE2Plists.empty()) // nothing to do
    return;
  // Multiple particle lists are not supported
  auto roe2Plist = m_ROE2Plists[0];
  string listName = get<c_PListName>(roe2Plist);
  string antiListName = get<c_AntiPListName>(roe2Plist);
  int pdgCode = get<c_PListPDGCode>(roe2Plist);
  bool isSelfConjugatedParticle = get<c_IsPListSelfConjugated>(roe2Plist);
 
  StoreObjPtr<ParticleList> plist(listName);
  // since a particle list in the ParticleLoader always contains all possible objects
  // we check whether it already exists in this path and can skip any further steps if it does
  if (plist.isValid())
    return;
  plist.create();
  plist->initialize(pdgCode, listName);
 
  if (!isSelfConjugatedParticle) {
    StoreObjPtr<ParticleList> antiPlist(antiListName);
    antiPlist.create();
    antiPlist->initialize(-1 * pdgCode, antiListName);
    antiPlist->bindAntiParticleList(*(plist));
  }
  if (m_sourceParticleListName != "") {
    // Take related ROEs from a particle list
    StoreObjPtr<ParticleList> pList(m_sourceParticleListName);
    if (!pList.isValid())
      B2FATAL("ParticleList " << m_sourceParticleListName << " could not be found or is not valid!");
 
    for (unsigned int i = 0; i < pList->getListSize(); i++) {
      RestOfEvent* roe = pList->getParticle(i)->getRelatedTo<RestOfEvent>("ALL");
      if (!roe) {
        B2ERROR("ParticleList " << m_sourceParticleListName << " has no associated ROEs!");
      } else {
 
        if (isSelfConjugatedParticle)
          addROEToParticleList(roe, i, pdgCode, isSelfConjugatedParticle);
        else if (i < pList->getListSize(false))
          addROEToParticleList(roe, i, pdgCode, isSelfConjugatedParticle);
        else
          addROEToParticleList(roe, i, -1 * pdgCode, isSelfConjugatedParticle);
      }
    }
 
  } else {
    // Take all ROE if no particle list provided
    for (int i = 0; i < m_roes.getEntries(); i++) {
      addROEToParticleList(m_roes[i], i);
    }
  }
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

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

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

terminate()

void terminate ( )

overridevirtual

Terminate the Module.

This method is called at the end of data processing.

Reimplemented from Module.

Definition at line 310 of file ParticleLoaderModule.cc.

{
  // report track errors integrated
  for (size_t i = 0; i < m_Tracks2Plists.size(); i++)
    if (m_chargeZeroTrackCounts[i] > 0) {
      auto track2Plist = m_Tracks2Plists[i];
      B2WARNING("There were " << m_chargeZeroTrackCounts[i]
                << " tracks skipped because of zero charge for "
                << get<c_PListName>(track2Plist));
    }
  // report V0 errors integrated
  for (size_t i = 0; i < m_V02Plists.size(); i++)
    if (m_sameChargeDaughtersV0Counts[i] > 0) {
      auto v02Plist = m_V02Plists[i];
      B2WARNING("There were " << m_sameChargeDaughtersV0Counts[i]
                << " v0s skipped because of same charge daughters for "
                << get<c_PListName>(v02Plist));
    }
}

tracksToParticles()

void tracksToParticles ( )

private

Loads Track object as Particle to StoreArray<Particle> and adds it to the ParticleList.

Definition at line 611 of file ParticleLoaderModule.cc.

{
  if (m_Tracks2Plists.empty()) // nothing to do
    return;
 
  // loop over all requested particle lists
  for (size_t ilist = 0; ilist < m_Tracks2Plists.size(); ilist++) {
    auto track2Plist = m_Tracks2Plists[ilist];
    string listName = get<c_PListName>(track2Plist);
    string antiListName = get<c_AntiPListName>(track2Plist);
    int pdgCode = get<c_PListPDGCode>(track2Plist);
    bool isSelfConjugatedParticle = get<c_IsPListSelfConjugated>(track2Plist);
 
    StoreObjPtr<ParticleList> plist(listName);
    // since a particle list in the ParticleLoader always contains all possible objects
    // we check whether it already exists in this path and can skip any further steps if it does
    if (plist.isValid())
      continue;
    plist.create();
    plist->initialize(pdgCode, listName);
 
    // if cc exists then also create and bind that list
    if (!isSelfConjugatedParticle) {
      StoreObjPtr<ParticleList> antiPlist(antiListName);
      antiPlist.create();
      antiPlist->initialize(-1 * pdgCode, antiListName);
 
      antiPlist->bindAntiParticleList(*(plist));
    }
 
    plist->setEditable(true); // :all list is originally reserved. we have to set it as editable.
 
    // the inner loop over all tracks from which Particles
    // are created, and get sorted in the particle lists
    for (int i = 0; i < m_tracks.getEntries(); i++) {
      const Track* track = m_tracks[i];
      const PIDLikelihood* pid = track->getRelated<PIDLikelihood>();
      const auto& mcParticleWithWeight = track->getRelatedToWithWeight<MCParticle>();
 
      // if a special track hypothesis is requested, use it
      if (m_trackHypothesis != 0) pdgCode = m_trackHypothesis;
      Const::ChargedStable type(abs(pdgCode));
 
      // load the TrackFitResult for the requested particle or if not available use
      // the one with the closest mass
      const TrackFitResult* trackFit = track->getTrackFitResultWithClosestMass(type);
 
      if (!trackFit) { // should never happen with the "closest mass" getter - leave as a sanity check
        B2WARNING("Track returned null TrackFitResult pointer for ChargedStable::getPDGCode()  = " << type.getPDGCode());
        continue;
      }
 
      if (m_enforceFitHypothesis && (trackFit->getParticleType().getPDGCode() != type.getPDGCode())) {
        // the required hypothesis does not exist for this track, skip it
        continue;
      }
 
      // charge zero tracks can appear, filter them and
      // count number of tracks filtered out
      int charge = trackFit->getChargeSign();
      if (charge == 0) {
        B2DEBUG(19, "Track with charge = 0 skipped!");
        m_chargeZeroTrackCounts[ilist]++;
        continue;
      }
 
      // create particle and add it to the Particle list.
      Particle particle(track->getArrayIndex(), trackFit, type);
 
      if (particle.getParticleSource() == Particle::c_Track) { // should always hold but...
 
        Particle* newPart = m_particles.appendNew(particle);
        if (pid)
          newPart->addRelationTo(pid);
        if (mcParticleWithWeight.first)
          newPart->addRelationTo(mcParticleWithWeight.first, mcParticleWithWeight.second);
        newPart->addRelationTo(trackFit);
 
        plist->addParticle(newPart);
 
      } // sanity check correct particle type
    } // loop over tracks
 
    plist->setEditable(false); // set the :all list as not editable.
  } // particle lists
}

v0sToParticles()

void v0sToParticles ( )

private

Loads V0 object as Particle of specified type to StoreArray<Particle> and adds it to the ParticleList.

Definition at line 467 of file ParticleLoaderModule.cc.

{
  if (m_V02Plists.empty()) // nothing to do
    return;
 
  // check if the order of the daughters in the decay string (decided by the user) is the same as the v0 daughters' order (fixed)
  bool matchingDaughtersOrder = true;
  if (m_decaydescriptor.getDaughter(0)->getMother()->getPDGCode() < 0
      && m_decaydescriptor.getDaughter(1)->getMother()->getPDGCode() > 0)
    matchingDaughtersOrder = false;
 
  // loop over all ParticleLists
  for (size_t ilist = 0; ilist < m_V02Plists.size(); ilist++) {
    auto v02Plist = m_V02Plists[ilist];
    string listName = get<c_PListName>(v02Plist);
    string antiListName = get<c_AntiPListName>(v02Plist);
    int pdgCode = get<c_PListPDGCode>(v02Plist);
    bool isSelfConjugatedParticle = get<c_IsPListSelfConjugated>(v02Plist);
 
    StoreObjPtr<ParticleList> plist(listName);
    // since a particle list in the ParticleLoader always contains all possible objects
    // we check whether it already exists in this path and can skip any further steps if it does
    if (plist.isValid())
      continue;
    plist.create();
    plist->initialize(pdgCode, listName);
 
    if (!isSelfConjugatedParticle) {
      StoreObjPtr<ParticleList> antiPlist(antiListName);
      antiPlist.create();
      antiPlist->initialize(-1 * pdgCode, antiListName);
 
      antiPlist->bindAntiParticleList(*(plist));
    }
 
    plist->setEditable(true); // :V0 list is originally reserved. we have to set it as editable.
 
    // load reconstructed V0s as Kshorts (pi-pi+ combination), Lambdas (p+pi- combinations), and converted photons (e-e+ combinations)
    for (int i = 0; i < m_v0s.getEntries(); i++) {
      const V0* v0 = m_v0s[i];
      Const::ParticleType v0Type = v0->getV0Hypothesis();
 
      if (abs(pdgCode) != abs(v0Type.getPDGCode()))
        continue;
 
      // check if the charge of the 2 V0's daughters is opposite
      if (v0->getTrackFitResults().first->getChargeSign() == v0->getTrackFitResults().second->getChargeSign()) {
        B2DEBUG(19, "V0 with same charge daughters skipped!");
        m_sameChargeDaughtersV0Counts[ilist]++;
        continue;
      }
 
      Const::ChargedStable pTypeP(Const::pion);
      Const::ChargedStable pTypeM(Const::pion);
      Particle::EFlavorType v0FlavorType = Particle::c_Unflavored;
 
      if (v0Type.getPDGCode() == Const::Kshort.getPDGCode()) { // K0s -> pi+ pi-
        pTypeP = Const::pion;
        pTypeM = Const::pion;
      } else if (v0Type.getPDGCode() == Const::Lambda.getPDGCode()) { // Lambda -> p+ pi-
        pTypeP = Const::proton;
        pTypeM = Const::pion;
        v0FlavorType = Particle::c_Flavored; // K0s are not flavoured, lambdas are
      } else if (v0Type.getPDGCode() == Const::antiLambda.getPDGCode()) { // anti-Lambda -> pi+ anti-p-
        pTypeP = Const::pion;
        pTypeM = Const::proton;
        v0FlavorType = Particle::c_Flavored;
      } else if (v0Type.getPDGCode() == Const::photon.getPDGCode()) { // gamma -> e+ e-
        pTypeP = Const::electron;
        pTypeM = Const::electron;
      } else {
        B2WARNING("Unknown V0 hypothesis!");
      }
 
      // check if, given the initial user's decay descriptor, the current v0 is a particle or an anti-particle.
      // in the V0 the order of the daughters is fixed, first the positive and then the negative; to be coherent with the decay descriptor, when creating
      // one particle list and one anti-particle, the v0 daughters' order has to be switched only in one case
      bool correctOrder = matchingDaughtersOrder;
      if (abs(v0Type.getPDGCode()) == abs(m_decaydescriptor.getMother()->getPDGCode())
          && v0Type.getPDGCode() != m_decaydescriptor.getMother()->getPDGCode())
        correctOrder = !correctOrder;
 
      std::pair<Track*, Track*> v0Tracks = v0->getTracks();
      std::pair<TrackFitResult*, TrackFitResult*> v0TrackFitResults = v0->getTrackFitResults();
 
      Particle daugP((v0Tracks.first)->getArrayIndex(), v0TrackFitResults.first, pTypeP);
      Particle daugM((v0Tracks.second)->getArrayIndex(), v0TrackFitResults.second, pTypeM);
 
      const PIDLikelihood* pidP = (v0Tracks.first)->getRelated<PIDLikelihood>();
      const PIDLikelihood* pidM = (v0Tracks.second)->getRelated<PIDLikelihood>();
 
      const auto& mcParticlePWithWeight = (v0Tracks.first)->getRelatedToWithWeight<MCParticle>();
      const auto& mcParticleMWithWeight = (v0Tracks.second)->getRelatedToWithWeight<MCParticle>();
 
      // add V0 daughters to the Particle StoreArray
      Particle* newDaugP;
      Particle* newDaugM;
 
      if (correctOrder) {
        newDaugP = m_particles.appendNew(daugP);
        newDaugM = m_particles.appendNew(daugM);
      } else {
        newDaugM = m_particles.appendNew(daugM);
        newDaugP = m_particles.appendNew(daugP);
      }
 
      // if there are PIDLikelihoods and MCParticles then also add relations to the particles
      if (pidP)
        newDaugP->addRelationTo(pidP);
      if (mcParticlePWithWeight.first)
        newDaugP->addRelationTo(mcParticlePWithWeight.first, mcParticlePWithWeight.second);
      newDaugP->addRelationTo(v0TrackFitResults.first);
 
      if (pidM)
        newDaugM->addRelationTo(pidM);
      if (mcParticleMWithWeight.first)
        newDaugM->addRelationTo(mcParticleMWithWeight.first, mcParticleMWithWeight.second);
      newDaugM->addRelationTo(v0TrackFitResults.second);
 
      // sum the 4-momenta of the daughters and construct a particle object
      ROOT::Math::PxPyPzEVector v0Momentum = newDaugP->get4Vector() + newDaugM->get4Vector();
      Particle v0P(v0Momentum, v0Type.getPDGCode(), v0FlavorType,
                   Particle::EParticleSourceObject::c_V0, v0->getArrayIndex());
      v0P.setProperty(m_properties);
 
      // add the daughters of the V0 (in the correct order) and don't update
      // the type to c_Composite (i.e. maintain c_V0)
      if (correctOrder) {
        v0P.appendDaughter(newDaugP, false);
        v0P.appendDaughter(newDaugM, false);
      } else {
        v0P.appendDaughter(newDaugM, false);
        v0P.appendDaughter(newDaugP, false);
      }
 
      // append the particle to the Particle StoreArray and add the new particle to the ParticleList
      Particle* newPart = m_particles.appendNew(v0P);
      plist->addParticle(newPart);
    }
 
    plist->setEditable(false); // set the :V0 list as not editable.
  }
}

Member Data Documentation

m_addDaughters

bool m_addDaughters

private

toggle addition of the bottom part of the particle's decay chain

Definition at line 222 of file ParticleLoaderModule.h.

m_ChargedCluster2Plists

std::vector<PList> m_ChargedCluster2Plists

private

Collection of PLists that will collect Particles created from charged-cluster.

Definition at line 216 of file ParticleLoaderModule.h.

m_chargeZeroTrackCounts

std::vector<int> m_chargeZeroTrackCounts

private

internally used to count number of tracks with charge zero

Definition at line 236 of file ParticleLoaderModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_decaydescriptor

DecayDescriptor m_decaydescriptor

private

Decay descriptor for parsing the user specified DecayString.

Definition at line 204 of file ParticleLoaderModule.h.

m_decayStrings

std::vector<std::string> m_decayStrings

private

Input decay strings specifying the particles being created/loaded.

Definition at line 207 of file ParticleLoaderModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_Dummies2Plists

std::vector<PList> m_Dummies2Plists

private

Collection of PLists that will collect Particles created from Dummies.

Definition at line 215 of file ParticleLoaderModule.h.

m_dummyCovMatrix

double m_dummyCovMatrix

private

diag value of cov matrix for dummy particles

Definition at line 230 of file ParticleLoaderModule.h.

m_dummyMDSTIndex

int m_dummyMDSTIndex

private

mdst index for dummy particles

Definition at line 229 of file ParticleLoaderModule.h.

m_dummyTreatAsInvisible

bool m_dummyTreatAsInvisible

private

should treeFitter treat the particle as invisible?

Definition at line 231 of file ParticleLoaderModule.h.

m_eclclusters

StoreArray<ECLCluster> m_eclclusters

private

StoreArray of ECLCluster.

Definition at line 185 of file ParticleLoaderModule.h.

m_ECLKLMClusters2Plists

std::vector<PList> m_ECLKLMClusters2Plists

private

Collection of PLists that will collect Particles created from ECLClusters and KLMClusters.

Definition at line 214 of file ParticleLoaderModule.h.

m_enforceFitHypothesis

bool m_enforceFitHypothesis

private

Initial value:

=
      false

If true, a Particle is only created if a track fit with the particle hypothesis passed to the ParticleLoader is available.

Definition at line 233 of file ParticleLoaderModule.h.

m_eventExtraInfo

StoreObjPtr<EventExtraInfo> m_eventExtraInfo

private

object pointer to event extra info

Definition at line 190 of file ParticleLoaderModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_klmclusters

StoreArray<KLMCluster> m_klmclusters

private

StoreArray of KLMCluster.

Definition at line 186 of file ParticleLoaderModule.h.

m_loadChargedCluster

bool m_loadChargedCluster

private

Switch to load charged-cluster

Definition at line 201 of file ParticleLoaderModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_mcparticles

StoreArray<MCParticle> m_mcparticles

private

StoreArray of MCParticles.

Definition at line 184 of file ParticleLoaderModule.h.

m_MCParticles2Plists

std::vector<PList> m_MCParticles2Plists

private

Collection of PLists that will collect Particles created from MCParticles.

Definition at line 209 of file ParticleLoaderModule.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

m_particleExtraInfoMap

StoreObjPtr<ParticleExtraInfoMap> m_particleExtraInfoMap

private

object pointer to extra info map

Definition at line 191 of file ParticleLoaderModule.h.

m_particles

StoreArray<Particle> m_particles

private

StoreArray of Particles.

Definition at line 183 of file ParticleLoaderModule.h.

m_pidlikelihoods

StoreArray<PIDLikelihood> m_pidlikelihoods

private

StoreArray of PIDLikelihoods.

Definition at line 187 of file ParticleLoaderModule.h.

m_properties

int m_properties

private

Particle property to be assigned only on V0s.

Flags are defined in Particle::PropertyFlags

Definition at line 205 of file ParticleLoaderModule.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_ROE2Plists

std::vector<PList> m_ROE2Plists

private

Collection of PLists that will collect Particles created from V0.

Definition at line 212 of file ParticleLoaderModule.h.

m_roeMaskName

std::string m_roeMaskName

private

ROE mask name to load.

Definition at line 224 of file ParticleLoaderModule.h.

m_roes

StoreArray<RestOfEvent> m_roes

private

StoreArray of ROEs.

Definition at line 192 of file ParticleLoaderModule.h.

m_sameChargeDaughtersV0Counts

std::vector<int> m_sameChargeDaughtersV0Counts

private

internally used to count the number of V0s with same charge daughters

Definition at line 237 of file ParticleLoaderModule.h.

m_skipInitial

bool m_skipInitial

private

toggle skip of initial MC particles

Definition at line 220 of file ParticleLoaderModule.h.

m_skipNonPrimary

bool m_skipNonPrimary

private

toggle skip of secondary MC particle

Definition at line 221 of file ParticleLoaderModule.h.

m_skipNonPrimaryDaughters

bool m_skipNonPrimaryDaughters

private

toggle skip of secondary MC daughters

Definition at line 223 of file ParticleLoaderModule.h.

m_sourceParticleListName

std::string m_sourceParticleListName

private

Particle list name from which we need to get related ROEs.

Definition at line 225 of file ParticleLoaderModule.h.

m_trackfitresults

StoreArray<TrackFitResult> m_trackfitresults

private

StoreArray of TrackFitResults.

Definition at line 189 of file ParticleLoaderModule.h.

m_trackHypothesis

int m_trackHypothesis

private

pdg code for track hypothesis that should be used to create the particle

Definition at line 227 of file ParticleLoaderModule.h.

m_tracks

StoreArray<Track> m_tracks

private

StoreArray of Tracks.

Definition at line 188 of file ParticleLoaderModule.h.

m_Tracks2Plists

std::vector<PList> m_Tracks2Plists

private

Collection of PLists that will collect Particles created from Tracks.

Definition at line 210 of file ParticleLoaderModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

m_useDummy

bool m_useDummy

private

Switch to load dummy as Particle.

Definition at line 199 of file ParticleLoaderModule.h.

m_useMCParticles

bool m_useMCParticles

private

Load MCParticle as Particle instead of the corresponding MDST dataobject.

Definition at line 195 of file ParticleLoaderModule.h.

m_useMissing

bool m_useMissing

private

Use missing momentum to build a particle.

Definition at line 226 of file ParticleLoaderModule.h.

m_useOnlyMostEnergeticECLCluster

bool m_useOnlyMostEnergeticECLCluster

private

If true, only the most energetic ECLCluster is used.

Definition at line 202 of file ParticleLoaderModule.h.

m_useROEs

bool m_useROEs

private

Switch to load ROE as Particle.

Definition at line 197 of file ParticleLoaderModule.h.

m_V02Plists

std::vector<PList> m_V02Plists

private

Collection of PLists that will collect Particles created from V0.

Definition at line 211 of file ParticleLoaderModule.h.

m_v0s

StoreArray<V0> m_v0s

private

StoreArray of V0s.

Definition at line 193 of file ParticleLoaderModule.h.

m_writeOut

bool m_writeOut

private

toggle particle list btw.

transient/persistent

Definition at line 219 of file ParticleLoaderModule.h.

---

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

• analysis/modules/ParticleLoader/include/ParticleLoaderModule.h
• analysis/modules/ParticleLoader/src/ParticleLoaderModule.cc