Belle II Software development
ParticleKinematicFitterModule Class Reference

Kinematic fitter module. More...

#include <ParticleKinematicFitterModule.h>

Inheritance diagram for ParticleKinematicFitterModule:
Module PathElement

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, bool useOnlyDirection, int massHypoPDG)
 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 &fitSuffix, 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_prefix
 prefix attached to extrainfo names
 
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.
 
std::vector< int > m_listAlternateMassHypo
 index of particles where only direction is used
 
std::vector< bool > m_listDirectionOnlyParticles
 pdg values for particles where different mass hypo.
 
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_decayStringForDirectionOnlyParticles
 direction only particles selection
 
DecayDescriptor m_decaydescriptorForDirectionOnlyParticles
 Decay descriptor of direction only particles selection.
 
std::string m_decayStringForAlternateMassParticles
 alternate mass particles selection
 
DecayDescriptor m_decaydescriptorForAlternateMassParticles
 Decay descriptor of alternate particles selection.
 
std::string m_decayStringForNeutronVsAntiNeutron
 n or nbar particle tag selection
 
DecayDescriptor m_decaydescriptorForNeutronVsAntiNeutron
 Decay descriptor of n or nbar particle tag selection.
 
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 49 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,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
@ c_Output
Output Process.
Definition ProcHelper.h:19
@ c_Input
Input Process.
Definition ProcHelper.h:17

Constructor & Destructor Documentation

◆ ParticleKinematicFitterModule()

Constructor.

Definition at line 56 of file ParticleKinematicFitterModule.cc.

56 : Module(), m_textTracer(nullptr), m_eventextrainfo("",
58{
59 setDescription("Kinematic fitter for modular analysis");
61
62 // Add parameters
63 addParam("listName", m_listName, "Name of particle list.", string(""));
64 addParam("kinematicFitter", m_kinematicFitter, "Available: OrcaKinFit.", string("OrcaKinFit"));
65 addParam("orcaFitterEngine", m_orcaFitterEngine, "OrcaKinFit engine: NewFitterGSL, NewtonFitterGSL, OPALFitterGSL.",
66 string("OPALFitterGSL"));
67 addParam("orcaTracer", m_orcaTracer, "OrcaKinFit tracer: None, Text.", string("None"));
68 addParam("orcaConstraint", m_orcaConstraint, "OrcaKinFit constraint: HardBeam, RecoilMass.", string("HardBeam"));
69 addParam("debugFitter", m_debugFitter, "Switch on/off internal debugging output if available.", false);
70 addParam("debugFitterLevel", m_debugFitterLevel, "Internal debugging output level if available.", 10);
71 addParam("addUnmeasuredPhoton", m_addUnmeasuredPhoton, "Add one unmeasured photon (-3C).", false);
72 addParam("fixUnmeasuredToHER", m_fixUnmeasuredPhotonToHER, "fix the momentum of the unmeasured photon to HER (+2C).", false);
73 addParam("fixUnmeasuredToLER", m_fixUnmeasuredPhotonToLER, "fix the momentum of the unmeasured photon to LER (+2C).", false);
74 addParam("add3CPhoton", m_add3CPhoton, "Add one photon with unmeasured energy (-1C).", false);
75 addParam("liftPhotonTheta", m_liftPhotonTheta, "Lift theta constraint of 3CPhoton. Valid when add3CPhoton is true.", false);
76 addParam("decayString", m_decayString, "Specifies which daughter particles are included in the kinematic fit.", string(""));
77 addParam("updateMother", m_updateMother, "Update the mother kinematics.", true);
78 addParam("updateDaughters", m_updateDaughters, "Update the daughter kinematics.", false);
79 addParam("recoilMass", m_recoilMass, "Recoil mass in GeV. RecoilMass constraint only.", 0.0);
80 addParam("invMass", m_invMass, "Invariant mass in GeV. Mass constraint only.", 0.0);
81 addParam("variablePrefix", m_prefix, "Prefix attached to extra info variables.", string(""));
82 addParam("decayStringForDirectionOnlyParticles", m_decayStringForDirectionOnlyParticles,
83 "DecayString specifying the particles to use only direction information in the fit", std::string(""));
84 addParam("decayStringForAlternateMassParticles", m_decayStringForAlternateMassParticles,
85 "DecayString specifying the particles where an alternate mass hypothesis is used", std::string(""));
86 addParam("decayStringForNeutronVsAntiNeutron", m_decayStringForNeutronVsAntiNeutron,
87 "DecayString specifying the charged particle used to tag whether n or nbar. If tag particle has negative charge, PDG sign of n/nbar is flipped from default given in alternateMassHypos",
88 std::string(""));
89 addParam("alternateMassHypos", m_listAlternateMassHypo,
90 "integer list of pdg values for particles where different mass hypothesis is used in the fit");
91
92}
@ 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
@ 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
bool m_liftPhotonTheta
lift theta constraint of the 3CPhoton.
std::string m_orcaConstraint
Constraint (softBeam, hardBeam (default))
std::string m_decayStringForNeutronVsAntiNeutron
n or nbar particle tag selection
int m_debugFitterLevel
internal debugging level (for New and Newton fitter only)
std::string m_prefix
prefix attached to extrainfo names
bool m_debugFitter
activate internal debugging (for New and Newton fitter only)
std::string m_decayStringForAlternateMassParticles
alternate mass particles selection
std::vector< int > m_listAlternateMassHypo
index of particles where only direction is used
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
std::string m_decayStringForDirectionOnlyParticles
direction only particles selection
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
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:559

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 667 of file ParticleKinematicFitterModule.cc.

668{
669 if (m_orcaConstraint == "HardBeam") {
670 fitter.addConstraint(m_hardConstraintPx);
671 fitter.addConstraint(m_hardConstraintPy);
672 fitter.addConstraint(m_hardConstraintPz);
673 fitter.addConstraint(m_hardConstraintE);
674 } else if (m_orcaConstraint == "RecoilMass") {
675 fitter.addConstraint(m_hardConstraintRecoilMass);
676 } else if (m_orcaConstraint == "Mass") {
677 fitter.addConstraint(m_hardConstraintMass);
678 }
679
680 else {
681 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
682 }
683}
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 651 of file ParticleKinematicFitterModule.cc.

652{
653 if (m_orcaConstraint == "HardBeam") {
654 m_hardConstraintPx.addToFOList(fitobject);
655 m_hardConstraintPy.addToFOList(fitobject);
656 m_hardConstraintPz.addToFOList(fitobject);
657 m_hardConstraintE.addToFOList(fitobject);
658 } else if (m_orcaConstraint == "RecoilMass") {
659 m_hardConstraintRecoilMass.addToFOList(fitobject);
660 } else if (m_orcaConstraint == "Mass") {
661 m_hardConstraintMass.addToFOList(fitobject);
662 } else {
663 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
664 }
665}

◆ 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 387 of file ParticleKinematicFitterModule.cc.

388{
389 TMatrixFSym MomentumVertexErrorMatrix(7);
390 for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
391 auto* child = const_cast<Particle*>(mother->getDaughter(ichild));
392
393 if (child->getPValue() > 0) {
394 MomentumVertexErrorMatrix += child->getMomentumVertexErrorMatrix();
395 } else if (child->getNDaughters() > 0) {
396 AddFour(child);
397 MomentumVertexErrorMatrix += child->getMomentumVertexErrorMatrix();
398 } else {
399 B2ERROR("Daughter with PDG code " << child->getPDGCode() << " does not have a valid p-value: p=" << child->getPValue() << ", E=" <<
400 child->getEnergy() << " GeV");
401 return false; // error matrix not valid
402 }
403 }
404 mother->setMomentumVertexErrorMatrix(MomentumVertexErrorMatrix);
405 return true;
406}
bool AddFour(Particle *mother)
Added four vectors and calculated a covariance matrix for a combined particles.
unsigned getNDaughters(void) const
Returns number of daughter particles.
Definition Particle.h:747
void setMomentumVertexErrorMatrix(const TMatrixFSym &errMatrix)
Sets 7x7 error matrix.
Definition Particle.cc:424
const Particle * getDaughter(unsigned i) const
Returns a pointer to the i-th daughter particle.
Definition Particle.cc:662

◆ addParticleToOrcaKinFit()

void addParticleToOrcaKinFit ( BaseFitter & fitter,
Particle * particle,
const int index,
bool useOnlyDirection,
int massHypoPDG )
private

Adds given particle to the OrcaKinFit.

Parameters
fitterreference to OrcaKinFit fitter object
particlepointer to particle
indexused to name particles: particle_index
useOnlyDirectionflag to indicate if only position information is used
massHypoPDGPDG code for alternate mass hypothesis

Definition at line 408 of file ParticleKinematicFitterModule.cc.

410{
411 B2DEBUG(17, "ParticleKinematicFitterModule: adding a particle to the fitter!");
412
413 if (m_add3CPhoton && index == 0) {
414 if (particle -> getPDGCode() != Const::photon.getPDGCode()) {
415 B2ERROR("In 3C Kinematic fit, the first daughter should be the Unmeasured Photon!");
416 }
417
418 const ECLCluster* cluster = particle->getECLCluster();
419 double startingE = cluster->getEnergy(particle->getECLClusterEHypothesisBit());
420 double startingPhi = cluster->getPhi();
421 double startingTheta = cluster->getTheta();
422
423 ClusterUtils clutls;
424 const auto EPhiThetaCov = clutls.GetCovarianceMatrix3x3FromCluster(cluster);
425 double startingEError = sqrt(fabs(EPhiThetaCov[0][0]));
426 double startingPhiError = sqrt(fabs(EPhiThetaCov[1][1]));
427 double startingThetaError = sqrt(fabs(EPhiThetaCov[2][2]));
428
429 B2DEBUG(17, startingPhi << " " << startingTheta << " " << startingPhiError << " " << startingThetaError);
430 // create a fit object
431 ParticleFitObject* pfitobject;
432 // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
433 pfitobject = new JetFitObject(startingE, startingTheta, startingPhi, startingEError, startingThetaError, startingPhiError, 0.);
434 pfitobject->setParam(0, startingE, false, false);
436 pfitobject->setParam(1, startingTheta, false, false);
437 else
438 pfitobject->setParam(1, startingTheta, true, false);
439 pfitobject->setParam(2, startingPhi, true, false);
440
441 std::string fitObjectName = "Unmeasured3C";
442 pfitobject->setName(fitObjectName.c_str());
443 ParticleFitObject& fitobject = *pfitobject;
444
445 // add this fit object (=particle) to the constraints
446 addFitObjectToConstraints(fitobject);
447
448 // add fit particle to the fitter
449 fitter.addFitObject(fitobject);
450
451 } else if (useOnlyDirection || massHypoPDG) {
452
453 ParticleFitObject* pfitobject;
454
455 const ECLCluster* cluster = particle->getECLCluster();
456
457 if (particle->getCharge() != 0 or !cluster) {
458 B2FATAL("ParticleKinematicFitterModule: Direction only and alternate mass options only implemented for neutral particles with ECL cluster");
459 }
460
461 double mass = particle->getPDGMass();
462 if (massHypoPDG != 0) {
463 if (TDatabasePDG::Instance()->GetParticle(massHypoPDG) == nullptr) {
464 B2FATAL("ParticleKinematicFitterModule: " << massHypoPDG << " is an unknown PDG code!");
465 }
466 mass = TDatabasePDG::Instance()->GetParticle(massHypoPDG)->Mass();
467 }
468 double clusterE = cluster->getEnergy(particle->getECLClusterEHypothesisBit());
469 double startingE = sqrt(clusterE * clusterE + mass * mass);
470 double startingPhi = cluster->getPhi();
471 double startingTheta = cluster->getTheta();
472
473 ClusterUtils clutls;
474 const auto EPhiThetaCov = clutls.GetCovarianceMatrix3x3FromCluster(cluster, massHypoPDG);
475 double startingEError = sqrt(fabs(EPhiThetaCov[0][0]));
476 double startingPhiError = sqrt(fabs(EPhiThetaCov[1][1]));
477 double startingThetaError = sqrt(fabs(EPhiThetaCov[2][2]));
478
479 // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
480 pfitobject = new JetFitObject(startingE, startingTheta, startingPhi, startingEError, startingThetaError, startingPhiError, mass);
481 pfitobject->setParam(0, startingE, true, false);
482 if (useOnlyDirection) pfitobject->setParam(0, startingE, false, false);
483 pfitobject->setParam(1, startingTheta, true, false);
484 pfitobject->setParam(2, startingPhi, true, false);
485
486 std::string fitObjectName = "particle_" + SSTR(index);
487 pfitobject->setName(fitObjectName.c_str());
488 ParticleFitObject& fitobject = *pfitobject;
489
490 // add this fit object (=particle) to the constraints
491 addFitObjectToConstraints(fitobject);
492
493 // add fit particle to the fitter
494 fitter.addFitObject(fitobject);
495
496 } else {
497 // four vector
498 CLHEP::HepLorentzVector clheplorentzvector = getCLHEPLorentzVector(particle);
499
500 // error matrix
501 CLHEP::HepSymMatrix clhepmomentumerrormatrix = getCLHEPMomentumErrorMatrix(particle);
502
503 // create the fit object (ParticleFitObject is the base class)
504 ParticleFitObject* pfitobject;
505 // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
506 pfitobject = new PxPyPzMFitObject(clheplorentzvector, clhepmomentumerrormatrix);
507 std::string fitObjectName = "particle_" + SSTR(index);
508 pfitobject->setName(fitObjectName.c_str());
509 ParticleFitObject& fitobject = *pfitobject;
510
511 // add this fit object (=particle) to the constraints
512 addFitObjectToConstraints(fitobject);
513
514 // add fit particle to the fitter
515 fitter.addFitObject(fitobject);
516 }
517
518 return;
519}
const TMatrixDSym GetCovarianceMatrix3x3FromCluster(const ECLCluster *cluster, int particleHypo=Const::photon.getPDGCode())
Returns 3x3 covariance matrix (E, theta, phi)
static const ParticleType photon
photon particle
Definition Const.h:673
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.
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.
double sqrt(double a)
sqrt for double
Definition beamHelpers.h:28

◆ addTracerToFitter()

void addTracerToFitter ( BaseFitter & fitter)
private

Adds tracer to the fitter.

Parameters
fitterreference to OrcaKinFit fitter object

Definition at line 685 of file ParticleKinematicFitterModule.cc.

686{
687 if (m_orcaTracer == "Text") {
688 m_textTracer = new TextTracer(std::cout);
689 fitter.setTracer(m_textTracer);
690 } else if (m_orcaTracer != "None") {
691 B2FATAL("ParticleKinematicFitterModule: " << m_orcaTracer << " is an invalid OrcaKinFit tracer!");
692 }
693}

◆ 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 695 of file ParticleKinematicFitterModule.cc.

696{
697 B2DEBUG(17, "ParticleKinematicFitterModule::addUnmeasuredGammaToOrcaKinFit: adding an unmeasured photon to the fitter!");
698 // Initialize photon using the existing constraints
699 ROOT::Math::PxPyPzEVector tlv = getLorentzVectorConstraints();
700 double startingE = tlv.E();
701 double startingPhi = tlv.Phi();
702 double startingTheta = tlv.Theta();
703 bool paramFlag = false;
704
705 // create a fit object
706 ParticleFitObject* pfitobject;
707
708 std::string fitObjectName = "UnmeasuredAlongBeam";
709
711 startingTheta = 41.5e-3; // TODO: Read beam crossing angle from db if it's available
712 startingPhi = 0.0;
713 paramFlag = true;
714 } else if (m_fixUnmeasuredPhotonToLER) {
715 startingTheta = TMath::Pi() - 41.5e-3;
716 startingPhi = 0.0;
717 paramFlag = true;
718 } else {
719 fitObjectName = "Unmeasured";
720 }
721
722 // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
723 pfitobject = new JetFitObject(startingE, startingTheta, startingPhi, 0.0, 0.0, 0.0, 0.);
724 pfitobject->setParam(0, startingE, false, false);
725 pfitobject->setParam(1, startingTheta, paramFlag, paramFlag);
726 pfitobject->setParam(2, startingPhi, paramFlag, paramFlag);
727
728 pfitobject->setName(fitObjectName.c_str());
729 ParticleFitObject& fitobject = *pfitobject;
730
731 // add this fit object (=particle) to the constraints
732 addFitObjectToConstraints(fitobject);
733
734 // add fit particle to the fitter
735 fitter.addFitObject(fitobject);
736}
ROOT::Math::PxPyPzEVector getLorentzVectorConstraints()
Get constraints (at whatever stage before/after fitting)

◆ beginRun()

virtual void beginRun ( void )
inlinevirtualinherited

Called when entering a new run.

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

This method can be implemented by subclasses.

Reimplemented in AnalysisPhase1StudyModule, ARICHBackgroundModule, arichBtestModule, ARICHDigitizerModule, ARICHDQMModule, ARICHRateCalModule, ARICHReconstructorModule, AWESOMEBasicModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BeamSpotMonitorModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CaveModule, CDCCosmicAnalysisModule, CDCCRTestModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTrigger2DFinderModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerTSFModule, CDCTriggerUnpackerModule, CertifyParallelModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, Convert2RawDetModule, CosmicsAlignmentValidationModule, CreateFieldMapModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlTaggerModule, DAQMonitorModule, DAQPerfModule, DataWriterModule, DelayDQMModule, DeSerializerPXDModule, DetectorOccupanciesDQMModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputRootFileModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisKLMModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTrackingHLTModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistInjectionModule, DqmHistoManagerModule, DQMHistoModuleBase, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLDQMInjectionModule, ECLLOMModule, ECLBackgroundModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDModule, ECLChargedPIDMVAModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLDQMOutOfTimeDigitsModule, ECLExpertModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, EffPlotsModule, EKLMDataCheckerModule, ElapsedTimeModule, EnergyBiasCorrectionModule, EventInfoPrinterModule, EventLimiterModule, EventsOfDoomBusterModule, EventT0DQMModule, EventT0ValidationModule, EvReductionModule, EvtGenDecayModule, EvtGenInputModule, ExportGeometryModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastRbuf2DsModule, FlipQualityModule, FullSimModule, TRGGDLUnpackerModule, GearboxModule, GenRawSendModule, GetEventFromSocketModule, GRLNeuroModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HistoManagerModule, HistoModule, HitXPModule, HLTDQM2ZMQModule, IoVDependentConditionModule, IPDQMModule, KinkFinderModule, KKGenInputModule, KLMClusterAnaModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDigitTimeShifterModule, KLMDQM2Module, KLMDQMModule, KLMExpertModule, KLMMuonIDDNNExpertModule, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMTrackingModule, KLMTriggerModule, KLMUnpackerModule, KlongValidationModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MaterialScanModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MCV0MatcherModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, MonitorDataModule, MuidModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, NtuplePhase1_v6Module, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, ParticleVertexFitterModule, Ph1bpipeModule, Ph1sustrModule, PhotonEfficiencySystematicsModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleEcmsBBModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, ProgressModule, PXDBackgroundModule, PXDBgTupleProducerModule, PXDClusterizerModule, PXDDAQDQMModule, PXDDigitizerModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDMCBgTupleProducerModule, PXDPackerModule, PXDRawDQMChipsModule, PXDRawDQMModule, PXDROIDQMModule, PXDUnpackerModule, PXDclusterFilterModule, PXDClustersFromTracksModule, PXDdigiFilterModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDPerformanceModule, PXDRawDQMCorrModule, PXDROIFinderAnalysisModule, PXDROIFinderModule, PXDTrackClusterDQMModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, QualityEstimatorVXDModule, RandomBarrierModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, ReprocessorModule, RxModule, RxSocketModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SectorMapBootstrapModule, SegmentNetworkProducerModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SoftwareTriggerHLTDQMModule, SoftwareTriggerModule, StatisticsTimingHLTDQMModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, SrsensorModule, StatisticsSummaryModule, StorageDeserializerModule, StorageSerializerModule, SubEventModule, SVD3SamplesEmulatorModule, SVDBackgroundModule, SVDClusterizerModule, SVDDigitizerModule, SVDDQMDoseModule, SVDDQMInjectionModule, SVDMissingAPVsClusterCreatorModule, SVDPackerModule, SVDRecoDigitCreatorModule, SVDUnpackerModule, SVDB4CommissioningPlotsModule, SVDClusterCalibrationsMonitorModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, SVDDQMHitTimeModule, svdDumpModule, SVDEventInfoSetterModule, SVDEventT0EstimatorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsCheckModule, SVDLocalCalibrationsMonitorModule, SVDMaxStripTTreeModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPerformanceTTreeModule, SVDPositionErrorScaleFactorImporterModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SVDShaperDigitsFromTracksModule, SVDSpacePointCreatorModule, SVDTimeCalibrationsMonitorModule, SVDTimeGroupingModule, SVDTriggerQualityGeneratorModule, SVDUnpackerDQMModule, SwitchDataStoreModule, TagVertexModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelMaskerModule, TOPChannelT0MCModule, TOPDigitizerModule, TOPDoublePulseGeneratorModule, TOPDQMModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPLaserHitSelectorModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTimeRecalibratorModule, TOPTriggerDigitizerModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, TrackAnaModule, TrackCreatorModule, TrackFinderMCTruthRecoTracksModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackFinderVXDAnalizerModule, TrackingAbortDQMModule, TrackingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, TrackQualityEstimatorMVAModule, TreeFitterModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLInjectionVetoFromOverlayModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TTDDQMModule, TxModule, TxSocketModule, V0findingPerformanceEvaluationModule, V0ObjectsDQMModule, VXDMisalignmentModule, vxdDigitMaskingModule, VXDDQMExpressRecoModule, VXDQETrainingDataCollectorModule, VXDQualityEstimatorMVAModule, VXDSimpleClusterizerModule, and VXDTFTrainingDataCollectorModule.

Definition at line 146 of file Module.h.

146{};

◆ 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{
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.
void setParameters(const ModuleParamList &params)
Set values for parameters from other parameter list.
const ModuleParamList & getParamList() const
Return module param list.
Definition Module.h:362
const std::string & getName() const
Returns the name of the module.
Definition Module.h:186
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:511
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition Module.h:515
void setName(const std::string &name)
Set the name of the module.
Definition Module.h:213
LogConfig m_logConfig
The log system configuration of the module.
Definition Module.h:513
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition Module.h:520
std::string m_package
Package this module is found in (may be empty).
Definition Module.h:509
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 425 of file Module.h.

425{ beginRun(); }

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

438{ endRun(); }

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

431{ event(); }

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

419{ initialize(); }

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

444{ terminate(); }

◆ 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 147 of file ParticleKinematicFitterModule.cc.

148{
149 B2DEBUG(17, "ParticleKinematicFitterModule::doKinematicFit");
150
151 bool ok = false;
152
153 // fitting with OrcaKinFit
154 if (m_kinematicFitter == "OrcaKinFit") {
155
156 // select subset of particles for the fit
157 if (m_decayString != "") {
158 B2FATAL("ParticleKinematicFitterModule: OrcaKinFit does not support yet selection of daughters via decay string!") ;
159 }
160
161 // check requested fit engine
162 if (!(m_orcaFitterEngine == "OPALFitterGSL" or
163 m_orcaFitterEngine == "NewtonFitterGSL" or
164 m_orcaFitterEngine == "NewFitterGSL")) {
165 B2FATAL("ParticleKinematicFitterModule: " << m_orcaFitterEngine << " is an invalid OrcaKinFit fitter engine!");
166 }
167
168 // check requested constraint
169 if (!(m_orcaConstraint == "HardBeam" or
170 m_orcaConstraint == "RecoilMass" or
171 m_orcaConstraint == "Mass")) {
172 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
173 }
174
175 // basic check is good, go to fitting routine
176 ok = doOrcaKinFitFit(mother);
177 } else { // invalid fitter
178 B2FATAL("ParticleKinematicFitter: " << m_kinematicFitter << " is an invalid kinematic fitter!");
179 }
180
181 if (!ok) return false;
182
183 return true;
184
185}
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 187 of file ParticleKinematicFitterModule.cc.

188{
189 if (mother->getNDaughters() <= 1) {
190 B2WARNING("ParticleKinematicFitterModule: Cannot fit with " << mother->getNDaughters() << " daughters.");
191 return false;
192 }
193
194 //use getMdstSource as unique identifier
195 std::vector<int> directionOnlyParticlesIdentifiers;
197 std::vector<const Particle*> selparticles = m_decaydescriptorForDirectionOnlyParticles.getSelectionParticles(mother);
198 for (unsigned int i = 0; i < selparticles.size(); i++) {
199 directionOnlyParticlesIdentifiers.push_back(selparticles[i]->getMdstSource());
200 }
201 }
202
203 //use getMdstSource as unique identifier
204 std::vector<int> alternateMassHypoIdentifiers;
206 std::vector<const Particle*> selparticles = m_decaydescriptorForAlternateMassParticles.getSelectionParticles(mother);
207 for (unsigned int i = 0; i < selparticles.size(); i++) {
208 alternateMassHypoIdentifiers.push_back(selparticles[i]->getMdstSource());
209 }
210 if (alternateMassHypoIdentifiers.size() != m_listAlternateMassHypo.size()) {
211 B2FATAL("alternateMassHypoIdentifiers size must match listAlternateMassHypo");
212 }
213 }
214
215 //Determine if n or nbar based on charge of tag particle indicated
216 //If tag particle has negative charge, sign of n and nbar are flipped.
217 //Required to use optimal position resolution
218 bool flipNeutronPDGsign = 0;
220 std::vector<const Particle*> selparticles = m_decaydescriptorForNeutronVsAntiNeutron.getSelectionParticles(mother);
221 if (selparticles.size() != 1) {
222 B2FATAL("Select only one particle to tag neutron vs. antineutron");
223 }
224 if (selparticles[0]->getCharge() < 0) flipNeutronPDGsign = 1;
225 }
226
227
228 // fill particles
229 std::vector<Particle*> particleChildren;
230 bool validChildren = fillFitParticles(mother, particleChildren);
231
232 if (!validChildren) {
233 B2WARNING("ParticleKinematicFitterModule: Cannot find valid children for the fit.");
234 return false;
235 }
236
237 // set fit engine
238 BaseFitter* pfitter;
239
240 // internal debugger
241 int debugfitter = 0;
242 if (m_debugFitter) debugfitter = m_debugFitterLevel;
243
244 // choose minimization
245 if (m_orcaFitterEngine == "OPALFitterGSL") {
246 pfitter = new OPALFitterGSL(); // OPAL fitter has no debugger
247 } else if (m_orcaFitterEngine == "NewtonFitterGSL") {
248 pfitter = new NewtonFitterGSL();
249 (dynamic_cast<NewtonFitterGSL*>(pfitter))->setDebug(debugfitter);
250 } else if (m_orcaFitterEngine == "NewFitterGSL") {
251 pfitter = new NewFitterGSL();
252 (dynamic_cast<NewFitterGSL*>(pfitter))->setDebug(debugfitter);
253 } else {
254 B2FATAL("ParticleKinematicFitterModule: " << m_orcaFitterEngine << " is an invalid OrcaKinFit fitter engine!");
255 return false;
256 }
257
258 if (!pfitter) return false;
259 BaseFitter& fitter(*pfitter);
260
261 // reset fitter
262 resetFitter(fitter);
263
264 // set constraints (not connected to a fitter or particles at this point!)
266
267
268 // add fit particles from particle list to the fitter and to all constraints
269 for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
270
271 bool useDirectionOnly = false;
272 if (directionOnlyParticlesIdentifiers.size() > 0) {
273 if (std::find(directionOnlyParticlesIdentifiers.begin(), directionOnlyParticlesIdentifiers.end(),
274 particleChildren[iChild]->getMdstSource()) != directionOnlyParticlesIdentifiers.end()) useDirectionOnly = true;
275 }
276
277 int massHypo = 0;
278 if (alternateMassHypoIdentifiers.size() > 0) {
279 for (unsigned int i = 0; i < alternateMassHypoIdentifiers.size(); i++) {
280 if (alternateMassHypoIdentifiers[i] == particleChildren[iChild]->getMdstSource()) {
281 massHypo = m_listAlternateMassHypo[i];
282 break;
283 }
284 }
285 //Always use direction only for neutrons
286 if (abs(massHypo) == Const::neutron.getPDGCode()) {
287 if (useDirectionOnly == false)
288 B2WARNING("Neutron mass hypothesis assigned to fit particle but directionOnly flag not specified for same particle. Setting candidate to useDirectionOnly.");
289 useDirectionOnly = true;
290 if (flipNeutronPDGsign) massHypo = -massHypo;
291 }
292 }
293 addParticleToOrcaKinFit(fitter, particleChildren[iChild], iChild, useDirectionOnly, massHypo);
294 }
295
296 // add unmeasured photon to the fitter and to all constraints
298
299 // add constraints to the fitter
301
302 // add tracers to the fitter
303 addTracerToFitter(fitter);
304
305 //store information before the fit
306 storeOrcaKinFitParticles("Measured", fitter, particleChildren, mother);
307
308 double prob = fitter.fit();
309 double chi2 = fitter.getChi2();
310 int niter = fitter.getIterations();
311 int ndof = fitter.getDoF();
312 int errorcode = fitter.getError();
313
314 B2DEBUG(17, "ParticleKinematicFitterModule: -------------------------------------------");
315 B2DEBUG(17, "ParticleKinematicFitterModule: Fit result of OrcaKinFit using " << m_orcaFitterEngine);
316 B2DEBUG(17, "ParticleKinematicFitterModule: prob " << prob);
317 B2DEBUG(17, "ParticleKinematicFitterModule: chi2 " << chi2);
318 B2DEBUG(17, "ParticleKinematicFitterModule: iterations " << niter);
319 B2DEBUG(17, "ParticleKinematicFitterModule: ndf " << ndof);
320 B2DEBUG(17, "ParticleKinematicFitterModule: errorcode " << errorcode);
321 B2DEBUG(17, "ParticleKinematicFitterModule: -------------------------------------------");
322
323 // default update mother information
324 if (m_updateMother) updateOrcaKinFitMother(fitter, particleChildren, mother);
325
326 // update daughter information if that is requested
327 if (m_updateDaughters) updateOrcaKinFitDaughters(fitter, mother);
328
329 // store information after the fit
330 storeOrcaKinFitParticles("Fitted", fitter, particleChildren, mother);
331
332 //store general fit results
333 mother->addExtraInfo(m_prefix + "OrcaKinFitProb", prob);
334 mother->setPValue(prob);
335 mother->addExtraInfo(m_prefix + "OrcaKinFitChi2", chi2);
336 mother->addExtraInfo(m_prefix + "OrcaKinFitErrorCode", errorcode);
337
338 // 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?
339 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
340 for (auto fo : *fitObjectContainer) {
342 const std::string name = fo->getName();
343 if (name.find("Unmeasured") != std::string::npos) {
344 auto* fitobject = static_cast<ParticleFitObject*>(fo);
345 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
346 mother->addExtraInfo(m_prefix + "OrcaKinFit" + name + "Theta", tlv.Theta());
347 mother->addExtraInfo(m_prefix + "OrcaKinFit" + name + "Phi", tlv.Phi());
348 mother->addExtraInfo(m_prefix + "OrcaKinFit" + name + "E", tlv.E());
349
350 // Uncertainty
351 // const double err0 = getFitObjectError(fitobject, 0);
352 mother->addExtraInfo(m_prefix + "OrcaKinFit" + name + "ErrorTheta", getFitObjectError(fitobject, 1));
353 mother->addExtraInfo(m_prefix + "OrcaKinFit" + name + "ErrorPhi", getFitObjectError(fitobject, 2));
354 mother->addExtraInfo(m_prefix + "OrcaKinFit" + name + "ErrorE", getFitObjectError(fitobject, 0));
355 }
356 }
357 delete fo;
358 }
359
360 delete pfitter;
361 delete m_textTracer;
362 return true;
363}
static const ParticleType neutron
neutron particle
Definition Const.h:675
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 ...
DecayDescriptor m_decaydescriptorForDirectionOnlyParticles
Decay descriptor of direction only particles selection.
void addParticleToOrcaKinFit(BaseFitter &fitter, Particle *particle, const int index, bool useOnlyDirection, int massHypoPDG)
Adds given particle to the OrcaKinFit.
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.
DecayDescriptor m_decaydescriptorForAlternateMassParticles
Decay descriptor of alternate particles selection.
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.
bool storeOrcaKinFitParticles(const std::string &fitSuffix, BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
store fit object information as ExtraInfo
DecayDescriptor m_decaydescriptorForNeutronVsAntiNeutron
Decay descriptor of n or nbar particle tag selection.
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.

◆ endRun()

virtual void endRun ( void )
inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Reimplemented in AlignDQMModule, AnalysisPhase1StudyModule, arichBtestModule, ARICHDQMModule, AWESOMEBasicModule, B2BIIConvertMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CaveModule, CDCCosmicAnalysisModule, CDCCRTestModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, CDCDedxDQMModule, CDCDedxValidationModule, cdcDQM7Module, CDCDQMModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CertifyParallelModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, Convert2RawDetModule, CosmicsAlignmentValidationModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlTaggerModule, DAQPerfModule, DataWriterModule, DeSerializerPXDModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisKLMModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGEFFModule, DQMHistAnalysisTRGGDLModule, DQMHistAnalysisTRGModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DqmHistoManagerModule, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLLOMModule, ECLBackgroundModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, EffPlotsModule, EKLMDataCheckerModule, ElapsedTimeModule, EventInfoPrinterModule, EventT0ValidationModule, EvReductionModule, EvtGenDecayModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastRbuf2DsModule, FullSimModule, TRGGDLUnpackerModule, GenfitVisModule, GenRawSendModule, GetEventFromSocketModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HistoManagerModule, HistoModule, HitXPModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQM2Module, KLMDQMModule, KLMMuonIDDNNExpertModule, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMTrackingModule, KLMTriggerModule, KLMUnpackerModule, KlongValidationModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MCV0MatcherModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, TPCStudyModule, MonitorDataModule, MuidModule, NoKickCutsEvalModule, NtuplePhase1_v6Module, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, Ph1bpipeModule, Ph1sustrModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, PrintDataModule, PrintEventRateModule, PXDBackgroundModule, PXDClustersFromTracksModule, PXDPerformanceModule, PXDROIFinderModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, RandomBarrierModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, ReprocessorModule, Root2BinaryModule, Root2RawModule, RT2SPTCConverterModule, RxModule, RxSocketModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SectorMapBootstrapModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, SrsensorModule, StatisticsSummaryModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, SubEventModule, SVD3SamplesEmulatorModule, SVDBackgroundModule, SVDClusterizerModule, SVDPackerModule, SVDRecoDigitCreatorModule, SVDUnpackerModule, SVDB4CommissioningPlotsModule, SVDClusterCalibrationsMonitorModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, svdDumpModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsMonitorModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPositionErrorScaleFactorImporterModule, SVDROIDQMModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SVDShaperDigitsFromTracksModule, SVDTimeCalibrationsMonitorModule, SVDTriggerQualityGeneratorModule, SVDUnpackerDQMModule, SwitchDataStoreModule, TOPBackgroundModule, TOPChannelT0MCModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPLaserHitSelectorModule, TOPMCTrackMakerModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTriggerDigitizerModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPWaveformQualityPlotterModule, TOPXTalkChargeShareSetterModule, TrackAnaModule, TrackFinderMCTruthRecoTracksModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackFinderVXDAnalizerModule, TrackingPerformanceEvaluationModule, TrackSetEvaluatorHopfieldNNDEVModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TxModule, TxSocketModule, V0findingPerformanceEvaluationModule, vxdDigitMaskingModule, VXDSimpleClusterizerModule, VXDTFTrainingDataCollectorModule, ZMQTxInputModule, and ZMQTxWorkerModule.

Definition at line 165 of file Module.h.

165{};

◆ 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:518
bool m_hasReturnValue
True, if the return value is set.
Definition Module.h:517

◆ event()

void event ( void )
overridevirtual

Event processor.

Reimplemented from Module.

Definition at line 127 of file ParticleKinematicFitterModule.cc.

128{
129 B2DEBUG(17, "ParticleKinematicFitterModule::event");
130
131 unsigned int n = m_plist->getListSize();
132
133 for (unsigned i = 0; i < n; i++) {
134 Particle* particle = m_plist->getParticle(i);
135
136 if (m_updateDaughters == true) {
137 if (m_decayString.empty()) ParticleCopy::copyDaughters(particle);
138 else B2ERROR("Daughters update works only when all daughters are selected. Daughters will not be updated");
139 }
140
141 bool ok = doKinematicFit(particle);
142
143 if (!ok) particle->setPValue(-1.);
144 }
145}
StoreObjPtr< ParticleList > m_plist
StoreObjPtr for the particle list.
bool doKinematicFit(Particle *p)
Main steering routine for any kinematic fitter.
void copyDaughters(Particle *mother)
Function copies all (grand-)^n-daughter particles of the argument mother Particle.

◆ 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 paths */
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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
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>()),
491 &Module::setLogConfig)
@ 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: "<".
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
@ 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_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
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
ModuleCondition::EAfterConditionPath EAfterConditionPath
Forward the EAfterConditionPath definition from the ModuleCondition.
Definition Module.h:88

◆ 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 365 of file ParticleKinematicFitterModule.cc.

366{
367 for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
368 auto* child = const_cast<Particle*>(mother->getDaughter(ichild));
369
370 if (child->getNDaughters() > 0) {
371 bool err = fillFitParticles(child, particleChildren);
372 if (!err) {
373 B2WARNING("ParticleKinematicFitterModule: Cannot find valid children for the fit.");
374 return false;
375 }
376 } else if (child->getPValue() > 0) {
377 particleChildren.push_back(child);
378 } else {
379 B2ERROR("Daughter with PDG code " << child->getPDGCode() << " does not have a valid p-value: p=" << child->getPValue() << ", E=" <<
380 child->getEnergy() << " GeV");
381 return false; // error matrix not valid
382 }
383 }
384 return true;
385}

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

324 {
325 return m_conditions;
326 }

◆ getCLHEPLorentzVector()

CLHEP::HepLorentzVector getCLHEPLorentzVector ( Particle * particle)
private

Returns particle's 4-momentum as a HepLorentzVector.

Parameters
particlepointer to particle

Definition at line 549 of file ParticleKinematicFitterModule.cc.

550{
551 CLHEP::HepLorentzVector mom(particle->getPx(), particle->getPy(), particle->getPz(), particle->get4Vector().E());
552 return mom;
553}

◆ getCLHEPMomentumErrorMatrix()

CLHEP::HepSymMatrix getCLHEPMomentumErrorMatrix ( Particle * particle)
private

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

Parameters
particlepointer to particle

Definition at line 521 of file ParticleKinematicFitterModule.cc.

522{
523 CLHEP::HepSymMatrix covMatrix(4);
524 TMatrixFSym errMatrix = particle->getMomentumErrorMatrix();
525
526 for (int i = 0; i < 4; i++) {
527 for (int j = 0; j < 4; j++) {
528 covMatrix[i][j] = errMatrix[i][j];
529 }
530 }
531
532 return covMatrix;
533}

◆ 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 535 of file ParticleKinematicFitterModule.cc.

536{
537 CLHEP::HepSymMatrix covMatrix(7);
538 TMatrixFSym errMatrix = particle->getMomentumVertexErrorMatrix();
539
540 for (int i = 0; i < 7; i++) {
541 for (int j = 0; j < 7; j++) {
542 covMatrix[i][j] = errMatrix[i][j];
543 }
544 }
545
546 return covMatrix;
547}

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 313 of file Module.h.

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

◆ 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 920 of file ParticleKinematicFitterModule.cc.

921{
922 TMatrixFSym fitCovMatrix(3);
923
924 if (strcmp(fitobject->getParamName(0), "E") == 0) {
925 //check if it is a JetFitObject
926 auto* jetfitObject = static_cast<JetFitObject*>(fitobject);
927 if (jetfitObject) {
928
929 fitCovMatrix = getFitObjectCovMat(fitobject);
930 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
931
932 const double energy = tlv.E();
933 const double theta = tlv.Theta();
934 const double phi = tlv.Phi();
935
936 const double st = sin(theta);
937 const double ct = cos(theta);
938 const double sp = sin(phi);
939 const double cp = cos(phi);
940
941 // updated covariance matrix is: A * cov * A^T where A is the Jacobi matrix (use Similarity)
942 TMatrixF A(7, 3);
943 A(0, 0) = cp * st ; // dpx/dE
944 A(0, 1) = energy * cp * ct ; // dpx/dtheta
945 A(0, 2) = -energy * sp * st ; // dpx/dphi
946 A(1, 0) = sp * st ; // dpy/dE
947 A(1, 1) = energy * sp * ct ; // dpz/dtheta
948 A(1, 2) = energy * cp * st ; // dpy/dphi
949 A(2, 0) = ct ; // dpz/dE
950 A(2, 1) = -energy * st ; // dpz/dtheta
951 A(2, 2) = 0 ; // dpz/dphi
952 A(3, 0) = 1.0; // dE/dE
953 A(3, 1) = 0.0; // dE/dphi
954 A(3, 2) = 0.0; // dE/dtheta
955
956 TMatrixFSym D = fitCovMatrix.Similarity(A);
957 return D;
958
959 } else {
960 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
961 }
962 } else {
963 //check if it is a PxPyPzMFitObject
964 auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
965 if (pxpypzmfitobject) {
966
967 fitCovMatrix = getFitObjectCovMat(fitobject);
968
969 // updated covariance matrix is: A * cov * A^T where A is the Jacobi matrix (use Similarity)
970 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
971 TMatrixF A(7, 3);
972 A[0][0] = 1.; // px/dpx
973 A[0][1] = 0.; // px/dpy
974 A[0][2] = 0.; // px/dpz
975 A[1][0] = 0.; // py/dpx
976 A[1][1] = 1.; // py/dpy
977 A[1][2] = 0.; // py/dpz
978 A[2][0] = 0.; // pz/dpx
979 A[2][1] = 0.; // pz/dpy
980 A[2][2] = 1.; // pz/dpz
981 if (tlv.E() > 0.0) {
982 A[3][0] = tlv.Px() / tlv.E(); // E/dpx, E=sqrt(px^2 + py^2 + pz^2 + m^2)
983 A[3][1] = tlv.Py() / tlv.E(); // E/dpy
984 A[3][2] = tlv.Pz() / tlv.E(); // E/dpz
985 }
986
987 TMatrixFSym D = fitCovMatrix.Similarity(A);
988
989 return D;
990 } else {
991 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
992 }
993 }
994}
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 201 of file Module.h.

201{return m_description;}

◆ getFileNames()

virtual std::vector< std::string > getFileNames ( bool outputFiles)
inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

◆ getFitObjectCovMat()

TMatrixFSym getFitObjectCovMat ( ParticleFitObject * fitobject)
private

Returns covariance matrix.

Parameters
fitobjectreference to OrcaKinFit fit object

Definition at line 898 of file ParticleKinematicFitterModule.cc.

899{
900
901 //check if it is a PxPyPzMFitObject
902 auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
903 if (pxpypzmfitobject) {
904
905 TMatrixFSym errMatrix(3);
906
907 //loop over the i-j local variables.
908 for (int i = 0; i < 3; i++) {
909 for (int j = 0; j < 3; j++) {
910 errMatrix[i][j] = pxpypzmfitobject->getCov(i, j);
911 }
912 }
913
914 return errMatrix;
915 } else {
916 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
917 }
918}

◆ 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 886 of file ParticleKinematicFitterModule.cc.

887{
888 //check if it is a PxPyPzMFitObject
889 auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
890 if (pxpypzmfitobject) {
891 return fitobject->getError(ilocal);
892 } else {
893 B2FATAL("ParticleKinematicFitterModule: not implemented yet");
894 }
895}
virtual double getError(int ilocal) const
Get error of parameter ilocal.

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{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 555 of file ParticleKinematicFitterModule.cc.

556{
557 ROOT::Math::PxPyPzEVector mom(fitobject->getPx(), fitobject->getPy(), fitobject->getPz(), fitobject->getE());
558 return mom;
559}
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 589 of file ParticleKinematicFitterModule.cc.

590{
591 if (m_orcaConstraint == "HardBeam") {
592 ROOT::Math::PxPyPzEVector constraints4vector(m_hardConstraintPx.getValue(),
593 m_hardConstraintPy.getValue(),
594 m_hardConstraintPz.getValue(),
595 m_hardConstraintE.getValue());
596 return constraints4vector;
597 } else {
598 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
599 }
600
601 // should not reach this point...
602 return ROOT::Math::PxPyPzEVector(0., 0., 0., 0.);
603}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 186 of file Module.h.

186{return m_name;}

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

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

380{ return m_returnValue; }

◆ getTMatrixFSymMomentumErrorMatrix()

TMatrixFSym getTMatrixFSymMomentumErrorMatrix ( )
private

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

Definition at line 562 of file ParticleKinematicFitterModule.cc.

563{
564 TMatrixFSym errMatrix(4);
565
566 for (int i = 0; i < 4; i++) {
567 for (int j = i; j < 4; j++) {
568 errMatrix[i][j] = 0.0;
569 }
570 }
571
572 return errMatrix;
573}

◆ getTMatrixFSymMomentumVertexErrorMatrix()

TMatrixFSym getTMatrixFSymMomentumVertexErrorMatrix ( )
private

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

Definition at line 576 of file ParticleKinematicFitterModule.cc.

577{
578 TMatrixFSym errMatrix(7);
579
580 for (int i = 0; i < 7; i++) {
581 for (int j = i; j < 7; j++) {
582 errMatrix[i][j] = 0.0;
583 }
584 }
585
586 return errMatrix;
587}

◆ 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:508

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 310 of file Module.h.

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

377{ 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://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters
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 ( void )
overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 94 of file ParticleKinematicFitterModule.cc.

95{
96 m_eventextrainfo.isRequired();
97
98 if (m_decayString != "") {
100 B2INFO("ParticleKinematicFitter: Using specified decay string: " << m_decayString);
101 }
102
105 }
106
109 if (m_listAlternateMassHypo.size() == 0)
110 B2FATAL("decayStringForAlternateMassParticles specified but alternateMassHypos not provided.");
111 } else if (m_listAlternateMassHypo.size() > 0) {
112 B2FATAL("alternateMassHypos specified but decayStringForAlternateMassParticles not provided.");
113 }
114
117 }
118
119 m_plist.isRequired(m_listName);
120}
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 645 of file ParticleKinematicFitterModule.cc.

646{
647 B2DEBUG(17, "ParticleKinematicFitterModule: Resetting the fitter");
648 fitter.reset();
649}

◆ 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 605 of file ParticleKinematicFitterModule.cc.

606{
607 if (m_orcaConstraint == "HardBeam") {
608 PCmsLabTransform T;
609 const ROOT::Math::PxPyPzEVector boost = T.getBeamFourMomentum();
610
611 m_hardConstraintPx = MomentumConstraint(0, 1, 0, 0, boost.Px());
612 m_hardConstraintPy = MomentumConstraint(0, 0, 1, 0, boost.Py());
613 m_hardConstraintPz = MomentumConstraint(0, 0, 0, 1, boost.Pz());
614 m_hardConstraintE = MomentumConstraint(1, 0, 0, 0, boost.E());
615
616 m_hardConstraintPx.resetFOList();
617 m_hardConstraintPy.resetFOList();
618 m_hardConstraintPz.resetFOList();
619 m_hardConstraintE.resetFOList();
620
621 m_hardConstraintPx.setName("Sum(p_x) [hard]");
622 m_hardConstraintPy.setName("Sum(p_y) [hard]");
623 m_hardConstraintPz.setName("Sum(p_z) [hard]");
624 m_hardConstraintE.setName("Sum(E) [hard]");
625
626 } else if (m_orcaConstraint == "RecoilMass") {
627 PCmsLabTransform T;
628 const ROOT::Math::PxPyPzEVector boost = T.getBeamFourMomentum();
629
630 m_hardConstraintRecoilMass = RecoilMassConstraint(m_recoilMass, boost.Px(), boost.Py(), boost.Pz(), boost.E());
631
632 m_hardConstraintRecoilMass.resetFOList();
633 m_hardConstraintRecoilMass.setName("Recoil Mass [hard]");
634
635 } else if (m_orcaConstraint == "Mass") {
636 m_hardConstraintMass = MassConstraint(m_invMass);
637
638 m_hardConstraintMass.resetFOList();
639 m_hardConstraintMass.setName("Mass [hard]");
640 } else {
641 B2FATAL("ParticleKinematicFitterModule: " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
642 }
643}
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}
std::string m_description
The description of the module.
Definition Module.h:510

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig)
inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

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

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ 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}
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:200
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition LogSystem.cc:28
LogConfig & getLogConfig()
Returns the log system configuration.
Definition Module.h:224
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition Module.h:507
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 & fitSuffix,
BaseFitter & fitter,
std::vector< Particle * > & particleChildren,
Particle * mother )
private

store fit object information as ExtraInfo

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

Definition at line 851 of file ParticleKinematicFitterModule.cc.

853{
854 bool updated = false;
855 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
856
857 for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
858 BaseFitObject* fo = fitObjectContainer->at(iChild);
859 auto* fitobject = static_cast<ParticleFitObject*>(fo);
860 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
861
862 // name of extra variables
863 std::string extraVariableParticlePx = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_Px";
864 std::string extraVariableParticlePy = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_Py";
865 std::string extraVariableParticlePz = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_Pz";
866 std::string extraVariableParticleE = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_E";
867 std::string extraVariableParticlePxErr = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_PxErr";
868 std::string extraVariableParticlePyErr = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_PyErr";
869 std::string extraVariableParticlePzErr = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_PzErr";
870 std::string extraVariableParticleEErr = m_prefix + "OrcaKinFit" + fitSuffix + "_" + SSTR(iChild) + "_EErr";
871
872 mother->addExtraInfo(extraVariableParticlePx, tlv.Px());
873 mother->addExtraInfo(extraVariableParticlePy, tlv.Py());
874 mother->addExtraInfo(extraVariableParticlePz, tlv.Pz());
875 mother->addExtraInfo(extraVariableParticleE, tlv.E());
876 mother->addExtraInfo(extraVariableParticlePxErr, getFitObjectError(fitobject, 0));
877 mother->addExtraInfo(extraVariableParticlePyErr, getFitObjectError(fitobject, 1));
878 mother->addExtraInfo(extraVariableParticlePzErr, getFitObjectError(fitobject, 2));
879 mother->addExtraInfo(extraVariableParticleEErr, -1.0);
880
881 }
882
883 return updated;
884}
void addExtraInfo(const std::string &name, double value)
Sets the user-defined data of given name to the given value.
Definition Particle.cc:1421

◆ terminate()

void terminate ( void )
overridevirtual

termination.

Reimplemented from Module.

Definition at line 122 of file ParticleKinematicFitterModule.cc.

123{
124 B2INFO("ParticleKinematicFitterModule::terminate");
125}

◆ 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 804 of file ParticleKinematicFitterModule.cc.

806{
807 std::vector <Particle*> dDau = daughter->getDaughters();
808 for (unsigned ichild = 0; ichild < daughter->getNDaughters(); ichild++) {
809 const Particle* child = daughter->getDaughter(ichild);
810 std::vector<unsigned> pard;
811 if (child->getNDaughters() > 0) {
812 updateMapOfTrackAndDaughter(l, pars, pard, allparticles, child);
813 parm.insert(parm.end(), pard.begin(), pard.end());
814 pars.push_back(pard);
815 allparticles.push_back(dDau[ichild]);
816 } else {
817 pard.push_back(l);
818 parm.push_back(l);
819 pars.push_back(pard);
820 allparticles.push_back(dDau[ichild]);
821 l++;
822 }
823 }
824}
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 738 of file ParticleKinematicFitterModule.cc.

739{
740 std::vector <Particle*> bDau = mother->getDaughters();
741 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
742
743 const unsigned nd = bDau.size();
744 unsigned l = 0;
745 std::vector<std::vector<unsigned>> pars;
746 std::vector<Particle*> allparticles;
747 for (unsigned ichild = 0; ichild < nd; ichild++) {
748 const Particle* daughter = mother->getDaughter(ichild);
749 std::vector<unsigned> pard;
750 if (daughter->getNDaughters() > 0) {
751 updateMapOfTrackAndDaughter(l, pars, pard, allparticles, daughter);
752 pars.push_back(pard);
753 allparticles.push_back(bDau[ichild]);
754 } else {
755 pard.push_back(l);
756 pars.push_back(pard);
757 allparticles.push_back(bDau[ichild]);
758 l++;
759 }
760 }
761
762 if (l == fitObjectContainer->size() - m_addUnmeasuredPhoton) {
763
764 if (fitter.getError() == 0) {
765 for (unsigned iDaug = 0; iDaug < allparticles.size(); iDaug++) {
766 ROOT::Math::PxPyPzEVector tlv ;
767 TMatrixFSym errMatrixU(7);
768 if (pars[iDaug].size() > 0) {
769 for (unsigned int iChild : pars[iDaug]) {
770 BaseFitObject* fo = fitObjectContainer->at(iChild);
771 auto* fitobject = static_cast<ParticleFitObject*>(fo);
772 ROOT::Math::PxPyPzEVector tlv_sub = getLorentzVector(fitobject);
773 TMatrixFSym errMatrixU_sub = getCovMat7(fitobject);
774 tlv = tlv + tlv_sub;
775 errMatrixU = errMatrixU + errMatrixU_sub;
776 }
777 } else {
778 B2FATAL("ParticleKinematicFitterModule: no fitObject could be used to update the daughter!");
779 }
780 ROOT::Math::XYZVector pos = allparticles[iDaug]->getVertex(); // we don't update the vertex yet
781 TMatrixFSym errMatrix = allparticles[iDaug]->getMomentumVertexErrorMatrix();
782 TMatrixFSym errMatrixMom = allparticles[iDaug]->getMomentumErrorMatrix();
783 TMatrixFSym errMatrixVer = allparticles[iDaug]->getVertexErrorMatrix();
784
785 for (int i = 0; i < 3; i++) {
786 for (int j = i; j < 3; j++) {
787 errMatrixU[i + 4][j + 4] = errMatrixVer[i][j];
788 }
789 }
790
791 allparticles[iDaug]->set4Vector(tlv);
792 allparticles[iDaug]->setVertex(pos);
793 allparticles[iDaug]->setMomentumVertexErrorMatrix(errMatrixU);
794 }
795 }
796
797 return true;
798 } else {
799 B2ERROR("updateOrcaKinFitDaughters: Cannot update daughters, mismatch between number of daughters and number of fitobjects!");
800 return false;
801 }
802}
TMatrixFSym getCovMat7(ParticleFitObject *fitobject)
Returns covariance matrix.
std::vector< Particle * > getDaughters() const
Returns a vector of pointers to daughter particles.
Definition Particle.cc:668

◆ 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 826 of file ParticleKinematicFitterModule.cc.

828{
829 // get old values
830 ROOT::Math::XYZVector pos = mother->getVertex();
831 TMatrixFSym errMatrix = mother->getMomentumVertexErrorMatrix();
832 float pvalue = mother->getPValue();
833
834 // update momentum vector
835 ROOT::Math::PxPyPzEVector momnew(0., 0., 0., 0.);
836
837 std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
838 for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
839 BaseFitObject* fo = fitObjectContainer->at(iChild);
840 auto* fitobject = static_cast<ParticleFitObject*>(fo);
841 ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
842 momnew += tlv;
843 }
844
845 // update
846 // TODO: use pvalue of the fit or the old one of the mother? use fit covariance matrix?
847 // Maybe here should use the pvalue and errmatrix of the fit ----Yu Hu
848 mother->updateMomentum(momnew, pos, errMatrix, pvalue);
849}
double getPValue() const
Returns chi^2 probability of fit if done or -1.
Definition Particle.h:687
ROOT::Math::XYZVector getVertex() const
Returns vertex position (POCA for charged, IP for neutral FS particles)
Definition Particle.h:651
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:397
TMatrixFSym getMomentumVertexErrorMatrix() const
Returns 7x7 error matrix.
Definition Particle.cc:451

Member Data Documentation

◆ m_add3CPhoton

bool m_add3CPhoton
private

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

Definition at line 88 of file ParticleKinematicFitterModule.h.

◆ m_addUnmeasuredPhoton

bool m_addUnmeasuredPhoton
private

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

Definition at line 85 of file ParticleKinematicFitterModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

◆ m_debugFitter

bool m_debugFitter
private

activate internal debugging (for New and Newton fitter only)

Definition at line 83 of file ParticleKinematicFitterModule.h.

◆ m_debugFitterLevel

int m_debugFitterLevel
private

internal debugging level (for New and Newton fitter only)

Definition at line 84 of file ParticleKinematicFitterModule.h.

◆ m_decaydescriptor

DecayDescriptor m_decaydescriptor
private

Decay descriptor of decays to look for.

Definition at line 116 of file ParticleKinematicFitterModule.h.

◆ m_decaydescriptorForAlternateMassParticles

DecayDescriptor m_decaydescriptorForAlternateMassParticles
private

Decay descriptor of alternate particles selection.

Definition at line 122 of file ParticleKinematicFitterModule.h.

◆ m_decaydescriptorForDirectionOnlyParticles

DecayDescriptor m_decaydescriptorForDirectionOnlyParticles
private

Decay descriptor of direction only particles selection.

Definition at line 119 of file ParticleKinematicFitterModule.h.

◆ m_decaydescriptorForNeutronVsAntiNeutron

DecayDescriptor m_decaydescriptorForNeutronVsAntiNeutron
private

Decay descriptor of n or nbar particle tag selection.

Definition at line 125 of file ParticleKinematicFitterModule.h.

◆ m_decayString

std::string m_decayString
private

daughter particles selection

Definition at line 115 of file ParticleKinematicFitterModule.h.

◆ m_decayStringForAlternateMassParticles

std::string m_decayStringForAlternateMassParticles
private

alternate mass particles selection

Definition at line 121 of file ParticleKinematicFitterModule.h.

◆ m_decayStringForDirectionOnlyParticles

std::string m_decayStringForDirectionOnlyParticles
private

direction only particles selection

Definition at line 118 of file ParticleKinematicFitterModule.h.

◆ m_decayStringForNeutronVsAntiNeutron

std::string m_decayStringForNeutronVsAntiNeutron
private

n or nbar particle tag selection

Definition at line 124 of file ParticleKinematicFitterModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_eventextrainfo

StoreObjPtr<EventExtraInfo> m_eventextrainfo
private

StoreObjPtr for the EventExtraInfo in this mode.

Definition at line 99 of file ParticleKinematicFitterModule.h.

◆ m_fixUnmeasuredPhotonToHER

bool m_fixUnmeasuredPhotonToHER
private

fix the momentum of the unmeasured photon to HER

Definition at line 86 of file ParticleKinematicFitterModule.h.

◆ m_fixUnmeasuredPhotonToLER

bool m_fixUnmeasuredPhotonToLER
private

fix the momentum of the unmeasured photon to LER

Definition at line 87 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintE

MomentumConstraint m_hardConstraintE
private

hard beam constraint E

Definition at line 108 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintMass

MassConstraint m_hardConstraintMass
private

hard mass constraint

Definition at line 112 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintPx

MomentumConstraint m_hardConstraintPx
private

hard beam constraint px

Definition at line 105 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintPy

MomentumConstraint m_hardConstraintPy
private

hard beam constraint py

Definition at line 106 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintPz

MomentumConstraint m_hardConstraintPz
private

hard beam constraint pz

Definition at line 107 of file ParticleKinematicFitterModule.h.

◆ m_hardConstraintRecoilMass

RecoilMassConstraint m_hardConstraintRecoilMass
private

hard recoil mass constraint

Definition at line 110 of file ParticleKinematicFitterModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_invMass

double m_invMass
private

Invariant mass for Mass constraint.

Definition at line 93 of file ParticleKinematicFitterModule.h.

◆ m_kinematicFitter

std::string m_kinematicFitter
private

Kinematic Fitter name.

Definition at line 79 of file ParticleKinematicFitterModule.h.

◆ m_liftPhotonTheta

bool m_liftPhotonTheta
private

lift theta constraint of the 3CPhoton.

Valid when add3CPhoton is true.

Definition at line 89 of file ParticleKinematicFitterModule.h.

◆ m_listAlternateMassHypo

std::vector<int> m_listAlternateMassHypo
private

index of particles where only direction is used

Definition at line 94 of file ParticleKinematicFitterModule.h.

◆ m_listDirectionOnlyParticles

std::vector<bool> m_listDirectionOnlyParticles
private

pdg values for particles where different mass hypo.

is used

Definition at line 95 of file ParticleKinematicFitterModule.h.

◆ m_listName

std::string m_listName
private

particle list name

Definition at line 77 of file ParticleKinematicFitterModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 507 of file Module.h.

◆ m_orcaConstraint

std::string m_orcaConstraint
private

Constraint (softBeam, hardBeam (default))

Definition at line 82 of file ParticleKinematicFitterModule.h.

◆ m_orcaFitterEngine

std::string m_orcaFitterEngine
private

Orca Fitter Engine name.

Definition at line 80 of file ParticleKinematicFitterModule.h.

◆ m_orcaTracer

std::string m_orcaTracer
private

Tracer (None, Text or ROOT)

Definition at line 81 of file ParticleKinematicFitterModule.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 509 of file Module.h.

◆ m_plist

StoreObjPtr<ParticleList> m_plist
private

StoreObjPtr for the particle list.

Definition at line 102 of file ParticleKinematicFitterModule.h.

◆ m_prefix

std::string m_prefix
private

prefix attached to extrainfo names

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

◆ m_recoilMass

double m_recoilMass
private

Recoil mass for RecoilMass constraint.

Definition at line 92 of file ParticleKinematicFitterModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_textTracer

TextTracer* m_textTracer
private

internal text output variable

Definition at line 98 of file ParticleKinematicFitterModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ m_unmeasuredGammaFitObject

std::vector<double> m_unmeasuredGammaFitObject
private

unmeasured fit object

Definition at line 101 of file ParticleKinematicFitterModule.h.

◆ m_unmeasuredLeptonFitObject

std::vector<double> m_unmeasuredLeptonFitObject
private

unmeasured fit object

Definition at line 100 of file ParticleKinematicFitterModule.h.

◆ m_updateDaughters

bool m_updateDaughters
private

update daughter kinematics

Definition at line 91 of file ParticleKinematicFitterModule.h.

◆ m_updateMother

bool m_updateMother
private

update mother kinematics

Definition at line 90 of file ParticleKinematicFitterModule.h.


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