Belle II Software  release-08-01-10
B2BIIConvertMdstModule Class Reference

Module converts Belle MDST objects (Panther records) to Belle II MDST objects. More...

#include <B2BIIConvertMdstModule.h>

Inheritance diagram for B2BIIConvertMdstModule:
Collaboration diagram for B2BIIConvertMdstModule:

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

 B2BIIConvertMdstModule ()
 Constructor.
 
virtual ~B2BIIConvertMdstModule () override
 Destructor.
 
virtual void initialize () override
 Initialize the module.
 
virtual void beginRun () override
 Module functions to be called from event process. More...
 
virtual void event () override
 Called for each event.
 
virtual void endRun () override
 Called when the current run is finished.
 
virtual void terminate () override
 Terminates the module.
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules. More...
 
const std::string & getName () const
 Returns the name of the module. More...
 
const std::string & getType () const
 Returns the type of the module (i.e. More...
 
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. More...
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties. More...
 
LogConfiggetLogConfig ()
 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. More...
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module. More...
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module. More...
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module. More...
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () 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. More...
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer). More...
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished. More...
 
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. More...
 
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 ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter. More...
 
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. More...
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module. More...
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters. More...
 

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. More...
 
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. More...
 
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. More...
 
void setType (const std::string &type)
 Set the module type. More...
 
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. More...
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module. More...
 
void setReturnValue (int value)
 Sets the return value for this module as integer. More...
 
void setReturnValue (bool value)
 Sets the return value for this module as bool. More...
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Private Types

enum  MCMatchingMode {
  c_Direct ,
  c_GeneratorLevel
}
 MC matching mode. More...
 

Private Member Functions

void initializeDataStore ()
 Initializes Belle II DataStore.
 
void convertRecTrgTable ()
 Reads and converts m_final from rectrg_summary3.
 
void convertEvtclsTable ()
 Reads and converts all entries of evtcls Panther table.
 
void convertGenHepEvtTable ()
 Reads and converts all entries of Gen_hepevt Panther table to MCParticle dataobjects and adds them to StoreArray<MCParticle>.
 
void convertMdstECLTable ()
 Reads and converts all entries of Mdst_ecl(_aux) Panther table to ECLCluster dataobjects and adds them to StoreArray<ECLCluster>.
 
void convertMdstKLMTable ()
 Reads and converts all entries of Mdst_klm_cluster Panther table to KLMCluster dataobjects and adds them to StoreArray<KLMCluster>.
 
void convertMdstChargedTable ()
 Reads and converts all entries of Mdst_charged (Mdst_trk and Mdst_trk_fit) Panther table to Track (TrackFitResult) dataobjects and adds them to StoreArray<Track> (StoreArray<TrackFitResult>).
 
void convertMdstGammaTable ()
 Reads all entries of Mdst_Gamma Panther table, creates a particle list 'gamma:mdst' and adds them to StoreArray<Particles>.
 
void copyNbarFromGamma ()
 Copies Particles in 'gamma:mdst' with energy > 0.5 GeV to be anti-n0:mdst.
 
void convertMdstKLongTable ()
 Reads all entries of Mdst_Klong Panther table, creates a particle list 'K_L0:mdst' and adds them to StoreArray<Particles>.
 
void convertMdstPi0Table ()
 Reads all entries of Mdst_Pi0 Panther table, creates a particle list 'pi0:mdst' and adds them to StoreArray<Particles>.
 
void convertMdstVee2Table ()
 Reads and converts all entries of Mdst_vee2 Panther table to V0 dataobjects and adds them to StoreArray<V0>. More...
 
void convertBeamEnergy ()
 Stores beam parameters (energy, angles) in CollisionInvariantMass and CollisionBoostVector (currently in the DataStore).
 
void convertIPProfile (bool beginRun=false)
 Stores the IPProfiles in BeamSpot (currently in DataStore)
 
void convertGenHepevtObject (const Belle::Gen_hepevt &genHepevt, MCParticleGraph::GraphParticle *mcParticle)
 Converts Gen_hepevt record to MCParticleGraph object.
 
void convertMdstECLObject (const Belle::Mdst_ecl &ecl, const Belle::Mdst_ecl_aux &eclAux, ECLCluster *eclCluster)
 Converts Mdst_ecl(_aux) record to ECLCluster object. More...
 
double computeTrkMinDistanceBelle (ECLCluster *eclCluster)
 calculate the minimal distance between a cluster and a set of tracks on the ECL surface.
 
void convertMdstKLMObject (const Belle::Mdst_klm_cluster &klm, KLMCluster *klmCluster)
 Converts Mdst_klm_cluster record to KLMCluster object. More...
 
void convertMdstChargedObject (const Belle::Mdst_charged &belleTrack, Track *track)
 Converts Mdst_charged (Mdst_trk(_fit)) record to Track (TrackFitResult) object. More...
 
TrackFitResult createTrackFitResult (const CLHEP::HepLorentzVector &momentum, const HepPoint3D &position, const CLHEP::HepSymMatrix &error, const short int charge, const Const::ParticleType &pType, const float pValue, const uint64_t hitPatternCDCInitializer, const uint32_t hitPatternVXDInitializer, const uint16_t ndf)
 Creates TrackFitResult and fills it.
 
int getHelixParameters (const Belle::Mdst_trk_fit &trk_fit, const double mass, const HepPoint3D &newPivot, std::vector< float > &helixParams, CLHEP::HepSymMatrix &error5x5, CLHEP::HepLorentzVector &momentum, HepPoint3D &position, CLHEP::HepSymMatrix &error7x7, const double dPhi=0.0)
 Fills Helix parameters (converted to Belle II version), 5x5 error matrix, 4-momentum, position and 7x7 error matrix from Belle Helix stored in Mdst_trk_fit.
 
void convertHelix (Belle::Helix &helix, std::vector< float > &helixParams, CLHEP::HepSymMatrix &error5x5)
 Converts Belle's Helix parameters and it's covariance matrix to Belle II's version.
 
void convertHelix (const Belle::Mdst_trk_fit &trk_fit, const HepPoint3D &newPivot, std::vector< float > &helixParams, std::vector< float > &helixError)
 Converts Belle's Helix parameters and it's covariance matrix to Belle II's version.
 
void belleVeeDaughterToCartesian (const Belle::Mdst_vee2 &vee, const int charge, const Const::ParticleType &pType, CLHEP::HepLorentzVector &momentum, HepPoint3D &position, CLHEP::HepSymMatrix &error)
 Fills 4-momentum, position and 7x7 error matrix from Belle Vee daughter.
 
void belleVeeDaughterHelix (const Belle::Mdst_vee2 &vee, const int charge, std::vector< float > &helixParam, std::vector< float > &helixError)
 obtains the helix parameters of the vee daughters
 
void convertPIDData (const Belle::Mdst_charged &belleTrack, const Track *track)
 Get PID information for belleTrack and add it to PIDLikelihood (with relation from track).
 
void setLikelihoods (PIDLikelihood *pid, Const::EDetector det, double likelihoods[c_nHyp], bool discard_allzero=false)
 Add given Belle likelihoods (not log-likelihoods, in Belle hypothesis order) for given detector to pid.
 
double cdc_pid (const Belle::Mdst_charged &chg, int idp)
 Returns CDC likelihood for given hypothesis idp. More...
 
double atcPID (const PIDLikelihood *pid, int sigHyp, int bkgHyp)
 calculates atc_pid(3,1,5,sigHyp,bkgHyp).prob() from converted PIDLikelihood
 
void setTracksToECLClustersRelations ()
 Sets Track -> ECLCluster relations.
 
void setKLMClustersRelations ()
 Sets KLMCluster -> Track and ECLCluster relations.
 
int recoverMoreThan24bitIDHEP (int id)
 Helper function to recover falsely set idhep info in GenHepEvt list.
 
void testMCRelation (const Belle::Gen_hepevt &belleMC, const MCParticle *mcP, const std::string &objectName)
 Checks if the reconstructed object (Track, ECLCluster, ...) was matched to the same MCParticle.
 
std::list< ModulePtrgetModules () 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. More...
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary. More...
 

Static Private Member Functions

static double acc_pid (const Belle::Mdst_charged &chg, int idp)
 Returns ACC likelihood for given hypothesis idp. More...
 

Private Attributes

bool m_realData
 flag that tells whether given data sample is for real data or MC
 
bool m_convertBeamParameters
 Convert beam parameters or use information stored in Belle II database.
 
bool m_use6x6CovarianceMatrix4Tracks
 flag that tells which form of covariance matrix should be used in the conversion of charged tracks
 
std::string m_mcMatchingModeString
 MC matching mode.
 
MCMatchingMode m_mcMatchingMode
 C matching mode.
 
bool m_convertEvtcls
 Flag to switch on conversion of Evtcls table.
 
bool m_nisEnable
 Flag to switch on conversion of nisKsFinder info.
 
bool m_convertRecTrg
 Flag to switch on conversion of rectrg_summary3.
 
bool m_convertTrkExtra
 Flag to switch on conversion of first(last)_{x,y,z} of mdst_trk_fit.
 
bool m_convertNbar
 Flag to create anti-n0:mdst list from gamma:mdst.
 
double m_matchType2E9oE25Threshold
 E9/E25 threshold value clusters with a value above this threshold are classified as neutral even if tracks are matched to their connected region (matchType == 2)
 
int m_lastIPProfileBin { -1}
 variable to tell us which IPProfile bin was active last time we looked
 
Belle2::MCParticleGraph m_particleGraph
 MCParticle Graph to build Belle2 MC Particles.
 
std::map< int, int > genHepevtToMCParticle
 map of Gen_hepevt Panther IDs and corresponding MCParticle StoreArray indices
 
std::map< int, int > mdstEclToECLCluster
 map of Mdst_ecl Panther IDs and corresponding ECLCluster StoreArray indices
 
std::map< int, int > mdstGammaToParticle
 map of gamma Panther IDs and corresponding Particle StoreArray indices
 
std::map< int, int > mdstKlmToKLMCluster
 map of Mdst_klm Panther IDs and corresponding KLMCluster StoreArray indices
 
std::map< int, int > mdstKlongToParticle
 map of Klong Panther IDs and corresponding Particle StoreArray indices
 
StoreArray< MCParticlem_mcParticles
 MC particles.
 
StoreArray< ECLClusterm_eclClusters
 ECL clusters.
 
StoreArray< KLMClusterm_klmClusters
 KLM clusters.
 
StoreArray< Trackm_tracks
 Tracks.
 
StoreArray< TrackFitResultm_trackFitResults
 Track fir results.
 
StoreArray< V0m_v0s
 V0-particles.
 
StoreArray< Particlem_particles
 Particles.
 
StoreArray< BelleTrkExtram_belleTrkExtra
 Belle CDC extra information.
 
StoreArray< PIDLikelihoodm_pidLikelihoods
 output PIDLikelihood array.
 
StoreObjPtr< EventExtraInfom_evtInfo
 Event Extra Info.
 
OptionalDBObjPtr< BeamSpotm_beamSpotDB
 BeamSpot for IP.
 
BeamSpot m_beamSpot
 Interaction Point of the beam.
 
OptionalDBObjPtr< CollisionBoostVectorm_collisionBoostVectorDB
 CollisionBoostVector for boost vector.
 
CollisionBoostVector m_collisionBoostVector
 CollisionBoostVector for bosst vector of the beam.
 
OptionalDBObjPtr< CollisionInvariantMassm_collisionInvMDB
 CollisionInvariantMass for Invariant Mass of Beam.
 
CollisionInvariantMass m_collisionInvM
 CollisionInvariantMass for the invariant mass of the beam.
 
const int ERRMCONV [7] = {3, 4, 5, -1, 0, 1, 2}
 CONVERSION OF TRACK ERROR MATRIX ELEMENTS. More...
 
const double BFIELD = 1.5
 B filed in TESLA.
 
const double KAPPA2OMEGA = 1.5 * TMath::C() * 1E-11
 Conversion factor for Kappa -> Omega helix parameters.
 
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< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Static Private Attributes

static const int c_nHyp = 5
 Number of Belle track hypotheses (see c_belleHyp_to_chargedStable).
 
static const Const::ChargedStable c_belleHyp_to_chargedStable [c_nHyp] = { Const::electron, Const::muon, Const::pion, Const::kaon, Const::proton }
 maps Belle hypotheses to Const::ChargedStable (from http://belle.kek.jp/secured/wiki/doku.php?id=software:atc_pid).
 

Detailed Description

Module converts Belle MDST objects (Panther records) to Belle II MDST objects.

The module performs conversion of the following Belle Panther records:

o) Gen_hepevt -> MCParticle

o) Mdst_ecl and Mdst_ecl_aux -> ECLCluster

The following relations are created:

o) ECLCluster -> MCParticle

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

◆ MCMatchingMode

enum MCMatchingMode
private

MC matching mode.

Enumerator
c_Direct 

Direct matching.

c_GeneratorLevel 

Match to generator-level particles.

Definition at line 99 of file B2BIIConvertMdstModule.h.

99  {
100 
102  c_Direct,
103 
106 
107  };
@ c_GeneratorLevel
Match to generator-level particles.

Member Function Documentation

◆ acc_pid()

static double acc_pid ( const Belle::Mdst_charged &  chg,
int  idp 
)
staticprivate

Returns ACC likelihood for given hypothesis idp.

Copied from atc_pid::acc_pid().

◆ beginRun()

void beginRun ( void  )
overridevirtual

Module functions to be called from event process.

Called when the current run begins.

Reimplemented from Module.

Definition at line 268 of file B2BIIConvertMdstModule.cc.

269 {
270  B2DEBUG(99, "B2BIIConvertMdst: beginRun called.");
271 
273  //BeamEnergy class updated by fixmdst module in beginRun()
274  Belle::BeamEnergy::begin_run();
276  Belle::BeamEnergy::dump();
277 
278  // load IP data from DB server
279  Belle::IpProfile::begin_run();
280  convertIPProfile(true);
281  Belle::IpProfile::dump();
282  bool usableIP = Belle::IpProfile::usable();
283  B2DEBUG(99, "B2BIIConvertMdst: IpProfile is usable = " << usableIP);
284  }
285 
286  //init eID
287 #ifdef HAVE_EID
288  Belle::eid::init_data();
289  Belle::eid::show_use("ALL");
290 #endif
291 }
void convertIPProfile(bool beginRun=false)
Stores the IPProfiles in BeamSpot (currently in DataStore)
bool m_convertBeamParameters
Convert beam parameters or use information stored in Belle II database.
void convertBeamEnergy()
Stores beam parameters (energy, angles) in CollisionInvariantMass and CollisionBoostVector (currently...

◆ cdc_pid()

double cdc_pid ( const Belle::Mdst_charged &  chg,
int  idp 
)
private

Returns CDC likelihood for given hypothesis idp.

Copied from atc_pid::cdd_pid().

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

◆ convertMdstChargedObject()

void convertMdstChargedObject ( const Belle::Mdst_charged &  belleTrack,
Track track 
)
private

Converts Mdst_charged (Mdst_trk(_fit)) record to Track (TrackFitResult) object.

If running on MC, the Track -> MCParticle relation is set as well.

Definition at line 1669 of file B2BIIConvertMdstModule.cc.

◆ convertMdstECLObject()

void convertMdstECLObject ( const Belle::Mdst_ecl &  ecl,
const Belle::Mdst_ecl_aux &  eclAux,
ECLCluster eclCluster 
)
private

Converts Mdst_ecl(_aux) record to ECLCluster object.

If running on MC, the ECLCluster -> MCParticle relation is set as well.

Definition at line 1870 of file B2BIIConvertMdstModule.cc.

◆ convertMdstKLMObject()

void convertMdstKLMObject ( const Belle::Mdst_klm_cluster &  klm,
KLMCluster klmCluster 
)
private

Converts Mdst_klm_cluster record to KLMCluster object.

No MCRelation is set, since there was no matching in Belle.

Definition at line 1971 of file B2BIIConvertMdstModule.cc.

◆ convertMdstVee2Table()

void convertMdstVee2Table ( )
private

Reads and converts all entries of Mdst_vee2 Panther table to V0 dataobjects and adds them to StoreArray<V0>.

V0 daughters are converted from Mdst_Vee_Daughters to TrackFitResults, which are appended to the TrackFitResult StoreArray.

Definition at line 504 of file B2BIIConvertMdstModule.cc.

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

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

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

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

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

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

Definition at line 134 of file Module.h.

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

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

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

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

◆ 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
nameThe name of the module

Definition at line 214 of file Module.h.

◆ 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
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

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

Member Data Documentation

◆ ERRMCONV

const int ERRMCONV[7] = {3, 4, 5, -1, 0, 1, 2}
private

CONVERSION OF TRACK ERROR MATRIX ELEMENTS.

Belle error matrix elements are in the following order px/py/pz/E/x/y/z or in indices are (0,1,2,3,4,5,6) Belle II error matrix elements are in the following order x/y/z/px/py/pz or in indices (0,1,2,3,4,5). The conversion of indices is therefore: 4 -> 0, 5 -> 1, 6 -> 2, 0 -> 3, 1 -> 4, 2 -> 5, and 3 -> nothing.

Definition at line 433 of file B2BIIConvertMdstModule.h.


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