Belle II Software light-2406-ragdoll
ParticleKinematicFitterModule Class Reference

Kinematic fitter module. More...

#include <ParticleKinematicFitterModule.h>

Inheritance diagram for ParticleKinematicFitterModule:
Collaboration diagram for ParticleKinematicFitterModule:

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

 ParticleKinematicFitterModule ()
 Constructor.
 
virtual void initialize () override
 Initialize the Module.
 
virtual void terminate () override
 termination.
 
virtual void event () override
 Event processor.
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
virtual void beginRun ()
 Called when entering a new run.
 
virtual void endRun ()
 This method is called if the current run ends.
 
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.
 
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.
 
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 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.
 
std::shared_ptr< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

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

Private Member Functions

bool doKinematicFit (Particle *p)
 Main steering routine for any kinematic fitter.
 
bool doOrcaKinFitFit (Particle *p)
 Kinematic fit using OrcaKinFit.
 
bool fillFitParticles (Particle *mother, std::vector< Particle * > &particleChildren)
 Fills valid particle's children (with valid error matrix) in the vector of Particles that will enter the fit.
 
bool AddFour (Particle *mother)
 Added four vectors and calculated a covariance matrix for a combined particles.
 
void addParticleToOrcaKinFit (BaseFitter &fitter, Particle *particle, const int index)
 Adds given particle to the OrcaKinFit.
 
void addFitObjectToConstraints (ParticleFitObject &fitobject)
 Adds Orca fit object to the constraints.
 
void addConstraintsToFitter (BaseFitter &fitter)
 Adds Orca fit object to the constraints.
 
void addTracerToFitter (BaseFitter &fitter)
 Adds tracer to the fitter.
 
void setConstraints ()
 Sets constraints, this is not connect to particles or a fitter at this stage.
 
ROOT::Math::PxPyPzEVector getLorentzVectorConstraints ()
 Get constraints (at whatever stage before/after fitting)
 
void resetFitter (BaseFitter &fitter)
 Resets all objects associated with the OrcaKinFit fitter.
 
void addUnmeasuredGammaToOrcaKinFit (BaseFitter &fitter)
 Adds an unmeasured gamma (E, phi, theta) to the fit (-3C) stored as EventExtraInfo TODO.
 
void updateOrcaKinFitMother (BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
 Update the mother: momentum is sum of daughters TODO update covariance matrix.
 
bool updateOrcaKinFitDaughters (BaseFitter &fitter, Particle *mother)
 Update the daughters: momentum is sum of daughters TODO update covariance matrix.
 
void updateMapOfTrackAndDaughter (unsigned &l, std::vector< std::vector< unsigned > > &pars, std::vector< unsigned > &pard, std::vector< Particle * > &allparticles, const Particle *daughter)
 update the map of daughter and tracks, find out which tracks belong to each daughter.
 
bool storeOrcaKinFitParticles (const std::string &prefix, BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
 store fit object information as ExtraInfo
 
CLHEP::HepSymMatrix getCLHEPMomentumErrorMatrix (Particle *particle)
 Returns particle's 4x4 momentum-error matrix as a HepSymMatrix.
 
CLHEP::HepSymMatrix getCLHEPMomentumVertexErrorMatrix (Particle *particle)
 Returns particle's 7x7 momentum-vertex-error matrix as a HepSymMatrix.
 
CLHEP::HepLorentzVector getCLHEPLorentzVector (Particle *particle)
 Returns particle's 4-momentum as a HepLorentzVector.
 
ROOT::Math::PxPyPzEVector getLorentzVector (ParticleFitObject *fitobject)
 
float getFitObjectError (ParticleFitObject *fitobject, int ilocal)
 Returns fit object error on the parameter ilocal.
 
TMatrixFSym getFitObjectCovMat (ParticleFitObject *fitobject)
 Returns covariance matrix.
 
TMatrixFSym getCovMat7 (ParticleFitObject *fitobject)
 Returns covariance matrix.
 
TMatrixFSym getTMatrixFSymMomentumErrorMatrix ()
 Returns particle's 7x7 momentum-error matrix as a TMatrixFSym.
 
TMatrixFSym getTMatrixFSymMomentumVertexErrorMatrix ()
 Returns particle's 7x7 momentum-vertex-error matrix as a TMatrixFSym.
 
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.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

std::string m_listName
 particle list name
 
std::string m_kinematicFitter
 Kinematic Fitter name.
 
std::string m_orcaFitterEngine
 Orca Fitter Engine name.
 
std::string m_orcaTracer
 Tracer (None, Text or ROOT)
 
std::string m_orcaConstraint
 Constraint (softBeam, hardBeam (default))
 
bool m_debugFitter
 activate internal debugging (for New and Newton fitter only)
 
int m_debugFitterLevel
 internal debugging level (for New and Newton fitter only)
 
bool m_addUnmeasuredPhoton
 add one unmeasured photon to the fit (costs 3 constraints)
 
bool m_fixUnmeasuredPhotonToHER
 fix the momentum of the unmeasured photon to HER
 
bool m_fixUnmeasuredPhotonToLER
 fix the momentum of the unmeasured photon to LER
 
bool m_add3CPhoton
 add one photon with unmeasured energy to the fit (costs 1 constraints)
 
bool m_liftPhotonTheta
 lift theta constraint of the 3CPhoton.
 
bool m_updateMother
 update mother kinematics
 
bool m_updateDaughters
 update daughter kinematics
 
double m_recoilMass
 Recoil mass for RecoilMass constraint.
 
double m_invMass
 Invariant mass for Mass constraint.
 
TextTracerm_textTracer
 internal text output variable
 
StoreObjPtr< EventExtraInfom_eventextrainfo
 StoreObjPtr for the EventExtraInfo in this mode.
 
std::vector< double > m_unmeasuredLeptonFitObject
 unmeasured fit object
 
std::vector< double > m_unmeasuredGammaFitObject
 unmeasured fit object
 
StoreObjPtr< ParticleListm_plist
 StoreObjPtr for the particle list.
 
MomentumConstraint m_hardConstraintPx
 hard beam constraint px
 
MomentumConstraint m_hardConstraintPy
 hard beam constraint py
 
MomentumConstraint m_hardConstraintPz
 hard beam constraint pz
 
MomentumConstraint m_hardConstraintE
 hard beam constraint E
 
RecoilMassConstraint m_hardConstraintRecoilMass
 hard recoil mass constraint
 
MassConstraint m_hardConstraintMass
 hard mass constraint
 
std::string m_decayString
 daughter particles selection
 
DecayDescriptor m_decaydescriptor
 Decay descriptor of decays to look for.
 
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.
 

Detailed Description

Kinematic fitter module.

Definition at line 56 of file ParticleKinematicFitterModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ ParticleKinematicFitterModule()

Constructor.

Definition at line 51 of file ParticleKinematicFitterModule.cc.

51 : Module(), m_textTracer(nullptr), m_eventextrainfo("",
53{
54 setDescription("Kinematic fitter for modular analysis");
56
57 // Add parameters
58 addParam("listName", m_listName, "Name of particle list.", string(""));
59 addParam("kinematicFitter", m_kinematicFitter, "Available: OrcaKinFit.", string("OrcaKinFit"));
60 addParam("orcaFitterEngine", m_orcaFitterEngine, "OrcaKinFit engine: NewFitterGSL, NewtonFitterGSL, OPALFitterGSL.",
61 string("OPALFitterGSL"));
62 addParam("orcaTracer", m_orcaTracer, "OrcaKinFit tracer: None, Text.", string("None"));
63 addParam("orcaConstraint", m_orcaConstraint, "OrcaKinFit constraint: HardBeam, RecoilMass.", string("HardBeam"));
64 addParam("debugFitter", m_debugFitter, "Switch on/off internal debugging output if available.", false);
65 addParam("debugFitterLevel", m_debugFitterLevel, "Internal debugging output level if available.", 10);
66 addParam("addUnmeasuredPhoton", m_addUnmeasuredPhoton, "Add one unmeasured photon (-3C).", false);
67 addParam("fixUnmeasuredToHER", m_fixUnmeasuredPhotonToHER, "fix the momentum of the unmeasured photon to HER (+2C).", false);
68 addParam("fixUnmeasuredToLER", m_fixUnmeasuredPhotonToLER, "fix the momentum of the unmeasured photon to LER (+2C).", false);
69 addParam("add3CPhoton", m_add3CPhoton, "Add one photon with unmeasured energy (-1C).", false);
70 addParam("liftPhotonTheta", m_liftPhotonTheta, "Lift theta constraint of 3CPhoton. Valid when add3CPhoton is true.", false);
71 addParam("decayString", m_decayString, "Specifies which daughter particles are included in the kinematic fit.", string(""));
72 addParam("updateMother", m_updateMother, "Update the mother kinematics.", true);
73 addParam("updateDaughters", m_updateDaughters, "Update the daughter kinematics.", false);
74 addParam("recoilMass", m_recoilMass, "Recoil mass in GeV. RecoilMass constraint only.", 0.0);
75 addParam("invMass", m_invMass, "Invariant mass in GeV. Mass constraint only.", 0.0);
76
77}
@ c_Event
Different object in each event, all objects/arrays are invalidated after event() function has been ca...
Definition: DataStore.h:59
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Module()
Constructor.
Definition: Module.cc:30
bool m_liftPhotonTheta
lift theta constraint of the 3CPhoton.
std::string m_orcaConstraint
Constraint (softBeam, hardBeam (default))
int m_debugFitterLevel
internal debugging level (for New and Newton fitter only)
bool m_debugFitter
activate internal debugging (for New and Newton fitter only)
bool m_add3CPhoton
add one photon with unmeasured energy to the fit (costs 1 constraints)
StoreObjPtr< EventExtraInfo > m_eventextrainfo
StoreObjPtr for the EventExtraInfo in this mode.
double m_recoilMass
Recoil mass for RecoilMass constraint.
TextTracer * m_textTracer
internal text output variable
bool m_addUnmeasuredPhoton
add one unmeasured photon to the fit (costs 3 constraints)
double m_invMass
Invariant mass for Mass constraint.
bool m_fixUnmeasuredPhotonToHER
fix the momentum of the unmeasured photon to HER
bool m_fixUnmeasuredPhotonToLER
fix the momentum of the unmeasured photon to LER
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ addConstraintsToFitter()

void addConstraintsToFitter ( BaseFitter fitter)
private

Adds Orca fit object to the constraints.

Parameters
fitterreference to OrcaKinFit fitter object

Definition at line 532 of file ParticleKinematicFitterModule.cc.

533{
534 if (m_orcaConstraint == "HardBeam") {
535 fitter.addConstraint(m_hardConstraintPx);
536 fitter.addConstraint(m_hardConstraintPy);
537 fitter.addConstraint(m_hardConstraintPz);
538 fitter.addConstraint(m_hardConstraintE);
539 } else if (m_orcaConstraint == "RecoilMass") {
540 fitter.addConstraint(m_hardConstraintRecoilMass);
541 } else if (m_orcaConstraint == "Mass") {
542 fitter.addConstraint(m_hardConstraintMass);
543 }
544
545 else {
546 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
547 }
548}
MomentumConstraint m_hardConstraintE
hard beam constraint E
MomentumConstraint m_hardConstraintPz
hard beam constraint pz
RecoilMassConstraint m_hardConstraintRecoilMass
hard recoil mass constraint
MomentumConstraint m_hardConstraintPy
hard beam constraint py
MomentumConstraint m_hardConstraintPx
hard beam constraint px

◆ addFitObjectToConstraints()

void addFitObjectToConstraints ( ParticleFitObject fitobject)
private

Adds Orca fit object to the constraints.

Parameters
fitobjectreference to OrcaKinFit fit object

Definition at line 516 of file ParticleKinematicFitterModule.cc.

517{
518 if (m_orcaConstraint == "HardBeam") {
523 } else if (m_orcaConstraint == "RecoilMass") {
525 } else if (m_orcaConstraint == "Mass") {
527 } else {
528 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
529 }
530}
virtual void addToFOList(ParticleFitObject &fitobject, int flag=1)
Adds one ParticleFitObject objects to the list.

◆ AddFour()

bool AddFour ( Particle mother)
private

Added four vectors and calculated a covariance matrix for a combined particles.

Parameters
motherpointer to particle

Definition at line 298 of file ParticleKinematicFitterModule.cc.

299{
300 TMatrixFSym MomentumVertexErrorMatrix(7);
301 for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
302 auto* child = const_cast<Particle*>(mother->getDaughter(ichild));
303
304 if (child->getPValue() > 0) {
305 MomentumVertexErrorMatrix += child->getMomentumVertexErrorMatrix();
306 } else if (child->getNDaughters() > 0) {
307 AddFour(child);
308 MomentumVertexErrorMatrix += child->getMomentumVertexErrorMatrix();
309 } else {
310 B2ERROR("Daughter with PDG code " << child->getPDGCode() << " does not have a valid p-value: p=" << child->getPValue() << ", E=" <<
311 child->getEnergy() << " GeV");
312 return false; // error matrix not valid
313 }
314 }
315 mother->setMomentumVertexErrorMatrix(MomentumVertexErrorMatrix);
316 return true;
317}
bool AddFour(Particle *mother)
Added four vectors and calculated a covariance matrix for a combined particles.
Class to store reconstructed particles.
Definition: Particle.h:75
unsigned getNDaughters(void) const
Returns number of daughter particles.
Definition: Particle.h:727
void setMomentumVertexErrorMatrix(const TMatrixFSym &errMatrix)
Sets 7x7 error matrix.
Definition: Particle.cc:393
TMatrixFSym getMomentumVertexErrorMatrix() const
Returns 7x7 error matrix.
Definition: Particle.cc:420
const Particle * getDaughter(unsigned i) const
Returns a pointer to the i-th daughter particle.
Definition: Particle.cc:631

◆ addParticleToOrcaKinFit()

void addParticleToOrcaKinFit ( BaseFitter fitter,
Particle particle,
const int  index 
)
private

Adds given particle to the OrcaKinFit.

Parameters
fitterreference to OrcaKinFit fitter object
particlepointer to particle
indexused to name particles: particle_index

Definition at line 319 of file ParticleKinematicFitterModule.cc.

320{
321 B2DEBUG(17, "ParticleKinematicFitterModule: adding a particle to the fitter!");
322
323 if (m_add3CPhoton && index == 0) {
324 if (particle -> getPDGCode() != Const::photon.getPDGCode()) {
325 B2ERROR("In 3C Kinematic fit, the first daughter should be the Unmeasured Photon!");
326 }
327
328 const ECLCluster* cluster = particle->getECLCluster();
329 double startingE = cluster->getEnergy(particle->getECLClusterEHypothesisBit());
330 double startingPhi = cluster->getPhi();
331 double startingTheta = cluster->getTheta();
332
333 ClusterUtils clutls;
334 const auto EPhiThetaCov = clutls.GetCovarianceMatrix3x3FromCluster(cluster);
335 double startingeE = sqrt(fabs(EPhiThetaCov[0][0]));
336 double startingePhi = sqrt(fabs(EPhiThetaCov[1][1]));
337 double startingeTheta = sqrt(fabs(EPhiThetaCov[2][2]));
338
339 B2DEBUG(17, startingPhi << " " << startingTheta << " " << startingePhi << " " << startingeTheta);
340 // create a fit object
341 ParticleFitObject* pfitobject;
342 // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
343 pfitobject = new JetFitObject(startingE, startingTheta, startingPhi, startingeE, startingeTheta, startingePhi, 0.);
344 pfitobject->setParam(0, startingE, false, false);
346 pfitobject->setParam(1, startingTheta, false, false);
347 else
348 pfitobject->setParam(1, startingTheta, true, false);
349 pfitobject->setParam(2, startingPhi, true, false);
350
351 std::string fitObjectName = "Unmeasured3C";
352 pfitobject->setName(fitObjectName.c_str());
353 ParticleFitObject& fitobject = *pfitobject;
354
355 // add this fit object (=particle) to the constraints
356 addFitObjectToConstraints(fitobject);
357
358 // add fit particle to the fitter
359 fitter.addFitObject(fitobject);
360
361 } else {
362 // four vector
363 CLHEP::HepLorentzVector clheplorentzvector = getCLHEPLorentzVector(particle);
364
365 // error matrix
366 CLHEP::HepSymMatrix clhepmomentumerrormatrix = getCLHEPMomentumErrorMatrix(particle);
367
368 // create the fit object (ParticleFitObject is the base class)
369 ParticleFitObject* pfitobject;
370 // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
371 pfitobject = new PxPyPzMFitObject(clheplorentzvector, clhepmomentumerrormatrix);
372 std::string fitObjectName = "particle_" + SSTR(index);
373 pfitobject->setName(fitObjectName.c_str());
374 ParticleFitObject& fitobject = *pfitobject;
375
376 // add this fit object (=particle) to the constraints
377 addFitObjectToConstraints(fitobject);
378
379 // add fit particle to the fitter
380 fitter.addFitObject(fitobject);
381 }
382
383 return;
384}
Class to provide momentum-related information from ECLClusters.
Definition: ClusterUtils.h:36
const TMatrixDSym GetCovarianceMatrix3x3FromCluster(const ECLCluster *cluster)
Returns 3x3 covariance matrix (E, theta, phi)
static const ParticleType photon
photon particle
Definition: Const.h:673
ECL cluster data.
Definition: ECLCluster.h:27
virtual bool setParam(int ilocal, double par_, bool measured_, bool fixed_=false)
Set value and measured flag of parameter i; return: significant change.
void setName(const char *name_)
Set object's name.
Class for jets with (E, eta, phi) in kinematic fits.
Definition: JetFitObject.h:43
void addFitObjectToConstraints(ParticleFitObject &fitobject)
Adds Orca fit object to the constraints.
CLHEP::HepLorentzVector getCLHEPLorentzVector(Particle *particle)
Returns particle's 4-momentum as a HepLorentzVector.
CLHEP::HepSymMatrix getCLHEPMomentumErrorMatrix(Particle *particle)
Returns particle's 4x4 momentum-error matrix as a HepSymMatrix.
const ECLCluster * getECLCluster() const
Returns the pointer to the ECLCluster object that was used to create this Particle (if ParticleType =...
Definition: Particle.cc:891
ECLCluster::EHypothesisBit getECLClusterEHypothesisBit() const
Returns the ECLCluster EHypothesisBit for this Particle.
Definition: Particle.h:1001

◆ addTracerToFitter()

void addTracerToFitter ( BaseFitter fitter)
private

Adds tracer to the fitter.

Parameters
fitterreference to OrcaKinFit fitter object

Definition at line 550 of file ParticleKinematicFitterModule.cc.

551{
552 if (m_orcaTracer == "Text") {
553 m_textTracer = new TextTracer(std::cout);
554 fitter.setTracer(m_textTracer);
555 } else if (m_orcaTracer != "None") {
556 B2FATAL("ParticleKinematicFitterModule: " << m_orcaTracer << " is an invalid OrcaKinFit tracer!");
557 }
558}

◆ addUnmeasuredGammaToOrcaKinFit()

void addUnmeasuredGammaToOrcaKinFit ( BaseFitter fitter)
private

Adds an unmeasured gamma (E, phi, theta) to the fit (-3C) stored as EventExtraInfo TODO.

Parameters
fitterreference to OrcaKinFit fitter object

Definition at line 560 of file ParticleKinematicFitterModule.cc.

561{
562 B2DEBUG(17, "ParticleKinematicFitterModule::addUnmeasuredGammaToOrcaKinFit: adding an unmeasured photon to the fitter!");
563 // Initialize photon using the existing constraints
564 ROOT::Math::PxPyPzEVector tlv = getLorentzVectorConstraints();
565 double startingE = tlv.E();
566 double startingPhi = tlv.Phi();
567 double startingTheta = tlv.Theta();
568 bool paramFlag = false;
569
570 // create a fit object
571 ParticleFitObject* pfitobject;
572
573 std::string fitObjectName = "UnmeasuredAlongBeam";
574
576 startingTheta = 41.5e-3; // TODO: Read beam crossing angle from db if it's available
577 startingPhi = 0.0;
578 paramFlag = true;
579 } else if (m_fixUnmeasuredPhotonToLER) {
580 startingTheta = TMath::Pi() - 41.5e-3;
581 startingPhi = 0.0;
582 paramFlag = true;
583 } else {
584 fitObjectName = "Unmeasured";
585 }
586
587 // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
588 pfitobject = new JetFitObject(startingE, startingTheta, startingPhi, 0.0, 0.0, 0.0, 0.);
589 pfitobject->setParam(0, startingE, false, false);
590 pfitobject->setParam(1, startingTheta, paramFlag, paramFlag);
591 pfitobject->setParam(2, startingPhi, paramFlag, paramFlag);
592
593 pfitobject->setName(fitObjectName.c_str());
594 ParticleFitObject& fitobject = *pfitobject;
595
596 // add this fit object (=particle) to the constraints
597 addFitObjectToConstraints(fitobject);
598
599 // add fit particle to the fitter
600 fitter.addFitObject(fitobject);
601}
ROOT::Math::PxPyPzEVector getLorentzVectorConstraints()
Get constraints (at whatever stage before/after fitting)

◆ beginRun()

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

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ doKinematicFit()

bool doKinematicFit ( Particle p)
private

Main steering routine for any kinematic fitter.

Parameters
ppointer to particle
Returns
true for successful fit

Definition at line 116 of file ParticleKinematicFitterModule.cc.

117{
118 B2DEBUG(17, "ParticleKinematicFitterModule::doKinematicFit");
119
120 bool ok = false;
121
122 // fitting with OrcaKinFit
123 if (m_kinematicFitter == "OrcaKinFit") {
124
125 // select subset of particles for the fit
126 if (m_decayString != "") {
127 B2FATAL("ParticleKinematicFitterModule: OrcaKinFit does not support yet selection of daughters via decay string!") ;
128 }
129
130 // check requested fit engine
131 if (!(m_orcaFitterEngine == "OPALFitterGSL" or
132 m_orcaFitterEngine == "NewtonFitterGSL" or
133 m_orcaFitterEngine == "NewFitterGSL")) {
134 B2FATAL("ParticleKinematicFitterModule: " << m_orcaFitterEngine << " is an invalid OrcaKinFit fitter engine!");
135 }
136
137 // check requested constraint
138 if (!(m_orcaConstraint == "HardBeam" or
139 m_orcaConstraint == "RecoilMass" or
140 m_orcaConstraint == "Mass")) {
141 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
142 }
143
144 // basic check is good, go to fitting routine
145 ok = doOrcaKinFitFit(mother);
146 } else { // invalid fitter
147 B2FATAL("ParticleKinematicFitter: " << m_kinematicFitter << " is an invalid kinematic fitter!");
148 }
149
150 if (!ok) return false;
151
152 return true;
153
154}
bool doOrcaKinFitFit(Particle *p)
Kinematic fit using OrcaKinFit.

◆ doOrcaKinFitFit()

bool doOrcaKinFitFit ( Particle p)
private

Kinematic fit using OrcaKinFit.

Parameters
ppointer to particle
Returns
true for successful fit

Definition at line 156 of file ParticleKinematicFitterModule.cc.

157{
158 if (mother->getNDaughters() <= 1) {
159 B2WARNING("ParticleKinematicFitterModule: Cannot fit with " << mother->getNDaughters() << " daughters.");
160 return false;
161 }
162
163 // fill particles
164 std::vector<Particle*> particleChildren;
165 bool validChildren = fillFitParticles(mother, particleChildren);
166
167 if (!validChildren) {
168 B2WARNING("ParticleKinematicFitterModule: Cannot find valid children for the fit.");
169 return false;
170 }
171
172 // set fit engine
173 BaseFitter* pfitter;
174
175 // internal debugger
176 int debugfitter = 0;
177 if (m_debugFitter) debugfitter = m_debugFitterLevel;
178
179 // choose minimization
180 if (m_orcaFitterEngine == "OPALFitterGSL") {
181 pfitter = new OPALFitterGSL(); // OPAL fitter has no debugger
182 } else if (m_orcaFitterEngine == "NewtonFitterGSL") {
183 pfitter = new NewtonFitterGSL();
184 (dynamic_cast<NewtonFitterGSL*>(pfitter))->setDebug(debugfitter);
185 } else if (m_orcaFitterEngine == "NewFitterGSL") {
186 pfitter = new NewFitterGSL();
187 (dynamic_cast<NewFitterGSL*>(pfitter))->setDebug(debugfitter);
188 } else {
189 B2FATAL("ParticleKinematicFitterModule: " << m_orcaFitterEngine << " is an invalid OrcaKinFit fitter engine!");
190 return false;
191 }
192
193 if (!pfitter) return false;
194 BaseFitter& fitter(*pfitter);
195
196 // reset fitter
197 resetFitter(fitter);
198
199 // set constraints (not connected to a fitter or particles at this point!)
201
202 // add fit particles from particle list to the fitter and to all constraints
203 for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
204 addParticleToOrcaKinFit(fitter, particleChildren[iChild], iChild);
205 }
206
207 // add unmeasured photon to the fitter and to all constraints
209
210 // add constraints to the fitter
212
213 // add tracers to the fitter
214 addTracerToFitter(fitter);
215
216 //store information before the fit
217 storeOrcaKinFitParticles("Measured", fitter, particleChildren, mother);
218
219 double prob = fitter.fit();
220 double chi2 = fitter.getChi2();
221 int niter = fitter.getIterations();
222 int ndof = fitter.getDoF();
223 int errorcode = fitter.getError();
224
225 B2DEBUG(17, "ParticleKinematicFitterModule: -------------------------------------------");
226 B2DEBUG(17, "ParticleKinematicFitterModule: Fit result of OrcaKinFit using " << m_orcaFitterEngine);
227 B2DEBUG(17, "ParticleKinematicFitterModule: prob " << prob);
228 B2DEBUG(17, "ParticleKinematicFitterModule: chi2 " << chi2);
229 B2DEBUG(17, "ParticleKinematicFitterModule: iterations " << niter);
230 B2DEBUG(17, "ParticleKinematicFitterModule: ndf " << ndof);
231 B2DEBUG(17, "ParticleKinematicFitterModule: errorcode " << errorcode);
232 B2DEBUG(17, "ParticleKinematicFitterModule: -------------------------------------------");
233
234 // default update mother information
235 if (m_updateMother) updateOrcaKinFitMother(fitter, particleChildren, mother);
236
237 // update daughter information if that is requested
238 if (m_updateDaughters) updateOrcaKinFitDaughters(fitter, mother);
239
240 // store information after the fit
241 storeOrcaKinFitParticles("Fitted", fitter, particleChildren, mother);
242
243 //store general fit results
244 mother->addExtraInfo("OrcaKinFitProb", prob);
245 mother->setPValue(prob);
246 mother->addExtraInfo("OrcaKinFitChi2", chi2);
247 mother->addExtraInfo("OrcaKinFitErrorCode", errorcode);
248
249 // if we added an unmeasured photon, add the kinematics to the mother - at some point we may want to create a particle list from this?
250 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
251 for (auto fo : *fitObjectContainer) {
253 const std::string name = fo->getName();
254 if (name.find("Unmeasured") != std::string::npos) {
255 auto* fitobject = static_cast<ParticleFitObject*>(fo);
256 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
257 mother->addExtraInfo("OrcaKinFit" + name + "Theta", tlv.Theta());
258 mother->addExtraInfo("OrcaKinFit" + name + "Phi", tlv.Phi());
259 mother->addExtraInfo("OrcaKinFit" + name + "E", tlv.E());
260
261 // Uncertainty
262 // const double err0 = getFitObjectError(fitobject, 0);
263 mother->addExtraInfo("OrcaKinFit" + name + "ErrorTheta", getFitObjectError(fitobject, 1));
264 mother->addExtraInfo("OrcaKinFit" + name + "ErrorPhi", getFitObjectError(fitobject, 2));
265 mother->addExtraInfo("OrcaKinFit" + name + "ErrorE", getFitObjectError(fitobject, 0));
266 }
267 }
268 delete fo;
269 }
270
271 delete pfitter;
272 delete m_textTracer;
273 return true;
274}
Abstract base class for fitting engines of kinematic fits.
Definition: BaseFitter.h:47
A kinematic fitter using the Newton-Raphson method to solve the equations.
Definition: NewFitterGSL.h:51
Description of the fit algorithm and interface:
Definition: OPALFitterGSL.h:88
bool fillFitParticles(Particle *mother, std::vector< Particle * > &particleChildren)
Fills valid particle's children (with valid error matrix) in the vector of Particles that will enter ...
void addUnmeasuredGammaToOrcaKinFit(BaseFitter &fitter)
Adds an unmeasured gamma (E, phi, theta) to the fit (-3C) stored as EventExtraInfo TODO.
float getFitObjectError(ParticleFitObject *fitobject, int ilocal)
Returns fit object error on the parameter ilocal.
void addConstraintsToFitter(BaseFitter &fitter)
Adds Orca fit object to the constraints.
void addTracerToFitter(BaseFitter &fitter)
Adds tracer to the fitter.
ROOT::Math::PxPyPzEVector getLorentzVector(ParticleFitObject *fitobject)
bool updateOrcaKinFitDaughters(BaseFitter &fitter, Particle *mother)
Update the daughters: momentum is sum of daughters TODO update covariance matrix.
void setConstraints()
Sets constraints, this is not connect to particles or a fitter at this stage.
void addParticleToOrcaKinFit(BaseFitter &fitter, Particle *particle, const int index)
Adds given particle to the OrcaKinFit.
void updateOrcaKinFitMother(BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
Update the mother: momentum is sum of daughters TODO update covariance matrix.
void resetFitter(BaseFitter &fitter)
Resets all objects associated with the OrcaKinFit fitter.
bool storeOrcaKinFitParticles(const std::string &prefix, BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
store fit object information as ExtraInfo

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

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

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( )
overridevirtual

Event processor.

Reimplemented from Module.

Definition at line 96 of file ParticleKinematicFitterModule.cc.

97{
98 B2DEBUG(17, "ParticleKinematicFitterModule::event");
99
100 unsigned int n = m_plist->getListSize();
101
102 for (unsigned i = 0; i < n; i++) {
103 Particle* particle = m_plist->getParticle(i);
104
105 if (m_updateDaughters == true) {
106 if (m_decayString.empty()) ParticleCopy::copyDaughters(particle);
107 else B2ERROR("Daughters update works only when all daughters are selected. Daughters will not be updated");
108 }
109
110 bool ok = doKinematicFit(particle);
111
112 if (!ok) particle->setPValue(-1.);
113 }
114}
StoreObjPtr< ParticleList > m_plist
StoreObjPtr for the particle list.
bool doKinematicFit(Particle *p)
Main steering routine for any kinematic fitter.
void setPValue(double pValue)
Sets chi^2 probability of fit.
Definition: Particle.h:366
void copyDaughters(Particle *mother)
Function copies all (grand-)^n-daughter particles of the argument mother Particle.
Definition: ParticleCopy.cc:56

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ fillFitParticles()

bool fillFitParticles ( Particle mother,
std::vector< Particle * > &  particleChildren 
)
private

Fills valid particle's children (with valid error matrix) in the vector of Particles that will enter the fit.

Definition at line 276 of file ParticleKinematicFitterModule.cc.

277{
278 for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
279 auto* child = const_cast<Particle*>(mother->getDaughter(ichild));
280
281 if (child->getNDaughters() > 0) {
282 bool err = fillFitParticles(child, particleChildren);
283 if (!err) {
284 B2WARNING("ParticleKinematicFitterModule: Cannot find valid children for the fit.");
285 return false;
286 }
287 } else if (child->getPValue() > 0) {
288 particleChildren.push_back(child);
289 } else {
290 B2ERROR("Daughter with PDG code " << child->getPDGCode() << " does not have a valid p-value: p=" << child->getPValue() << ", E=" <<
291 child->getEnergy() << " GeV");
292 return false; // error matrix not valid
293 }
294 }
295 return true;
296}

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

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

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

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCLHEPLorentzVector()

CLHEP::HepLorentzVector getCLHEPLorentzVector ( Particle particle)
private

Returns particle's 4-momentum as a HepLorentzVector.

Parameters
particlepointer to particle

Definition at line 414 of file ParticleKinematicFitterModule.cc.

415{
416 CLHEP::HepLorentzVector mom(particle->getPx(), particle->getPy(), particle->getPz(), particle->get4Vector().E());
417 return mom;
418}
double getPx() const
Returns x component of momentum.
Definition: Particle.h:587
double getPz() const
Returns z component of momentum.
Definition: Particle.h:605
double getPy() const
Returns y component of momentum.
Definition: Particle.h:596
ROOT::Math::PxPyPzEVector get4Vector() const
Returns Lorentz vector.
Definition: Particle.h:547

◆ getCLHEPMomentumErrorMatrix()

CLHEP::HepSymMatrix getCLHEPMomentumErrorMatrix ( Particle particle)
private

Returns particle's 4x4 momentum-error matrix as a HepSymMatrix.

Parameters
particlepointer to particle

Definition at line 386 of file ParticleKinematicFitterModule.cc.

387{
388 CLHEP::HepSymMatrix covMatrix(4);
389 TMatrixFSym errMatrix = particle->getMomentumErrorMatrix();
390
391 for (int i = 0; i < 4; i++) {
392 for (int j = 0; j < 4; j++) {
393 covMatrix[i][j] = errMatrix[i][j];
394 }
395 }
396
397 return covMatrix;
398}
TMatrixFSym getMomentumErrorMatrix() const
Returns the 4x4 momentum error matrix.
Definition: Particle.cc:435

◆ getCLHEPMomentumVertexErrorMatrix()

CLHEP::HepSymMatrix getCLHEPMomentumVertexErrorMatrix ( Particle particle)
private

Returns particle's 7x7 momentum-vertex-error matrix as a HepSymMatrix.

Parameters
particlepointer to particle

Definition at line 400 of file ParticleKinematicFitterModule.cc.

401{
402 CLHEP::HepSymMatrix covMatrix(7);
403 TMatrixFSym errMatrix = particle->getMomentumVertexErrorMatrix();
404
405 for (int i = 0; i < 7; i++) {
406 for (int j = 0; j < 7; j++) {
407 covMatrix[i][j] = errMatrix[i][j];
408 }
409 }
410
411 return covMatrix;
412}

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

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

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

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ getCovMat7()

TMatrixFSym getCovMat7 ( ParticleFitObject fitobject)
private

Returns covariance matrix.

Parameters
fitobjectreference to OrcaKinFit fit object

Definition at line 785 of file ParticleKinematicFitterModule.cc.

786{
787 TMatrixFSym fitCovMatrix(3);
788
789 if (strcmp(fitobject->getParamName(0), "E") == 0) {
790 //check if it is a JetFitObject
791 auto* jetfitObject = static_cast<JetFitObject*>(fitobject);
792 if (jetfitObject) {
793
794 fitCovMatrix = getFitObjectCovMat(fitobject);
795 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
796
797 const double energy = tlv.E();
798 const double theta = tlv.Theta();
799 const double phi = tlv.Phi();
800
801 const double st = sin(theta);
802 const double ct = cos(theta);
803 const double sp = sin(phi);
804 const double cp = cos(phi);
805
806 // updated covariance matrix is: A * cov * A^T where A is the Jacobi matrix (use Similarity)
807 TMatrixF A(7, 3);
808 A(0, 0) = cp * st ; // dpx/dE
809 A(0, 1) = energy * cp * ct ; // dpx/dtheta
810 A(0, 2) = -energy * sp * st ; // dpx/dphi
811 A(1, 0) = sp * st ; // dpy/dE
812 A(1, 1) = energy * sp * ct ; // dpz/dtheta
813 A(1, 2) = energy * cp * st ; // dpy/dphi
814 A(2, 0) = ct ; // dpz/dE
815 A(2, 1) = -energy * st ; // dpz/dtheta
816 A(2, 2) = 0 ; // dpz/dphi
817 A(3, 0) = 1.0; // dE/dE
818 A(3, 1) = 0.0; // dE/dphi
819 A(3, 2) = 0.0; // dE/dtheta
820
821 TMatrixFSym D = fitCovMatrix.Similarity(A);
822 return D;
823
824 } else {
825 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
826 }
827 } else {
828 //check if it is a PxPyPzMFitObject
829 auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
830 if (pxpypzmfitobject) {
831
832 fitCovMatrix = getFitObjectCovMat(fitobject);
833
834 // updated covariance matrix is: A * cov * A^T where A is the Jacobi matrix (use Similarity)
835 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
836 TMatrixF A(7, 3);
837 A[0][0] = 1.; // px/dpx
838 A[0][1] = 0.; // px/dpy
839 A[0][2] = 0.; // px/dpz
840 A[1][0] = 0.; // py/dpx
841 A[1][1] = 1.; // py/dpy
842 A[1][2] = 0.; // py/dpz
843 A[2][0] = 0.; // pz/dpx
844 A[2][1] = 0.; // pz/dpy
845 A[2][2] = 1.; // pz/dpz
846 if (tlv.E() > 0.0) {
847 A[3][0] = tlv.Px() / tlv.E(); // E/dpx, E=sqrt(px^2 + py^2 + pz^2 + m^2)
848 A[3][1] = tlv.Py() / tlv.E(); // E/dpy
849 A[3][2] = tlv.Pz() / tlv.E(); // E/dpz
850 }
851
852 TMatrixFSym D = fitCovMatrix.Similarity(A);
853
854 return D;
855 } else {
856 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
857 }
858 }
859}
virtual const char * getParamName(int ilocal) const =0
Get name of parameter ilocal.
TMatrixFSym getFitObjectCovMat(ParticleFitObject *fitobject)
Returns covariance matrix.

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
std::string m_description
The description of the module.
Definition: Module.h:511

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

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

◆ getFitObjectCovMat()

TMatrixFSym getFitObjectCovMat ( ParticleFitObject fitobject)
private

Returns covariance matrix.

Parameters
fitobjectreference to OrcaKinFit fit object

Definition at line 763 of file ParticleKinematicFitterModule.cc.

764{
765
766 //check if it is a PxPyPzMFitObject
767 auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
768 if (pxpypzmfitobject) {
769
770 TMatrixFSym errMatrix(3);
771
772 //loop over the i-j local variables.
773 for (int i = 0; i < 3; i++) {
774 for (int j = 0; j < 3; j++) {
775 errMatrix[i][j] = pxpypzmfitobject->getCov(i, j);
776 }
777 }
778
779 return errMatrix;
780 } else {
781 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
782 }
783}

◆ getFitObjectError()

float getFitObjectError ( ParticleFitObject fitobject,
int  ilocal 
)
private

Returns fit object error on the parameter ilocal.

Parameters
fitobjectreference to OrcaKinFit fit object
ilocalinternal local ID

Definition at line 751 of file ParticleKinematicFitterModule.cc.

752{
753 //check if it is a PxPyPzMFitObject
754 auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
755 if (pxpypzmfitobject) {
756 return fitobject->getError(ilocal);
757 } else {
758 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
759 }
760}
virtual double getError(int ilocal) const
Get error of parameter ilocal.

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getLorentzVector()

ROOT::Math::PxPyPzEVector getLorentzVector ( ParticleFitObject fitobject)
private
Parameters
fitobjectreference to OrcaKinFit fit object Returns particle's 4-momentum as a PxPyPzEVector

Definition at line 420 of file ParticleKinematicFitterModule.cc.

421{
422 ROOT::Math::PxPyPzEVector mom(fitobject->getPx(), fitobject->getPy(), fitobject->getPz(), fitobject->getE());
423 return mom;
424}
virtual double getPx() const
Return px.
virtual double getPz() const
Return pz.
virtual double getPy() const
Return py.
virtual double getE() const
Return E.

◆ getLorentzVectorConstraints()

ROOT::Math::PxPyPzEVector getLorentzVectorConstraints ( )
private

Get constraints (at whatever stage before/after fitting)

Definition at line 454 of file ParticleKinematicFitterModule.cc.

455{
456 if (m_orcaConstraint == "HardBeam") {
457 ROOT::Math::PxPyPzEVector constraints4vector(m_hardConstraintPx.getValue(),
461 return constraints4vector;
462 } else {
463 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
464 }
465
466 // should not reach this point...
467 return ROOT::Math::PxPyPzEVector(0., 0., 0., 0.);
468}
virtual double getValue() const override
Returns the value of the constraint.

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

Returns
A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getTMatrixFSymMomentumErrorMatrix()

TMatrixFSym getTMatrixFSymMomentumErrorMatrix ( )
private

Returns particle's 7x7 momentum-error matrix as a TMatrixFSym.

Definition at line 427 of file ParticleKinematicFitterModule.cc.

428{
429 TMatrixFSym errMatrix(4);
430
431 for (int i = 0; i < 4; i++) {
432 for (int j = i; j < 4; j++) {
433 errMatrix[i][j] = 0.0;
434 }
435 }
436
437 return errMatrix;
438}

◆ getTMatrixFSymMomentumVertexErrorMatrix()

TMatrixFSym getTMatrixFSymMomentumVertexErrorMatrix ( )
private

Returns particle's 7x7 momentum-vertex-error matrix as a TMatrixFSym.

Definition at line 441 of file ParticleKinematicFitterModule.cc.

442{
443 TMatrixFSym errMatrix(7);
444
445 for (int i = 0; i < 7; i++) {
446 for (int j = i; j < 7; j++) {
447 errMatrix[i][j] = 0.0;
448 }
449 }
450
451 return errMatrix;
452}

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

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

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

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

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

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

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

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

◆ initialize()

void initialize ( )
overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 79 of file ParticleKinematicFitterModule.cc.

80{
81 m_eventextrainfo.registerInDataStore();
82
83 if (m_decayString != "") {
85 B2INFO("ParticleKinematicFitter: Using specified decay string: " << m_decayString);
86 }
87
88 m_plist.isRequired(m_listName);
89}
bool init(const std::string &str)
Initialise the DecayDescriptor from given string.
DecayDescriptor m_decaydescriptor
Decay descriptor of decays to look for.

◆ resetFitter()

void resetFitter ( BaseFitter fitter)
private

Resets all objects associated with the OrcaKinFit fitter.

Parameters
fitterreference to OrcaKinFit fitter object

Definition at line 510 of file ParticleKinematicFitterModule.cc.

511{
512 B2DEBUG(17, "ParticleKinematicFitterModule: Resetting the fitter");
513 fitter.reset();
514}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setConstraints()

void setConstraints ( )
private

Sets constraints, this is not connect to particles or a fitter at this stage.

Definition at line 470 of file ParticleKinematicFitterModule.cc.

471{
472 if (m_orcaConstraint == "HardBeam") {
474 const ROOT::Math::PxPyPzEVector boost = T.getBeamFourMomentum();
475
476 m_hardConstraintPx = MomentumConstraint(0, 1, 0, 0, boost.Px());
477 m_hardConstraintPy = MomentumConstraint(0, 0, 1, 0, boost.Py());
478 m_hardConstraintPz = MomentumConstraint(0, 0, 0, 1, boost.Pz());
479 m_hardConstraintE = MomentumConstraint(1, 0, 0, 0, boost.E());
480
485
486 m_hardConstraintPx.setName("Sum(p_x) [hard]");
487 m_hardConstraintPy.setName("Sum(p_y) [hard]");
488 m_hardConstraintPz.setName("Sum(p_z) [hard]");
489 m_hardConstraintE.setName("Sum(E) [hard]");
490
491 } else if (m_orcaConstraint == "RecoilMass") {
493 const ROOT::Math::PxPyPzEVector boost = T.getBeamFourMomentum();
494
495 m_hardConstraintRecoilMass = RecoilMassConstraint(m_recoilMass, boost.Px(), boost.Py(), boost.Pz(), boost.E());
496
498 m_hardConstraintRecoilMass.setName("Recoil Mass [hard]");
499
500 } else if (m_orcaConstraint == "Mass") {
502
504 m_hardConstraintMass.setName("Mass [hard]");
505 } else {
506 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
507 }
508}
void setName(const char *name_)
Set object's name.
Implements constraint 0 = mass1 - mass2 - m.
Implements a constraint of the form efact*sum(E)+pxfact*sum(px)+pyfact*sum(py)+pzfact*sum(pz)=value.
virtual void resetFOList()
Resests ParticleFitObject list.
Class to hold Lorentz transformations from/to CMS and boost vector.
ROOT::Math::PxPyPzEVector getBeamFourMomentum() const
Returns LAB four-momentum of e+e-, i.e.

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

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

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

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

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

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

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

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

209{
210 m_propertyFlags = propertyFlags;
211}

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

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

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

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

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

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

◆ storeOrcaKinFitParticles()

bool storeOrcaKinFitParticles ( const std::string &  prefix,
BaseFitter fitter,
std::vector< Particle * > &  particleChildren,
Particle mother 
)
private

store fit object information as ExtraInfo

Parameters
prefixcan be used to distinguish e.g. "Fitted" and "Measured"
fitterreference to OrcaKinFit fitter object
particleChildrenlist of all particle children
mothermother particle

Definition at line 716 of file ParticleKinematicFitterModule.cc.

718{
719 bool updated = false;
720 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
721
722 for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
723 BaseFitObject* fo = fitObjectContainer->at(iChild);
724 auto* fitobject = static_cast<ParticleFitObject*>(fo);
725 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
726
727 // name of extra variables
728 std::string extraVariableParticlePx = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_Px";
729 std::string extraVariableParticlePy = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_Py";
730 std::string extraVariableParticlePz = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_Pz";
731 std::string extraVariableParticleE = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_E";
732 std::string extraVariableParticlePxErr = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_PxErr";
733 std::string extraVariableParticlePyErr = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_PyErr";
734 std::string extraVariableParticlePzErr = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_PzErr";
735 std::string extraVariableParticleEErr = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_EErr";
736
737 mother->addExtraInfo(extraVariableParticlePx, tlv.Px());
738 mother->addExtraInfo(extraVariableParticlePy, tlv.Py());
739 mother->addExtraInfo(extraVariableParticlePz, tlv.Pz());
740 mother->addExtraInfo(extraVariableParticleE, tlv.E());
741 mother->addExtraInfo(extraVariableParticlePxErr, getFitObjectError(fitobject, 0));
742 mother->addExtraInfo(extraVariableParticlePyErr, getFitObjectError(fitobject, 1));
743 mother->addExtraInfo(extraVariableParticlePzErr, getFitObjectError(fitobject, 2));
744 mother->addExtraInfo(extraVariableParticleEErr, -1.0);
745
746 }
747
748 return updated;
749}
void addExtraInfo(const std::string &name, double value)
Sets the user-defined data of given name to the given value.
Definition: Particle.cc:1336

◆ terminate()

void terminate ( )
overridevirtual

termination.

Reimplemented from Module.

Definition at line 91 of file ParticleKinematicFitterModule.cc.

92{
93 B2INFO("ParticleKinematicFitterModule::terminate");
94}

◆ updateMapOfTrackAndDaughter()

void updateMapOfTrackAndDaughter ( unsigned &  l,
std::vector< std::vector< unsigned > > &  pars,
std::vector< unsigned > &  pard,
std::vector< Particle * > &  allparticles,
const Particle daughter 
)
private

update the map of daughter and tracks, find out which tracks belong to each daughter.

Parameters
lrepresent the tracks ID
parsmap of all parameters
pardvector of parameters
allparticlesvector of all particles
daughterpointer to particle

Definition at line 669 of file ParticleKinematicFitterModule.cc.

671{
672 std::vector <Belle2::Particle*> dDau = daughter->getDaughters();
673 for (unsigned ichild = 0; ichild < daughter->getNDaughters(); ichild++) {
674 const Particle* child = daughter->getDaughter(ichild);
675 std::vector<unsigned> pard;
676 if (child->getNDaughters() > 0) {
677 updateMapOfTrackAndDaughter(l, pars, pard, allparticles, child);
678 parm.insert(parm.end(), pard.begin(), pard.end());
679 pars.push_back(pard);
680 allparticles.push_back(dDau[ichild]);
681 } else {
682 pard.push_back(l);
683 parm.push_back(l);
684 pars.push_back(pard);
685 allparticles.push_back(dDau[ichild]);
686 l++;
687 }
688 }
689}
void updateMapOfTrackAndDaughter(unsigned &l, std::vector< std::vector< unsigned > > &pars, std::vector< unsigned > &pard, std::vector< Particle * > &allparticles, const Particle *daughter)
update the map of daughter and tracks, find out which tracks belong to each daughter.

◆ updateOrcaKinFitDaughters()

bool updateOrcaKinFitDaughters ( BaseFitter fitter,
Particle mother 
)
private

Update the daughters: momentum is sum of daughters TODO update covariance matrix.

Parameters
fitterreference to OrcaKinFit fitter object
mothermother particle

Definition at line 603 of file ParticleKinematicFitterModule.cc.

604{
605 std::vector <Belle2::Particle*> bDau = mother->getDaughters();
606 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
607
608 const unsigned nd = bDau.size();
609 unsigned l = 0;
610 std::vector<std::vector<unsigned>> pars;
611 std::vector<Particle*> allparticles;
612 for (unsigned ichild = 0; ichild < nd; ichild++) {
613 const Particle* daughter = mother->getDaughter(ichild);
614 std::vector<unsigned> pard;
615 if (daughter->getNDaughters() > 0) {
616 updateMapOfTrackAndDaughter(l, pars, pard, allparticles, daughter);
617 pars.push_back(pard);
618 allparticles.push_back(bDau[ichild]);
619 } else {
620 pard.push_back(l);
621 pars.push_back(pard);
622 allparticles.push_back(bDau[ichild]);
623 l++;
624 }
625 }
626
627 if (l == fitObjectContainer->size() - m_addUnmeasuredPhoton) {
628
629 if (fitter.getError() == 0) {
630 for (unsigned iDaug = 0; iDaug < allparticles.size(); iDaug++) {
631 ROOT::Math::PxPyPzEVector tlv ;
632 TMatrixFSym errMatrixU(7);
633 if (pars[iDaug].size() > 0) {
634 for (unsigned int iChild : pars[iDaug]) {
635 BaseFitObject* fo = fitObjectContainer->at(iChild);
636 auto* fitobject = static_cast<ParticleFitObject*>(fo);
637 ROOT::Math::PxPyPzEVector tlv_sub = getLorentzVector(fitobject);
638 TMatrixFSym errMatrixU_sub = getCovMat7(fitobject);
639 tlv = tlv + tlv_sub;
640 errMatrixU = errMatrixU + errMatrixU_sub;
641 }
642 } else {
643 B2FATAL("ParticleKinematicFitterModule: no fitObject could be used to update the daughter!");
644 }
645 ROOT::Math::XYZVector pos = allparticles[iDaug]->getVertex(); // we don't update the vertex yet
646 TMatrixFSym errMatrix = allparticles[iDaug]->getMomentumVertexErrorMatrix();
647 TMatrixFSym errMatrixMom = allparticles[iDaug]->getMomentumErrorMatrix();
648 TMatrixFSym errMatrixVer = allparticles[iDaug]->getVertexErrorMatrix();
649
650 for (int i = 0; i < 3; i++) {
651 for (int j = i; j < 3; j++) {
652 errMatrixU[i + 4][j + 4] = errMatrixVer[i][j];
653 }
654 }
655
656 allparticles[iDaug]->set4Vector(tlv);
657 allparticles[iDaug]->setVertex(pos);
658 allparticles[iDaug]->setMomentumVertexErrorMatrix(errMatrixU);
659 }
660 }
661
662 return true;
663 } else {
664 B2ERROR("updateOrcaKinFitDaughters: Cannot update daughters, mismatch between number of daughters and number of fitobjects!");
665 return false;
666 }
667}
TMatrixFSym getCovMat7(ParticleFitObject *fitobject)
Returns covariance matrix.
std::vector< Belle2::Particle * > getDaughters() const
Returns a vector of pointers to daughter particles.
Definition: Particle.cc:637

◆ updateOrcaKinFitMother()

void updateOrcaKinFitMother ( BaseFitter fitter,
std::vector< Particle * > &  particleChildren,
Particle mother 
)
private

Update the mother: momentum is sum of daughters TODO update covariance matrix.

Parameters
fitterreference to OrcaKinFit fitter object
particleChildrenlist of daughter particles
mothermother particle

Definition at line 691 of file ParticleKinematicFitterModule.cc.

693{
694 // get old values
695 ROOT::Math::XYZVector pos = mother->getVertex();
696 TMatrixFSym errMatrix = mother->getMomentumVertexErrorMatrix();
697 float pvalue = mother->getPValue();
698
699 // update momentum vector
700 ROOT::Math::PxPyPzEVector momnew(0., 0., 0., 0.);
701
702 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
703 for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
704 BaseFitObject* fo = fitObjectContainer->at(iChild);
705 auto* fitobject = static_cast<ParticleFitObject*>(fo);
706 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
707 momnew += tlv;
708 }
709
710 // update
711 // TODO: use pvalue of the fit or the old one of the mother? use fit covariance matrix?
712 // Maybe here should use the pvalue and errmatrix of the fit ----Yu Hu
713 mother->updateMomentum(momnew, pos, errMatrix, pvalue);
714}
double getPValue() const
Returns chi^2 probability of fit if done or -1.
Definition: Particle.h:667
ROOT::Math::XYZVector getVertex() const
Returns vertex position (POCA for charged, IP for neutral FS particles)
Definition: Particle.h:631
void updateMomentum(const ROOT::Math::PxPyPzEVector &p4, const ROOT::Math::XYZVector &vertex, const TMatrixFSym &errMatrix, double pValue)
Sets Lorentz vector, position, 7x7 error matrix and p-value.
Definition: Particle.h:386

Member Data Documentation

◆ m_add3CPhoton

bool m_add3CPhoton
private

add one photon with unmeasured energy to the fit (costs 1 constraints)

Definition at line 94 of file ParticleKinematicFitterModule.h.

◆ m_addUnmeasuredPhoton

bool m_addUnmeasuredPhoton
private

add one unmeasured photon to the fit (costs 3 constraints)

Definition at line 91 of file ParticleKinematicFitterModule.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_debugFitter

bool m_debugFitter
private

activate internal debugging (for New and Newton fitter only)

Definition at line 89 of file ParticleKinematicFitterModule.h.

◆ m_debugFitterLevel

int m_debugFitterLevel
private

internal debugging level (for New and Newton fitter only)

Definition at line 90 of file ParticleKinematicFitterModule.h.

◆ m_decaydescriptor

DecayDescriptor m_decaydescriptor
private

Decay descriptor of decays to look for.

Definition at line 120 of file ParticleKinematicFitterModule.h.

◆ m_decayString

std::string m_decayString
private

daughter particles selection

Definition at line 119 of file ParticleKinematicFitterModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_eventextrainfo

StoreObjPtr<EventExtraInfo> m_eventextrainfo
private

StoreObjPtr for the EventExtraInfo in this mode.

Definition at line 103 of file ParticleKinematicFitterModule.h.

◆ m_fixUnmeasuredPhotonToHER

bool m_fixUnmeasuredPhotonToHER
private

fix the momentum of the unmeasured photon to HER

Definition at line 92 of file ParticleKinematicFitterModule.h.

◆ m_fixUnmeasuredPhotonToLER

bool m_fixUnmeasuredPhotonToLER
private

fix the momentum of the unmeasured photon to LER

Definition at line 93 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintE

MomentumConstraint m_hardConstraintE
private

hard beam constraint E

Definition at line 112 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintMass

MassConstraint m_hardConstraintMass
private

hard mass constraint

Definition at line 116 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintPx

MomentumConstraint m_hardConstraintPx
private

hard beam constraint px

Definition at line 109 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintPy

MomentumConstraint m_hardConstraintPy
private

hard beam constraint py

Definition at line 110 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintPz

MomentumConstraint m_hardConstraintPz
private

hard beam constraint pz

Definition at line 111 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintRecoilMass

RecoilMassConstraint m_hardConstraintRecoilMass
private

hard recoil mass constraint

Definition at line 114 of file ParticleKinematicFitterModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_invMass

double m_invMass
private

Invariant mass for Mass constraint.

Definition at line 99 of file ParticleKinematicFitterModule.h.

◆ m_kinematicFitter

std::string m_kinematicFitter
private

Kinematic Fitter name.

Definition at line 85 of file ParticleKinematicFitterModule.h.

◆ m_liftPhotonTheta

bool m_liftPhotonTheta
private

lift theta constraint of the 3CPhoton.

Valid when add3CPhoton is true.

Definition at line 95 of file ParticleKinematicFitterModule.h.

◆ m_listName

std::string m_listName
private

particle list name

Definition at line 84 of file ParticleKinematicFitterModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.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_orcaConstraint

std::string m_orcaConstraint
private

Constraint (softBeam, hardBeam (default))

Definition at line 88 of file ParticleKinematicFitterModule.h.

◆ m_orcaFitterEngine

std::string m_orcaFitterEngine
private

Orca Fitter Engine name.

Definition at line 86 of file ParticleKinematicFitterModule.h.

◆ m_orcaTracer

std::string m_orcaTracer
private

Tracer (None, Text or ROOT)

Definition at line 87 of file ParticleKinematicFitterModule.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_plist

StoreObjPtr<ParticleList> m_plist
private

StoreObjPtr for the particle list.

Definition at line 106 of file ParticleKinematicFitterModule.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_recoilMass

double m_recoilMass
private

Recoil mass for RecoilMass constraint.

Definition at line 98 of file ParticleKinematicFitterModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_textTracer

TextTracer* m_textTracer
private

internal text output variable

Definition at line 102 of file ParticleKinematicFitterModule.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_unmeasuredGammaFitObject

std::vector<double> m_unmeasuredGammaFitObject
private

unmeasured fit object

Definition at line 105 of file ParticleKinematicFitterModule.h.

◆ m_unmeasuredLeptonFitObject

std::vector<double> m_unmeasuredLeptonFitObject
private

unmeasured fit object

Definition at line 104 of file ParticleKinematicFitterModule.h.

◆ m_updateDaughters

bool m_updateDaughters
private

update daughter kinematics

Definition at line 97 of file ParticleKinematicFitterModule.h.

◆ m_updateMother

bool m_updateMother
private

update mother kinematics

Definition at line 96 of file ParticleKinematicFitterModule.h.


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