Belle II Software light-2406-ragdoll
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
TagVertexModule Class Reference
Packages » analysis | Modules » analysis modules

Tag side Vertex Fitter module for modular analysis. More...

#include <TagVertexModule.h>

Inheritance diagram for TagVertexModule:
Inheritance graph
[legend]
Collaboration diagram for TagVertexModule:
Collaboration graph
[legend]

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

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

Static Public Member Functions

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

Protected Member Functions

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

Private Member Functions

bool doVertexFit (const Particle *Breco)
 central method for the tag side vertex fit
 
Particle * doVertexFitForBTube (const Particle *mother, std::string fitType) const
 it returns an intersection between B rec and beam spot (= origin of BTube)
 
std::pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraint (const Particle *Breco, double cut) const
 calculate the constraint for the vertex fit on the tag side using Breco information
 
std::pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraintBoost (double cut) const
 calculate the standard constraint for the vertex fit on the tag side
 
std::pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraintBTube (const Particle *Breco, double cut)
 calculate constraint for the vertex fit on the tag side using the B tube (cylinder along the expected BTag line of flights
 
void BtagMCVertex (const Particle *Breco)
 get the vertex of the MC B particle associated to Btag.
 
std::vector< const Particle * > getTagTracks_standardAlgorithm (const Particle *Breco, int nPXDHits) const
 performs the fit using the standard algorithm - using all tracks in RoE The user can specify a request on the PXD hits left by the tracks
 
analysis::VertexFitKFit doSingleKfit (std::vector< ParticleAndWeight > &particleAndWeights)
 performs single KFit on particles stored in particleAndWeights this function can be iterated several times until chi2/ndf of the resulting fit is sufficient
 
std::vector< ParticleAndWeight > getParticlesAndWeights (const std::vector< const Particle * > &tagParticles) const
 Get a list of particles with attached weight and associated MC particle.
 
bool makeGeneralFit ()
 TO DO: tag side vertex fit in the case of semileptonic tag side decay.
 
bool makeGeneralFitRave ()
 make the vertex fit on the tag side: RAVE AVF tracks coming from Ks removed all other tracks used
 
void fillParticles (std::vector< ParticleAndWeight > &particleAndWeights)
 Fill sorted list of particles into external variable.
 
void fillTagVinfo (const ROOT::Math::XYZVector &tagVpos, const TMatrixDSym &tagVposErr)
 Fill tagV vertex info.
 
bool makeGeneralFitKFit ()
 make the vertex fit on the tag side: KFit tracks coming from Ks removed all other tracks used
 
void deltaT (const Particle *Breco)
 calculate DeltaT and MC-DeltaT (rec - tag) in ps from Breco and Btag vertices DT = Dl / gamma beta c , l = boost direction
 
void resetReturnParams ()
 Reset all parameters that are computed in each event and then used to compute tuple variables.
 
TrackFitResult getTrackWithTrueCoordinates (ParticleAndWeight const &paw) const
 If the fit has to be done with the truth info, Rave is fed with a track where the momentum is replaced by the true momentum and the position replaced by the point on the true particle trajectory closest to the measured track position The function below takes care of that.
 
TrackFitResult getTrackWithRollBackCoordinates (ParticleAndWeight const &paw)
 If the fit has to be done with the rolled back tracks, Rave or KFit is fed with a track where the position of track is shifted by the vector difference of mother B and production point of track from truth info The function below takes care of that.
 
ROOT::Math::XYZVector getRollBackPoca (ParticleAndWeight const &paw)
 This shifts the position of tracks by the vector difference of mother B and production point of track from truth info.
 
std::list< ModulePtr > getModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Static Private Member Functions

static bool compBrecoBgen (const Particle *Breco, const MCParticle *Bgen)
 compare Breco with the two MC B particles
 
static std::string printVector (const ROOT::Math::XYZVector &vec)
 Print a XYZVector (useful for debugging)
 
static std::string printMatrix (const TMatrixD &mat)
 Print a TMatrix (useful for debugging)
 
static std::string printMatrix (const TMatrixDSym &mat)
 Print a TMatrixFSym (useful for debugging)
 
static ROOT::Math::XYZVector getTruePoca (ParticleAndWeight const &paw)
 This finds the point on the true particle trajectory closest to the measured track position.
 

Private Attributes

StoreArray< TagVertex > m_verArray
 StoreArray of TagVertexes.
 
StoreArray< MCParticle > m_mcParticles
 StoreArray of MCParticles.
 
StoreObjPtr< ParticleList > m_plist
 input particle list
 
std::string m_listName
 Breco particle list name.
 
double m_confidenceLevel
 required fit confidence level
 
std::string m_useMCassociation
 No MC association or standard Breco particle or internal MCparticle association.
 
std::string m_constraintType
 Choose constraint: noConstraint, IP, tube, boost, (breco)
 
std::string m_trackFindingType
 Choose how to find the tag tracks: standard, standard_PXD.
 
int m_reqPXDHits
 N of PXD hits for a track to be used.
 
std::string m_roeMaskName
 ROE particles from this mask will be used for vertex fitting.
 
double m_Bfield
 magnetic field from data base
 
std::vector< const Particle * > m_tagParticles
 tracks of the rest of the event
 
std::vector< const Particle * > m_raveParticles
 tracks given to rave for the track fit (after removing Kshorts
 
std::vector< double > m_raveWeights
 Store the weights used by Rave in the vtx fit so that they can be accessed later.
 
std::vector< const MCParticle * > m_raveMCParticles
 Store the MC particles corresponding to each track used by Rave in the vtx fit.
 
bool m_useTruthInFit
 Set to true if the tag fit is to be made with the TRUE tag track momentum and position.
 
int m_fitTruthStatus
 Store info about whether the fit was performed with the truth info 0 fit performed with measured parameters 1 fit performed with true parameters 2 unable to recover truth parameters.
 
bool m_useRollBack
 Set to true if the tag fit is to be made with the tag track position rolled back to mother B.
 
int m_rollbackStatus
 Store info about whether the fit was performed with the rolled back tracks 0 fit performed with measured parameters 1 fit performed with rolled back parameters 2 unable to recover truth parameters.
 
double m_fitPval
 P value of the tag side fit result.
 
ROOT::Math::XYZVector m_tagV
 tag side fit result
 
TMatrixDSym m_tagVErrMatrix
 Error matrix of the tag side fit result.
 
ROOT::Math::XYZVector m_mcTagV
 generated tag side vertex
 
double m_mcTagLifeTime
 generated tag side life time of B-decay
 
int m_mcPDG
 generated tag side B flavor
 
ROOT::Math::XYZVector m_mcVertReco
 generated Breco decay vertex
 
double m_mcLifeTimeReco
 generated Breco life time
 
double m_deltaT
 reconstructed DeltaT
 
double m_deltaTErr
 reconstructed DeltaT error
 
double m_mcDeltaTau
 generated DeltaT
 
double m_mcDeltaT
 generated DeltaT with boost-direction approximation
 
TMatrixDSym m_constraintCov
 constraint to be used in the tag vertex fit
 
ROOT::Math::XYZVector m_constraintCenter
 centre position of the constraint for the tag Vertex fit
 
ROOT::Math::XYZVector m_BeamSpotCenter
 Beam spot position.
 
TMatrixDSym m_BeamSpotCov
 size of the beam spot == covariance matrix on the beam spot position
 
bool m_mcInfo
 true if user wants to retrieve MC information out from the tracks used in the fit
 
DBObjPtr< BeamSpot > m_beamSpotDB
 Beam spot database object.
 
int m_FitType
 fit algo used

 
double m_tagVl
 tagV component in the boost direction

 
double m_truthTagVl
 MC tagV component in the boost direction

 
double m_tagVlErr
 Error of the tagV component in the boost direction

 
double m_tagVol
 tagV component in the direction orthogonal to the boost
 
double m_truthTagVol
 MC tagV component in the direction orthogonal to the boost.
 
double m_tagVolErr
 Error of the tagV component in the direction orthogonal to the boost.
 
double m_tagVNDF
 Number of degrees of freedom in the tag vertex fit.
 
double m_tagVChi2
 chi^2 value of the tag vertex fit result
 
double m_tagVChi2IP
 IP component of the chi^2 of the tag vertex fit result.
 
std::string m_fitAlgo
 Algorithm used for the tag fit (Rave or KFit)
 
double m_kFitReqReducedChi2
 The required chi2/ndf to accept the kFit result, if it is higher, iteration procedure is applied.
 
bool m_verbose
 choose if you want to print extra infos
 
TMatrixDSym m_pvCov
 covariance matrix of the PV (useful with tube and KFit)
 
ROOT::Math::PxPyPzEVector m_tagMomentum
 B tag momentum computed from fully reconstructed B sig.
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleCondition > m_conditions
 Module condition, only non-null if set.
 

Detailed Description

Tag side Vertex Fitter module for modular analysis.

This module fits the Btag Vertex *

Definition at line 61 of file TagVertexModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

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 };
Belle2::Module::c_HistogramManager
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
Belle2::Module::c_Input
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
Belle2::Module::c_DontCollectStatistics
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
Belle2::Module::c_ParallelProcessingCertified
@ 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
Belle2::Module::c_InternalSerializer
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
Belle2::Module::c_Output
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
Belle2::Module::c_TerminateInAllProcesses
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ TagVertexModule()

TagVertexModule ( )

Constructor.

Definition at line 80 of file TagVertexModule.cc.

80 : Module(),
81 m_Bfield(0), m_fitTruthStatus(0), m_rollbackStatus(0), m_fitPval(0), m_mcTagLifeTime(-1), m_mcPDG(0), m_mcLifeTimeReco(-1),
82 m_deltaT(0), m_deltaTErr(0), m_mcDeltaTau(0), m_mcDeltaT(0),
83 m_FitType(0), m_tagVl(0),
84 m_truthTagVl(0), m_tagVlErr(0), m_tagVol(0), m_truthTagVol(0), m_tagVolErr(0), m_tagVNDF(0), m_tagVChi2(0), m_tagVChi2IP(0),
85 m_kFitReqReducedChi2(5),
86 m_verbose(true)
87{
88 // Set module properties
89 setDescription("Tag side Vertex Fitter for modular analysis");
90
91 // Parameter definitions
92 addParam("listName", m_listName, "name of particle list", string(""));
93 addParam("confidenceLevel", m_confidenceLevel,
94 "required confidence level of fit to keep particles in the list. Note that even with confidenceLevel == 0.0, errors during the fit might discard Particles in the list. confidenceLevel = -1 if an error occurs during the fit",
95 0.001);
96 addParam("MCAssociation", m_useMCassociation,
97 "'': no MC association. breco: use standard Breco MC association. internal: use internal MC association", string("breco"));
98 addParam("constraintType", m_constraintType,
99 "Choose the type of the constraint: noConstraint, IP (tag tracks constrained to be within the beam spot), tube (long tube along the BTag line of flight, only for fully reconstruced B rec), boost (long tube along the Upsilon(4S) boost direction), (breco)",
100 string("tube"));
101 addParam("trackFindingType", m_trackFindingType,
102 "Choose how to reconstruct the tracks on the tag side: standard, standard_PXD",
103 string("standard_PXD"));
104 addParam("maskName", m_roeMaskName,
105 "Choose ROE mask to get particles from ", string(RestOfEvent::c_defaultMaskName));
106 addParam("askMCInformation", m_mcInfo,
107 "TRUE when requesting MC Information from the tracks performing the vertex fit", false);
108 addParam("reqPXDHits", m_reqPXDHits,
109 "Minimum number of PXD hits for a track to be used in the vertex fit", 0);
110 addParam("fitAlgorithm", m_fitAlgo,
111 "Fitter used for the tag vertex fit: Rave or KFit", string("KFit"));
112 addParam("kFitReqReducedChi2", m_kFitReqReducedChi2,
113 "The required chi2/ndf to accept the kFit result, if it is higher, iteration procedure is applied", 5.0);
114 addParam("useTruthInFit", m_useTruthInFit,
115 "Use the true track parameters in the vertex fit", false);
116 addParam("useRollBack", m_useRollBack,
117 "Use rolled back non-primary tracks", false);
118}
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Belle2::Module::Module
Module()
Constructor.
Definition: Module.cc:30
Belle2::RestOfEvent::c_defaultMaskName
static constexpr const char * c_defaultMaskName
Default mask name.
Definition: RestOfEvent.h:60
Belle2::TagVertexModule::m_fitTruthStatus
int m_fitTruthStatus
Store info about whether the fit was performed with the truth info 0 fit performed with measured para...
Definition: TagVertexModule.h:114
Belle2::TagVertexModule::m_truthTagVol
double m_truthTagVol
MC tagV component in the direction orthogonal to the boost.
Definition: TagVertexModule.h:146
Belle2::TagVertexModule::m_tagVl
double m_tagVl
tagV component in the boost direction
Definition: TagVertexModule.h:142
Belle2::TagVertexModule::m_truthTagVl
double m_truthTagVl
MC tagV component in the boost direction
Definition: TagVertexModule.h:143
Belle2::TagVertexModule::m_useTruthInFit
bool m_useTruthInFit
Set to true if the tag fit is to be made with the TRUE tag track momentum and position.
Definition: TagVertexModule.h:113
Belle2::TagVertexModule::m_mcDeltaT
double m_mcDeltaT
generated DeltaT with boost-direction approximation
Definition: TagVertexModule.h:134
Belle2::TagVertexModule::m_listName
std::string m_listName
Breco particle list name.
Definition: TagVertexModule.h:99
Belle2::TagVertexModule::m_useRollBack
bool m_useRollBack
Set to true if the tag fit is to be made with the tag track position rolled back to mother B.
Definition: TagVertexModule.h:118
Belle2::TagVertexModule::m_tagVlErr
double m_tagVlErr
Error of the tagV component in the boost direction
Definition: TagVertexModule.h:144
Belle2::TagVertexModule::m_roeMaskName
std::string m_roeMaskName
ROE particles from this mask will be used for vertex fitting.
Definition: TagVertexModule.h:106
Belle2::TagVertexModule::m_tagVChi2
double m_tagVChi2
chi^2 value of the tag vertex fit result
Definition: TagVertexModule.h:149
Belle2::TagVertexModule::m_mcInfo
bool m_mcInfo
true if user wants to retrieve MC information out from the tracks used in the fit
Definition: TagVertexModule.h:139
Belle2::TagVertexModule::m_kFitReqReducedChi2
double m_kFitReqReducedChi2
The required chi2/ndf to accept the kFit result, if it is higher, iteration procedure is applied.
Definition: TagVertexModule.h:152
Belle2::TagVertexModule::m_useMCassociation
std::string m_useMCassociation
No MC association or standard Breco particle or internal MCparticle association.
Definition: TagVertexModule.h:101
Belle2::TagVertexModule::m_tagVolErr
double m_tagVolErr
Error of the tagV component in the direction orthogonal to the boost.
Definition: TagVertexModule.h:147
Belle2::TagVertexModule::m_mcTagLifeTime
double m_mcTagLifeTime
generated tag side life time of B-decay
Definition: TagVertexModule.h:127
Belle2::TagVertexModule::m_tagVNDF
double m_tagVNDF
Number of degrees of freedom in the tag vertex fit.
Definition: TagVertexModule.h:148
Belle2::TagVertexModule::m_deltaTErr
double m_deltaTErr
reconstructed DeltaT error
Definition: TagVertexModule.h:132
Belle2::TagVertexModule::m_fitAlgo
std::string m_fitAlgo
Algorithm used for the tag fit (Rave or KFit)
Definition: TagVertexModule.h:151
Belle2::TagVertexModule::m_mcDeltaTau
double m_mcDeltaTau
generated DeltaT
Definition: TagVertexModule.h:133
Belle2::TagVertexModule::m_fitPval
double m_fitPval
P value of the tag side fit result.
Definition: TagVertexModule.h:123
Belle2::TagVertexModule::m_reqPXDHits
int m_reqPXDHits
N of PXD hits for a track to be used.
Definition: TagVertexModule.h:105
Belle2::TagVertexModule::m_confidenceLevel
double m_confidenceLevel
required fit confidence level
Definition: TagVertexModule.h:100
Belle2::TagVertexModule::m_tagVChi2IP
double m_tagVChi2IP
IP component of the chi^2 of the tag vertex fit result.
Definition: TagVertexModule.h:150
Belle2::TagVertexModule::m_tagVol
double m_tagVol
tagV component in the direction orthogonal to the boost
Definition: TagVertexModule.h:145
Belle2::TagVertexModule::m_constraintType
std::string m_constraintType
Choose constraint: noConstraint, IP, tube, boost, (breco)
Definition: TagVertexModule.h:103
Belle2::TagVertexModule::m_mcLifeTimeReco
double m_mcLifeTimeReco
generated Breco life time
Definition: TagVertexModule.h:130
Belle2::TagVertexModule::m_Bfield
double m_Bfield
magnetic field from data base
Definition: TagVertexModule.h:107
Belle2::TagVertexModule::m_mcPDG
int m_mcPDG
generated tag side B flavor
Definition: TagVertexModule.h:128
Belle2::TagVertexModule::m_rollbackStatus
int m_rollbackStatus
Store info about whether the fit was performed with the rolled back tracks 0 fit performed with measu...
Definition: TagVertexModule.h:119
Belle2::TagVertexModule::m_trackFindingType
std::string m_trackFindingType
Choose how to find the tag tracks: standard, standard_PXD.
Definition: TagVertexModule.h:104
Belle2::TagVertexModule::m_verbose
bool m_verbose
choose if you want to print extra infos
Definition: TagVertexModule.h:153
Belle2::TagVertexModule::m_FitType
int m_FitType
fit algo used
Definition: TagVertexModule.h:141
Belle2::TagVertexModule::m_deltaT
double m_deltaT
reconstructed DeltaT
Definition: TagVertexModule.h:131
Belle2::Module::addParam
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

Member Function Documentation

◆ beginRun()

void beginRun ( )
overridevirtual

Called when entering a new run.

Set run dependent things

Reimplemented from Module.

Definition at line 148 of file TagVertexModule.cc.

149{
150 //TODO: set magnetic field for each run
151 //m_Bfield = BFieldMap::Instance().getBField(m_BeamSpotCenter).Z();
152}

◆ BtagMCVertex()

void BtagMCVertex ( const Particle *  Breco)
private

get the vertex of the MC B particle associated to Btag.

It works only with signal MC

Definition at line 526 of file TagVertexModule.cc.

527{
528 //fill vector with mcB (intended order: Reco, Tag)
529 vector<const MCParticle*> mcBs;
530 for (const MCParticle& mc : m_mcParticles) {
531 if (abs(mc.getPDG()) == abs(Breco->getPDGCode()))
532 mcBs.push_back(&mc);
533 }
534 //too few Bs
535 if (mcBs.size() < 2) return;
536
537 if (mcBs.size() > 2) {
538 B2WARNING("TagVertexModule:: Too many Bs found in MC");
539 }
540
541 auto isReco = [&](const MCParticle * mc) {
542 return (m_useMCassociation == "breco") ? (mc == Breco->getRelated<MCParticle>())
543 : compBrecoBgen(Breco, mc); //internal association
544 };
545
546 //nothing matched?
547 if (!isReco(mcBs[0]) && !isReco(mcBs[1])) {
548 return;
549 }
550
551 //first is Tag, second Reco -> swap the order
552 if (!isReco(mcBs[0]) && isReco(mcBs[1]))
553 swap(mcBs[0], mcBs[1]);
554
555 //both matched -> use closest vertex dist as Reco
556 if (isReco(mcBs[0]) && isReco(mcBs[1])) {
557 double dist0 = (mcBs[0]->getDecayVertex() - Breco->getVertex()).Mag2();
558 double dist1 = (mcBs[1]->getDecayVertex() - Breco->getVertex()).Mag2();
559 if (dist0 > dist1)
560 swap(mcBs[0], mcBs[1]);
561 }
562
563 m_mcVertReco = mcBs[0]->getDecayVertex();
564 m_mcLifeTimeReco = getProperLifeTime(mcBs[0]);
565 m_mcTagV = mcBs[1]->getDecayVertex();
566 m_mcTagLifeTime = getProperLifeTime(mcBs[1]);
567 m_mcPDG = mcBs[1]->getPDG();
568}
Belle2::MCParticle
A Class to store the Monte Carlo particle information.
Definition: MCParticle.h:32
Belle2::Particle::getVertex
ROOT::Math::XYZVector getVertex() const
Returns vertex position (POCA for charged, IP for neutral FS particles)
Definition: Particle.h:631
Belle2::Particle::getPDGCode
int getPDGCode(void) const
Returns PDG code.
Definition: Particle.h:454
Belle2::RelationsInterface::getRelated
T * getRelated(const std::string &name="", const std::string &namedRelation="") const
Get the object to or from which this object has a relation.
Definition: RelationsObject.h:278
Belle2::TagVertexModule::m_mcVertReco
ROOT::Math::XYZVector m_mcVertReco
generated Breco decay vertex
Definition: TagVertexModule.h:129
Belle2::TagVertexModule::m_mcParticles
StoreArray< MCParticle > m_mcParticles
StoreArray of MCParticles.
Definition: TagVertexModule.h:96
Belle2::TagVertexModule::compBrecoBgen
static bool compBrecoBgen(const Particle *Breco, const MCParticle *Bgen)
compare Breco with the two MC B particles
Definition: TagVertexModule.cc:571
Belle2::TagVertexModule::m_mcTagV
ROOT::Math::XYZVector m_mcTagV
generated tag side vertex
Definition: TagVertexModule.h:126

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

◆ compBrecoBgen()

bool compBrecoBgen ( const Particle *  Breco,
const MCParticle *  Bgen 
)
staticprivate

compare Breco with the two MC B particles

Definition at line 571 of file TagVertexModule.cc.

572{
573
574 bool isDecMode = true;
575
576 const std::vector<Belle2::Particle*> recDau = Breco->getDaughters();
577 const std::vector<Belle2::MCParticle*> genDau = Bgen->getDaughters();
578
579 if (recDau.size() > 0 && genDau.size() > 0) {
580 for (auto dauRec : recDau) {
581 bool isDau = false;
582 for (auto dauGen : genDau) {
583 if (dauGen->getPDG() == dauRec->getPDGCode())
584 isDau = compBrecoBgen(dauRec, dauGen) ;
585 }
586 if (!isDau) isDecMode = false;
587 }
588 } else {
589 if (recDau.size() == 0) { //&& genDau.size()==0){
590 if (Bgen->getPDG() != Breco->getPDGCode()) isDecMode = false;;
591 } else {isDecMode = false;}
592 }
593
594 return isDecMode;
595}
Belle2::MCParticle::getDaughters
std::vector< Belle2::MCParticle * > getDaughters() const
Get vector of all daughter particles, empty vector if none.
Definition: MCParticle.cc:52
Belle2::MCParticle::getPDG
int getPDG() const
Return PDG code of particle.
Definition: MCParticle.h:112
Belle2::Particle::getDaughters
std::vector< Belle2::Particle * > getDaughters() const
Returns a vector of pointers to daughter particles.
Definition: Particle.cc:637

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

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

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

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

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

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

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

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

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

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

◆ deltaT()

void deltaT ( const Particle *  Breco)
private

calculate DeltaT and MC-DeltaT (rec - tag) in ps from Breco and Btag vertices DT = Dl / gamma beta c , l = boost direction

Definition at line 886 of file TagVertexModule.cc.

887{
888
889 B2Vector3D boost = PCmsLabTransform().getBoostVector();
890 ROOT::Math::XYZVector boostDir = ROOT::Math::XYZVector(boost.Unit());
891 double bg = boost.Mag() / sqrt(1 - boost.Mag2());
892 double c = Const::speedOfLight / 1000.; // cm ps-1
893
894 //Reconstructed DeltaL & DeltaT in the boost direction
895 ROOT::Math::XYZVector dVert = Breco->getVertex() - m_tagV; //reconstructed vtxReco - vtxTag
896 double dl = dVert.Dot(boostDir);
897 m_deltaT = dl / (bg * c);
898
899 //Truth DeltaL & approx DeltaT in the boost direction
900 ROOT::Math::XYZVector MCdVert = m_mcVertReco - m_mcTagV; //truth vtxReco - vtxTag
901 double MCdl = MCdVert.Dot(boostDir);
902 m_mcDeltaT = MCdl / (bg * c);
903
904 // MCdeltaTau=tauRec-tauTag
905 m_mcDeltaTau = m_mcLifeTimeReco - m_mcTagLifeTime;
906 if (m_mcLifeTimeReco == -1 || m_mcTagLifeTime == -1)
907 m_mcDeltaTau = realNaN;
908
909 TVectorD bVec = toVec(B2Vector3D(boostDir));
910
911 //TagVertex error in boost dir
912 m_tagVlErr = sqrt(m_tagVErrMatrix.Similarity(bVec));
913
914 //bReco error in boost dir
915 double bRecoErrL = sqrt(Breco->getVertexErrorMatrix().Similarity(bVec));
916
917 //Delta t error
918 m_deltaTErr = hypot(m_tagVlErr, bRecoErrL) / (bg * c);
919
920 m_tagVl = m_tagV.Dot(boostDir);
921 m_truthTagVl = m_mcTagV.Dot(boostDir);
922
923 // calculate tagV component and error in the direction orthogonal to the boost
924 B2Vector3D oboost = getUnitOrthogonal(B2Vector3D(boostDir));
925 TVectorD oVec = toVec(oboost);
926
927 //TagVertex error in boost-orthogonal dir
928 m_tagVolErr = sqrt(m_tagVErrMatrix.Similarity(oVec));
929
930 m_tagVol = m_tagV.Dot(oboost);
931 m_truthTagVol = m_mcTagV.Dot(oboost);
932}
Belle2::B2Vector3::Mag
DataType Mag() const
The magnitude (rho in spherical coordinate system).
Definition: B2Vector3.h:159
Belle2::B2Vector3::Mag2
DataType Mag2() const
The magnitude squared (rho^2 in spherical coordinate system).
Definition: B2Vector3.h:157
Belle2::B2Vector3::Unit
B2Vector3< DataType > Unit() const
Unit vector parallel to this.
Definition: B2Vector3.h:269
Belle2::Const::speedOfLight
static const double speedOfLight
[cm/ns]
Definition: Const.h:695
Belle2::PCmsLabTransform
Class to hold Lorentz transformations from/to CMS and boost vector.
Definition: PCmsLabTransform.h:30
Belle2::PCmsLabTransform::getBoostVector
B2Vector3D getBoostVector() const
Returns boost vector (beta=p/E)
Definition: PCmsLabTransform.h:42
Belle2::Particle::getVertexErrorMatrix
TMatrixFSym getVertexErrorMatrix() const
Returns the 3x3 position error sub-matrix.
Definition: Particle.cc:447
Belle2::TagVertexModule::m_tagV
ROOT::Math::XYZVector m_tagV
tag side fit result
Definition: TagVertexModule.h:124
Belle2::TagVertexModule::m_tagVErrMatrix
TMatrixDSym m_tagVErrMatrix
Error matrix of the tag side fit result.
Definition: TagVertexModule.h:125
Belle2::B2Vector3D
B2Vector3< double > B2Vector3D
typedef for common usage with double
Definition: B2Vector3.h:516

◆ doSingleKfit()

analysis::VertexFitKFit doSingleKfit ( std::vector< ParticleAndWeight > &  particleAndWeights)
private

performs single KFit on particles stored in particleAndWeights this function can be iterated several times until chi2/ndf of the resulting fit is sufficient

Definition at line 749 of file TagVertexModule.cc.

750{
751 //initialize KFit
752 analysis::VertexFitKFit kFit;
753 kFit.setMagneticField(m_Bfield);
754
755 // apply constraint
756 if (m_constraintType != "noConstraint") {
757 if (m_constraintType == "tube") {
758 CLHEP::HepSymMatrix err(7, 0);
759 //copy m_pvCov to the end of err matrix
760 err.sub(5, ROOTToCLHEP::getHepSymMatrix(m_pvCov));
761 kFit.setIpTubeProfile(
762 ROOTToCLHEP::getHepLorentzVector(m_tagMomentum),
763 ROOTToCLHEP::getPoint3DFromB2Vector(m_constraintCenter),
764 err,
765 0.);
766 } else {
767 kFit.setIpProfile(ROOTToCLHEP::getPoint3DFromB2Vector(m_constraintCenter),
768 ROOTToCLHEP::getHepSymMatrix(m_constraintCov));
769 }
770 }
771
772
773 for (auto& pawi : particleAndWeights) {
774 int addedOK = 1;
775 if (m_useTruthInFit) {
776 if (pawi.mcParticle) {
777 addedOK = kFit.addTrack(
778 ROOTToCLHEP::getHepLorentzVector(pawi.mcParticle->get4Vector()),
779 ROOTToCLHEP::getPoint3DFromB2Vector(getTruePoca(pawi)),
780 ROOTToCLHEP::getHepSymMatrix(pawi.particle->getMomentumVertexErrorMatrix()),
781 pawi.particle->getCharge());
782 } else {
783 m_fitTruthStatus = 2;
784 }
785 } else if (m_useRollBack) {
786 if (pawi.mcParticle) {
787 addedOK = kFit.addTrack(
788 ROOTToCLHEP::getHepLorentzVector(pawi.mcParticle->get4Vector()),
789 ROOTToCLHEP::getPoint3DFromB2Vector(getRollBackPoca(pawi)),
790 ROOTToCLHEP::getHepSymMatrix(pawi.particle->getMomentumVertexErrorMatrix()),
791 pawi.particle->getCharge());
792 } else {
793 m_rollbackStatus = 2;
794 }
795 } else {
796 addedOK = kFit.addParticle(pawi.particle);
797 }
798
799 if (addedOK == 0) {
800 pawi.weight = 1.;
801 } else {
802 B2WARNING("TagVertexModule::makeGeneralFitKFit: failed to add a track");
803 pawi.weight = 0.;
804 }
805 }
806
807
808 int nTracksAdded = kFit.getTrackCount();
809
810 //perform fit if there are enough tracks
811 if ((nTracksAdded < 2 && m_constraintType == "noConstraint") || nTracksAdded < 1)
812 return analysis::VertexFitKFit();
813
814 int isGoodFit = kFit.doFit();
815 if (isGoodFit != 0) return analysis::VertexFitKFit();
816
817 return kFit;
818}
Belle2::TagVertexModule::m_constraintCov
TMatrixDSym m_constraintCov
constraint to be used in the tag vertex fit
Definition: TagVertexModule.h:135
Belle2::TagVertexModule::m_pvCov
TMatrixDSym m_pvCov
covariance matrix of the PV (useful with tube and KFit)
Definition: TagVertexModule.h:154
Belle2::TagVertexModule::getTruePoca
static ROOT::Math::XYZVector getTruePoca(ParticleAndWeight const &paw)
This finds the point on the true particle trajectory closest to the measured track position.
Definition: TagVertexModule.cc:976
Belle2::TagVertexModule::m_constraintCenter
ROOT::Math::XYZVector m_constraintCenter
centre position of the constraint for the tag Vertex fit
Definition: TagVertexModule.h:136
Belle2::TagVertexModule::getRollBackPoca
ROOT::Math::XYZVector getRollBackPoca(ParticleAndWeight const &paw)
This shifts the position of tracks by the vector difference of mother B and production point of track...
Definition: TagVertexModule.cc:1001
Belle2::TagVertexModule::m_tagMomentum
ROOT::Math::PxPyPzEVector m_tagMomentum
B tag momentum computed from fully reconstructed B sig.
Definition: TagVertexModule.h:155
Belle2::analysis::VertexFitKFit
VertexFitKFit is a derived class from KFitBase to perform vertex-constraint kinematical fit.
Definition: VertexFitKFit.h:34

◆ doVertexFit()

bool doVertexFit ( const Particle *  Breco)
private

central method for the tag side vertex fit

Definition at line 250 of file TagVertexModule.cc.

251{
252 //reset the fit truth status in case it was set to 2 in a previous fit
253
254 if (m_useTruthInFit) m_fitTruthStatus = 1;
255
256 //reset the roll back status in case it was set to 2 in a previous fit
257
258 if (m_useRollBack) m_rollbackStatus = 1;
259
260 //set constraint type, reset pVal and B field
261
262 m_fitPval = 1;
263
264 if (!(Breco->getRelatedTo<RestOfEvent>())) {
265 m_FitType = -1;
266 return false;
267 }
268
269 if (m_Bfield == 0) {
270 B2ERROR("TagVertex: No magnetic field");
271 return false;
272 }
273
274 // recover beam spot info
275
276 m_BeamSpotCenter = m_beamSpotDB->getIPPosition();
277 m_BeamSpotCov.ResizeTo(3, 3);
278 m_BeamSpotCov = m_beamSpotDB->getCovVertex();
279
280 //make the beam spot bigger for the standard constraint
281
282 double beta = PCmsLabTransform().getBoostVector().Mag();
283 double bg = beta / sqrt(1 - beta * beta);
284
285 //TODO: What's the origin of these numbers?
286 double tauB = 1.519; //B0 lifetime in ps
287 double c = Const::speedOfLight / 1000.; // cm ps-1
288 double lB0 = tauB * bg * c;
289
290 //tube length here set to 20 * 2 * c tau beta gamma ~= 0.5 cm, should be enough to not bias the decay
291 //time but should still help getting rid of some pions from kshorts
292 m_constraintCov.ResizeTo(3, 3);
293 if (m_constraintType == "IP") tie(m_constraintCenter, m_constraintCov) = findConstraintBoost(2 * lB0);
294 else if (m_constraintType == "tube") tie(m_constraintCenter, m_constraintCov) = findConstraintBTube(Breco, 200 * lB0);
295 else if (m_constraintType == "boost") tie(m_constraintCenter, m_constraintCov) = findConstraintBoost(200 * lB0);
296 else if (m_constraintType == "breco") tie(m_constraintCenter, m_constraintCov) = findConstraint(Breco, 200 * lB0);
297 else if (m_constraintType == "noConstraint") m_constraintCenter = ROOT::Math::XYZVector(); //zero vector
298 else {
299 B2ERROR("TagVertex: Invalid constraintType selected");
300 return false;
301 }
302
303 if (m_constraintCenter == vecNaN) {
304 B2ERROR("TagVertex: No correct fit constraint");
305 return false;
306 }
307
308 /* Depending on the user's choice, one of the possible algorithms is chosen for the fit. In case the algorithm does not converge, in order to assure
309 high efficiency, the next algorithm less restrictive is used. I.e, if standard_PXD does not work, the program tries with standard.
310 */
311
312 m_FitType = 0;
313 double minPVal = (m_fitAlgo != "KFit") ? 0.001 : 0.;
314 bool ok = false;
315
316 if (m_trackFindingType == "standard_PXD") {
317 m_tagParticles = getTagTracks_standardAlgorithm(Breco, 1);
318 if (m_tagParticles.size() > 0) {
319 ok = makeGeneralFit();
320 m_FitType = 3;
321 }
322 }
323
324 if (ok == false || m_fitPval < minPVal || m_trackFindingType == "standard") {
325 m_tagParticles = getTagTracks_standardAlgorithm(Breco, m_reqPXDHits);
326 ok = m_tagParticles.size() > 0;
327 if (ok) {
328 ok = makeGeneralFit();
329 m_FitType = 4;
330 }
331 }
332
333 if ((ok == false || (m_fitPval <= 0. && m_fitAlgo == "Rave")) && m_constraintType != "noConstraint") {
334 tie(m_constraintCenter, m_constraintCov) = findConstraintBoost(200 * lB0);
335 ok = (m_constraintCenter != vecNaN);
336 if (ok) {
337 m_tagParticles = getTagTracks_standardAlgorithm(Breco, m_reqPXDHits);
338 ok = (m_tagParticles.size() > 0);
339 }
340 if (ok) {
341 ok = makeGeneralFit();
342 m_FitType = 5;
343 }
344 }
345
346 return ok;
347}
Belle2::RelationsInterface::getRelatedTo
TO * getRelatedTo(const std::string &name="", const std::string &namedRelation="") const
Get the object to which this object has a relation.
Definition: RelationsObject.h:248
Belle2::RestOfEvent
This is a general purpose class for collecting reconstructed MDST data objects that are not used in r...
Definition: RestOfEvent.h:57
Belle2::TagVertexModule::m_tagParticles
std::vector< const Particle * > m_tagParticles
tracks of the rest of the event
Definition: TagVertexModule.h:108
Belle2::TagVertexModule::getTagTracks_standardAlgorithm
std::vector< const Particle * > getTagTracks_standardAlgorithm(const Particle *Breco, int nPXDHits) const
performs the fit using the standard algorithm - using all tracks in RoE The user can specify a reques...
Definition: TagVertexModule.cc:601
Belle2::TagVertexModule::findConstraintBoost
std::pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraintBoost(double cut) const
calculate the standard constraint for the vertex fit on the tag side
Definition: TagVertexModule.cc:497
Belle2::TagVertexModule::findConstraintBTube
std::pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraintBTube(const Particle *Breco, double cut)
calculate constraint for the vertex fit on the tag side using the B tube (cylinder along the expected...
Definition: TagVertexModule.cc:413
Belle2::TagVertexModule::findConstraint
std::pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraint(const Particle *Breco, double cut) const
calculate the constraint for the vertex fit on the tag side using Breco information
Definition: TagVertexModule.cc:349
Belle2::TagVertexModule::m_BeamSpotCenter
ROOT::Math::XYZVector m_BeamSpotCenter
Beam spot position.
Definition: TagVertexModule.h:137
Belle2::TagVertexModule::makeGeneralFit
bool makeGeneralFit()
TO DO: tag side vertex fit in the case of semileptonic tag side decay.
Definition: TagVertexModule.cc:643
Belle2::TagVertexModule::m_beamSpotDB
DBObjPtr< BeamSpot > m_beamSpotDB
Beam spot database object.
Definition: TagVertexModule.h:140
Belle2::TagVertexModule::m_BeamSpotCov
TMatrixDSym m_BeamSpotCov
size of the beam spot == covariance matrix on the beam spot position
Definition: TagVertexModule.h:138

◆ doVertexFitForBTube()

Particle * doVertexFitForBTube ( const Particle *  mother,
std::string  fitType 
) const
private

it returns an intersection between B rec and beam spot (= origin of BTube)

Definition at line 934 of file TagVertexModule.cc.

935{
936 //make a copy of motherIn to not modify the original object
937 Particle* mother = ParticleCopy::copyParticle(motherIn);
938
939 //Here rave is used to find the upsilon(4S) vtx as the intersection
940 //between the mother B trajectory and the beam spot
941 analysis::RaveSetup::getInstance()->setBeamSpot(m_BeamSpotCenter, m_BeamSpotCov);
942
943 analysis::RaveVertexFitter rsg;
944 rsg.addTrack(mother);
945 int nvert = rsg.fit(fitType);
946 if (nvert != 1) {
947 mother->setPValue(-1); //error
948 return mother;
949 } else {
950 rsg.updateDaughters();
951 return mother;
952 }
953}
Belle2::Particle
Class to store reconstructed particles.
Definition: Particle.h:75
Belle2::Particle::setPValue
void setPValue(double pValue)
Sets chi^2 probability of fit.
Definition: Particle.h:366
Belle2::analysis::RaveSetup::getInstance
static RaveSetup * getInstance()
get the pointer to the instance to get/set any of options stored in RaveSetup
Definition: RaveSetup.h:43
Belle2::analysis::RaveSetup::setBeamSpot
void setBeamSpot(const B2Vector3D &beamSpot, const TMatrixDSym &beamSpotCov)
The beam spot position and covariance is known you can set it here so that and a vertex in the beam s...
Definition: RaveSetup.cc:72
Belle2::analysis::RaveVertexFitter
The RaveVertexFitter class is part of the RaveInterface together with RaveSetup.
Definition: RaveVertexFitter.h:36
Belle2::analysis::RaveVertexFitter::fit
int fit(std::string options="default")
do the vertex fit with all tracks previously added with the addTrack or addMother function.
Definition: RaveVertexFitter.cc:121
Belle2::analysis::RaveVertexFitter::addTrack
void addTrack(const Particle *const aParticlePtr)
add a track (in the format of a Belle2::Particle) to set of tracks that should be fitted to a vertex
Definition: RaveVertexFitter.cc:87
Belle2::analysis::RaveVertexFitter::updateDaughters
void updateDaughters()
update the Daughters particles
Definition: RaveVertexFitter.cc:250
Belle2::ParticleCopy::copyParticle
Particle * copyParticle(const Particle *original)
Function takes argument Particle and creates a copy of it and copies of all its (grand-)^n-daughters.
Definition: ParticleCopy.cc:18

◆ endRun()

virtual void endRun ( )
inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

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

Definition at line 166 of file Module.h.

166{};

◆ 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}
Belle2::Module::m_returnValue
int m_returnValue
The return value.
Definition: Module.h:519
Belle2::Module::m_hasReturnValue
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( )
overridevirtual

Event processor.

Reimplemented from Module.

Definition at line 154 of file TagVertexModule.cc.

155{
156 if (!m_plist) {
157 B2ERROR("TagVertexModule: ParticleList " << m_listName << " not found");
158 return;
159 }
160
161 // output
162 analysis::RaveSetup::initialize(1, m_Bfield);
163
164 std::vector<unsigned int> toRemove;
165
166 for (unsigned i = 0; i < m_plist->getListSize(); ++i) {
167 resetReturnParams();
168
169 Particle* particle = m_plist->getParticle(i);
170 if (m_useMCassociation == "breco" || m_useMCassociation == "internal") BtagMCVertex(particle);
171 bool ok = doVertexFit(particle);
172 if (ok) deltaT(particle);
173
174 if ((m_fitPval < m_confidenceLevel && m_confidenceLevel != 0)
175 || (m_fitPval <= m_confidenceLevel && m_confidenceLevel == 0)) {
176 toRemove.push_back(particle->getArrayIndex());
177 } else {
178 // save information in the Vertex StoreArray
179 TagVertex* ver = m_verArray.appendNew();
180 // create relation: Particle <-> Vertex
181 particle->addRelationTo(ver);
182 // fill Vertex with content
183 if (ok) {
184 ver->setTagVertex(m_tagV);
185 ver->setTagVertexErrMatrix(m_tagVErrMatrix);
186 ver->setTagVertexPval(m_fitPval);
187 ver->setDeltaT(m_deltaT);
188 ver->setDeltaTErr(m_deltaTErr);
189 ver->setMCTagVertex(m_mcTagV);
190 ver->setMCTagBFlavor(m_mcPDG);
191 ver->setMCDeltaTau(m_mcDeltaTau);
192 ver->setMCDeltaT(m_mcDeltaT);
193 ver->setFitType(m_FitType);
194 ver->setNTracks(m_tagParticles.size());
195 ver->setTagVl(m_tagVl);
196 ver->setTruthTagVl(m_truthTagVl);
197 ver->setTagVlErr(m_tagVlErr);
198 ver->setTagVol(m_tagVol);
199 ver->setTruthTagVol(m_truthTagVol);
200 ver->setTagVolErr(m_tagVolErr);
201 ver->setTagVNDF(m_tagVNDF);
202 ver->setTagVChi2(m_tagVChi2);
203 ver->setTagVChi2IP(m_tagVChi2IP);
204 ver->setVertexFitParticles(m_raveParticles);
205 ver->setVertexFitMCParticles(m_raveMCParticles);
206 ver->setRaveWeights(m_raveWeights);
207 ver->setConstraintType(m_constraintType);
208 ver->setConstraintCenter(m_constraintCenter);
209 ver->setConstraintCov(m_constraintCov);
210 ver->setFitTruthStatus(m_fitTruthStatus);
211 ver->setRollBackStatus(m_rollbackStatus);
212 } else {
213 ver->setTagVertex(m_tagV);
214 ver->setTagVertexPval(-1.);
215 ver->setDeltaT(m_deltaT);
216 ver->setDeltaTErr(m_deltaTErr);
217 ver->setMCTagVertex(m_mcTagV);
218 ver->setMCTagBFlavor(0.);
219 ver->setMCDeltaTau(m_mcDeltaTau);
220 ver->setMCDeltaT(m_mcDeltaT);
221 ver->setFitType(m_FitType);
222 ver->setNTracks(m_tagParticles.size());
223 ver->setTagVl(m_tagVl);
224 ver->setTruthTagVl(m_truthTagVl);
225 ver->setTagVlErr(m_tagVlErr);
226 ver->setTagVol(m_tagVol);
227 ver->setTruthTagVol(m_truthTagVol);
228 ver->setTagVolErr(m_tagVolErr);
229 ver->setTagVNDF(-1111.);
230 ver->setTagVChi2(-1111.);
231 ver->setTagVChi2IP(-1111.);
232 ver->setVertexFitParticles(m_raveParticles);
233 ver->setVertexFitMCParticles(m_raveMCParticles);
234 ver->setRaveWeights(m_raveWeights);
235 ver->setConstraintType(m_constraintType);
236 ver->setConstraintCenter(m_constraintCenter);
237 ver->setConstraintCov(m_constraintCov);
238 ver->setFitTruthStatus(m_fitTruthStatus);
239 ver->setRollBackStatus(m_rollbackStatus);
240 }
241 }
242 }
243 m_plist->removeParticles(toRemove);
244
245 //free memory allocated by rave. initialize() would be enough, except that we must clean things up before program end...
246 //
247 analysis::RaveSetup::getInstance()->reset();
248}
Belle2::RelationsInterface::addRelationTo
void addRelationTo(const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
Add a relation from this object to another object (with caching).
Definition: RelationsObject.h:142
Belle2::RelationsInterface::getArrayIndex
int getArrayIndex() const
Returns this object's array index (in StoreArray), or -1 if not found.
Definition: RelationsObject.h:385
Belle2::TagVertexModule::doVertexFit
bool doVertexFit(const Particle *Breco)
central method for the tag side vertex fit
Definition: TagVertexModule.cc:250
Belle2::TagVertexModule::m_raveWeights
std::vector< double > m_raveWeights
Store the weights used by Rave in the vtx fit so that they can be accessed later.
Definition: TagVertexModule.h:110
Belle2::TagVertexModule::BtagMCVertex
void BtagMCVertex(const Particle *Breco)
get the vertex of the MC B particle associated to Btag.
Definition: TagVertexModule.cc:526
Belle2::TagVertexModule::m_verArray
StoreArray< TagVertex > m_verArray
StoreArray of TagVertexes.
Definition: TagVertexModule.h:95
Belle2::TagVertexModule::deltaT
void deltaT(const Particle *Breco)
calculate DeltaT and MC-DeltaT (rec - tag) in ps from Breco and Btag vertices DT = Dl / gamma beta c ...
Definition: TagVertexModule.cc:886
Belle2::TagVertexModule::m_raveParticles
std::vector< const Particle * > m_raveParticles
tracks given to rave for the track fit (after removing Kshorts
Definition: TagVertexModule.h:109
Belle2::TagVertexModule::resetReturnParams
void resetReturnParams()
Reset all parameters that are computed in each event and then used to compute tuple variables.
Definition: TagVertexModule.cc:1011
Belle2::TagVertexModule::m_plist
StoreObjPtr< ParticleList > m_plist
input particle list
Definition: TagVertexModule.h:97
Belle2::TagVertexModule::m_raveMCParticles
std::vector< const MCParticle * > m_raveMCParticles
Store the MC particles corresponding to each track used by Rave in the vtx fit.
Definition: TagVertexModule.h:112
Belle2::TagVertex
TagVertex data object: contains Btag Vertex and DeltaT.
Definition: TagVertex.h:34
Belle2::TagVertex::setConstraintType
void setConstraintType(const std::string &constraintType)
Set the type of the constraint for the tag fit.
Definition: TagVertex.cc:312
Belle2::TagVertex::setTagVlErr
void setTagVlErr(float TagVlErr)
Set the error of the tagV component in the boost direction.
Definition: TagVertex.cc:250
Belle2::TagVertex::setTruthTagVl
void setTruthTagVl(float TruthTagVl)
Set the MC tagV component in the boost direction.
Definition: TagVertex.cc:245
Belle2::TagVertex::setTagVertex
void setTagVertex(const B2Vector3D &TagVertex)
Set BTag Vertex.
Definition: TagVertex.cc:185
Belle2::TagVertex::setConstraintCenter
void setConstraintCenter(const B2Vector3D &constraintCenter)
Set the centre of the constraint for the tag fit.
Definition: TagVertex.cc:301
Belle2::TagVertex::setTruthTagVol
void setTruthTagVol(float TruthTagVol)
Set the tagV component in the direction orthogonal to the boost.
Definition: TagVertex.cc:260
Belle2::TagVertex::setMCTagBFlavor
void setMCTagBFlavor(int mcTagBFlavor)
Set generated Btag PDG code.
Definition: TagVertex.cc:215
Belle2::TagVertex::setTagVolErr
void setTagVolErr(float TagVolErr)
Set the error of the tagV component in the direction orthogonal to the boost.
Definition: TagVertex.cc:265
Belle2::TagVertex::setMCTagVertex
void setMCTagVertex(const B2Vector3D &mcTagVertex)
Set generated BTag Vertex.
Definition: TagVertex.cc:210
Belle2::TagVertex::setTagVNDF
void setTagVNDF(float TagVNDF)
Set the number of degrees of freedom in the tag vertex fit.
Definition: TagVertex.cc:270
Belle2::TagVertex::setDeltaTErr
void setDeltaTErr(float DeltaTErr)
Set DeltaTErr.
Definition: TagVertex.cc:205
Belle2::TagVertex::setNTracks
void setNTracks(int nTracks)
Set number of tracks used in the fit.
Definition: TagVertex.cc:235
Belle2::TagVertex::setTagVChi2
void setTagVChi2(float TagVChi2)
Set the chi^2 value of the tag vertex fit result.
Definition: TagVertex.cc:275
Belle2::TagVertex::setMCDeltaT
void setMCDeltaT(float mcDeltaT)
Set generated DeltaT (in kin.
Definition: TagVertex.cc:225
Belle2::TagVertex::setRollBackStatus
void setRollBackStatus(int backStatus)
Set the status of the fit performed with the rolled back tracks.
Definition: TagVertex.cc:336
Belle2::TagVertex::setVertexFitMCParticles
void setVertexFitMCParticles(const std::vector< const MCParticle * > &vtxFitMCParticles)
Set a vector of pointers to the MC p'cles corresponding to the tracks in the tag vtx fit.
Definition: TagVertex.cc:291
Belle2::TagVertex::setTagVol
void setTagVol(float TagVol)
Set the tagV component in the direction orthogonal to the boost.
Definition: TagVertex.cc:255
Belle2::TagVertex::setDeltaT
void setDeltaT(float DeltaT)
Set DeltaT.
Definition: TagVertex.cc:200
Belle2::TagVertex::setRaveWeights
void setRaveWeights(const std::vector< double > &raveWeights)
Set the weights used by Rave in the tag vtx fit.
Definition: TagVertex.cc:296
Belle2::TagVertex::setTagVertexPval
void setTagVertexPval(float TagVertexPval)
Set BTag Vertex P value.
Definition: TagVertex.cc:195
Belle2::TagVertex::setMCDeltaTau
void setMCDeltaTau(float mcDeltaTau)
Set generated DeltaT.
Definition: TagVertex.cc:220
Belle2::TagVertex::setTagVl
void setTagVl(float TagVl)
Set the tagV component in the boost direction.
Definition: TagVertex.cc:240
Belle2::TagVertex::setTagVertexErrMatrix
void setTagVertexErrMatrix(const TMatrixDSym &TagVertexErrMatrix)
Set BTag Vertex (3x3) error matrix.
Definition: TagVertex.cc:190
Belle2::TagVertex::setConstraintCov
void setConstraintCov(const TMatrixDSym &constraintCov)
Set the covariance matrix of the constraint for the tag fit.
Definition: TagVertex.cc:306
Belle2::TagVertex::setFitType
void setFitType(float FitType)
Set fit algo type.
Definition: TagVertex.cc:230
Belle2::TagVertex::setVertexFitParticles
void setVertexFitParticles(const std::vector< const Particle * > &vtxFitParticles)
Set a vector of pointers to the tracks used in the tag vtx fit.
Definition: TagVertex.cc:285
Belle2::TagVertex::setTagVChi2IP
void setTagVChi2IP(float TagVChi2IP)
Set the IP component of the chi^2 value of the tag vertex fit result.
Definition: TagVertex.cc:280
Belle2::TagVertex::setFitTruthStatus
void setFitTruthStatus(int truthStatus)
Set the status of the fit performed with the truth info of the tracks.
Definition: TagVertex.cc:331
Belle2::analysis::RaveSetup::initialize
static void initialize(int verbosity=1, double MagneticField=1.5)
Set everything up so everything needed for vertex fitting is there.
Definition: RaveSetup.cc:33
Belle2::analysis::RaveSetup::reset
void reset()
frees memory allocated by initialize().
Definition: RaveSetup.cc:58

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ fillParticles()

void fillParticles ( std::vector< ParticleAndWeight > &  particleAndWeights)
private

Fill sorted list of particles into external variable.

Definition at line 650 of file TagVertexModule.cc.

651{
652 unsigned n = particleAndWeights.size();
653 sort(particleAndWeights.begin(), particleAndWeights.end(),
654 [](const ParticleAndWeight & a, const ParticleAndWeight & b) { return a.weight > b.weight; });
655
656 m_raveParticles.resize(n);
657 m_raveWeights.resize(n);
658 m_raveMCParticles.resize(n);
659
660 for (unsigned i = 0; i < n; ++i) {
661 m_raveParticles.at(i) = particleAndWeights.at(i).particle;
662 m_raveMCParticles.at(i) = particleAndWeights.at(i).mcParticle;
663 m_raveWeights.at(i) = particleAndWeights.at(i).weight;
664 }
665}
Belle2::ParticleAndWeight
this struct is used to store and sort the tag tracks
Definition: TagVertexModule.h:288

◆ fillTagVinfo()

void fillTagVinfo ( const ROOT::Math::XYZVector &  tagVpos,
const TMatrixDSym &  tagVposErr 
)
private

Fill tagV vertex info.

Definition at line 667 of file TagVertexModule.cc.

668{
669 m_tagV = tagVpos;
670
671 if (m_constraintType != "noConstraint") {
672 TMatrixDSym tubeInv = m_constraintCov;
673 tubeInv.Invert();
674 TVectorD dV = toVec(m_tagV - m_BeamSpotCenter);
675 m_tagVChi2IP = tubeInv.Similarity(dV);
676 }
677
678 m_tagVErrMatrix.ResizeTo(tagVposErr);
679 m_tagVErrMatrix = tagVposErr;
680}

◆ findConstraint()

pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraint ( const Particle *  Breco,
double  cut 
) const
private

calculate the constraint for the vertex fit on the tag side using Breco information

Definition at line 349 of file TagVertexModule.cc.

350{
351 if (Breco->getPValue() < 0.) return make_pair(vecNaN, matNaN);
352
353 TMatrixDSym beamSpotCov(3);
354 beamSpotCov = m_beamSpotDB->getCovVertex();
355
356 analysis::RaveSetup::getInstance()->setBeamSpot(m_BeamSpotCenter, beamSpotCov);
357
358 double pmag = Breco->getMomentumMagnitude();
359 double xmag = (Breco->getVertex() - m_BeamSpotCenter).R();
360
361
362 TMatrixDSym TerrMatrix = Breco->getMomentumVertexErrorMatrix();
363 TMatrixDSym PerrMatrix(7);
364
365 for (int i = 0; i < 3; ++i) {
366 for (int j = 0; j < 3; ++j) {
367 if (i == j) {
368 PerrMatrix(i, j) = (beamSpotCov(i, j) + TerrMatrix(i, j)) * pmag / xmag;
369 } else {
370 PerrMatrix(i, j) = TerrMatrix(i, j);
371 }
372 PerrMatrix(i + 4, j + 4) = TerrMatrix(i + 4, j + 4);
373 }
374 }
375
376 PerrMatrix(3, 3) = 0.;
377
378 //Copy Breco, but use errors as are in PerrMatrix
379 Particle* Breco2 = ParticleCopy::copyParticle(Breco);
380 Breco2->setMomentumVertexErrorMatrix(PerrMatrix);
381
382
383 const Particle* BRecoRes = doVertexFitForBTube(Breco2, "kalman");
384 if (BRecoRes->getPValue() < 0) return make_pair(vecNaN, matNaN); //problems
385
386 // Overall error matrix
387 TMatrixDSym errFinal = TMatrixDSym(Breco->getVertexErrorMatrix() + BRecoRes->getVertexErrorMatrix());
388
389 // TODO : to be developed the extraction of the momentum from the rave fitted track
390
391 // Get expected pBtag 4-momentum using transverse-momentum conservation
392 ROOT::Math::XYZVector BvertDiff = pmag * (Breco->getVertex() - BRecoRes->getVertex()).Unit();
393 ROOT::Math::PxPyPzMVector pBrecEstimate(BvertDiff.X(), BvertDiff.Y(), BvertDiff.Z(), Breco->getPDGMass());
394 ROOT::Math::PxPyPzMVector pBtagEstimate = PCmsLabTransform::labToCms(pBrecEstimate);
395 pBtagEstimate.SetPxPyPzE(-pBtagEstimate.px(), -pBtagEstimate.py(), -pBtagEstimate.pz(), pBtagEstimate.E());
396 pBtagEstimate = PCmsLabTransform::cmsToLab(pBtagEstimate);
397
398 // rotate err-matrix such that pBrecEstimate goes to eZ
399 TMatrixD TubeZ = rotateTensorInv(pBrecEstimate.Vect(), errFinal);
400
401 TubeZ(2, 2) = cut * cut;
402 TubeZ(2, 0) = 0; TubeZ(0, 2) = 0;
403 TubeZ(2, 1) = 0; TubeZ(1, 2) = 0;
404
405
406 // rotate err-matrix such that eZ goes to pBtagEstimate
407 TMatrixD Tube = rotateTensor(B2Vector3D(pBtagEstimate.Vect()), TubeZ);
408
409 // Standard algorithm needs no shift
410 return make_pair(m_BeamSpotCenter, toSymMatrix(Tube));
411}
Belle2::PCmsLabTransform::labToCms
static ROOT::Math::PxPyPzMVector labToCms(const ROOT::Math::PxPyPzMVector &vec)
Transforms Lorentz vector into CM System.
Definition: PCmsLabTransform.cc:13
Belle2::PCmsLabTransform::cmsToLab
static ROOT::Math::PxPyPzMVector cmsToLab(const ROOT::Math::PxPyPzMVector &vec)
Transforms Lorentz vector into Laboratory System.
Definition: PCmsLabTransform.cc:19
Belle2::Particle::getPValue
double getPValue() const
Returns chi^2 probability of fit if done or -1.
Definition: Particle.h:667
Belle2::Particle::getPDGMass
double getPDGMass(void) const
Returns uncertainty on the invariant mass (requires valid momentum error matrix)
Definition: Particle.cc:604
Belle2::Particle::setMomentumVertexErrorMatrix
void setMomentumVertexErrorMatrix(const TMatrixFSym &errMatrix)
Sets 7x7 error matrix.
Definition: Particle.cc:393
Belle2::Particle::getMomentumVertexErrorMatrix
TMatrixFSym getMomentumVertexErrorMatrix() const
Returns 7x7 error matrix.
Definition: Particle.cc:420
Belle2::Particle::getMomentumMagnitude
double getMomentumMagnitude() const
Returns momentum magnitude.
Definition: Particle.h:569
Belle2::TagVertexModule::doVertexFitForBTube
Particle * doVertexFitForBTube(const Particle *mother, std::string fitType) const
it returns an intersection between B rec and beam spot (= origin of BTube)
Definition: TagVertexModule.cc:934
Belle2::Unit
The Unit class.
Definition: Unit.h:40

◆ findConstraintBoost()

pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraintBoost ( double  cut) const
private

calculate the standard constraint for the vertex fit on the tag side

Definition at line 497 of file TagVertexModule.cc.

498{
499 double d = 20e-4; //average transverse distance flown by B0
500
501 //make a long error matrix along boost direction
502 TMatrixD longerror(3, 3); longerror(2, 2) = cut * cut;
503 longerror(0, 0) = longerror(1, 1) = d * d;
504
505 B2Vector3D boostDir = PCmsLabTransform().getBoostVector().Unit();
506
507 TMatrixD longerrorRotated = rotateTensor(boostDir, longerror);
508
509 //Extend error of BeamSpotCov matrix in the boost direction
510 TMatrixDSym beamSpotCov = m_beamSpotDB->getCovVertex();
511 TMatrixD Tube = TMatrixD(beamSpotCov) + longerrorRotated;
512
513 // Standard algorithm needs no shift
514 ROOT::Math::XYZVector constraintCenter = m_BeamSpotCenter;
515
516 return make_pair(constraintCenter, toSymMatrix(Tube));
517}

◆ findConstraintBTube()

pair< ROOT::Math::XYZVector, TMatrixDSym > findConstraintBTube ( const Particle *  Breco,
double  cut 
)
private

calculate constraint for the vertex fit on the tag side using the B tube (cylinder along the expected BTag line of flights

Definition at line 413 of file TagVertexModule.cc.

414{
415 //Use Breco as the creator of the B tube.
416 if ((Breco->getVertexErrorMatrix()(2, 2)) == 0.0) {
417 B2WARNING("In TagVertexModule::findConstraintBTube: cannot get a proper vertex for BReco. BTube constraint replaced by Boost.");
418 return findConstraintBoost(cut);
419 }
420
421
422 //vertex fit will give the intersection between the beam spot and the trajectory of the B
423 //(base of the BTube, or primary vtx cov matrix)
424 const Particle* tubecreatorBCopy = doVertexFitForBTube(Breco, "avf");
425 if (tubecreatorBCopy->getPValue() < 0) return make_pair(vecNaN, matNaN); //if problems
426
427
428 //get direction of B tag = opposite direction of B rec in CMF
429 ROOT::Math::PxPyPzEVector pBrec = tubecreatorBCopy->get4Vector();
430
431 //if we want the true info, replace the 4vector by the true one
432 if (m_useTruthInFit) {
433 const MCParticle* mcBr = Breco->getRelated<MCParticle>();
434 if (mcBr)
435 pBrec = mcBr->get4Vector();
436 else
437 m_fitTruthStatus = 2;
438 }
439 ROOT::Math::PxPyPzEVector pBtag = PCmsLabTransform::labToCms(pBrec);
440 pBtag.SetPxPyPzE(-pBtag.px(), -pBtag.py(), -pBtag.pz(), pBtag.E());
441 pBtag = PCmsLabTransform::cmsToLab(pBtag);
442
443 //To create the B tube, strategy is: take the primary vtx cov matrix, and add to it a cov
444 //matrix corresponding to an very big error in the direction of the B tag
445 TMatrixDSym pv = tubecreatorBCopy->getVertexErrorMatrix();
446
447 //print some stuff if wanted
448 if (m_verbose) {
449 B2DEBUG(10, "Brec decay vertex before fit: " << printVector(Breco->getVertex()));
450 B2DEBUG(10, "Brec decay vertex after fit: " << printVector(tubecreatorBCopy->getVertex()));
451 B2DEBUG(10, "Brec direction before fit: " << printVector(float(1. / Breco->getP()) * Breco->getMomentum()));
452 B2DEBUG(10, "Brec direction after fit: " << printVector(float(1. / tubecreatorBCopy->getP()) * tubecreatorBCopy->getMomentum()));
453 B2DEBUG(10, "IP position: " << printVector(ROOT::Math::XYZVector(m_BeamSpotCenter.X(), m_BeamSpotCenter.Y(),
454 m_BeamSpotCenter.Z())));
455 B2DEBUG(10, "IP covariance: " << printMatrix(m_BeamSpotCov));
456 B2DEBUG(10, "Brec primary vertex: " << printVector(tubecreatorBCopy->getVertex()));
457 B2DEBUG(10, "Brec PV covariance: " << printMatrix(pv));
458 B2DEBUG(10, "BTag direction: " << printVector((1. / pBtag.P())*pBtag.Vect()));
459 }
460
461 //make a long error matrix along BTag direction
462 TMatrixD longerror(3, 3); longerror(2, 2) = cut * cut;
463
464
465 // make rotation matrix from z axis to BTag line of flight
466 TMatrixD longerrorRotated = rotateTensor(B2Vector3D(pBtag.Vect()), longerror);
467
468 //pvNew will correspond to the covariance matrix of the B tube
469 TMatrixD pvNew = TMatrixD(pv) + longerrorRotated;
470
471 //set the constraint
472 ROOT::Math::XYZVector constraintCenter = tubecreatorBCopy->getVertex();
473
474 //if we want the true info, set the centre of the constraint to the primary vertex
475 if (m_useTruthInFit) {
476 const MCParticle* mcBr = Breco->getRelated<MCParticle>();
477 if (mcBr) {
478 constraintCenter = mcBr->getProductionVertex();
479 }
480 }
481
482 if (m_verbose) {
483 B2DEBUG(10, "IPTube covariance: " << printMatrix(pvNew));
484 }
485
486 //The following is done to do the BTube constraint with a virtual track
487 //(ie KFit way)
488
489 m_tagMomentum = pBtag;
490
491 m_pvCov.ResizeTo(pv);
492 m_pvCov = pv;
493
494 return make_pair(constraintCenter, toSymMatrix(pvNew));
495}
Belle2::MCParticle::getProductionVertex
ROOT::Math::XYZVector getProductionVertex() const
Return production vertex position.
Definition: MCParticle.h:189
Belle2::MCParticle::get4Vector
ROOT::Math::PxPyPzEVector get4Vector() const
Return 4Vector of particle.
Definition: MCParticle.h:207
Belle2::Particle::get4Vector
ROOT::Math::PxPyPzEVector get4Vector() const
Returns Lorentz vector.
Definition: Particle.h:547
Belle2::Particle::getMomentum
ROOT::Math::XYZVector getMomentum() const
Returns momentum vector.
Definition: Particle.h:560
Belle2::Particle::getP
double getP() const
Returns momentum magnitude (same as getMomentumMagnitude but with shorter name)
Definition: Particle.h:578
Belle2::TagVertexModule::printVector
static std::string printVector(const ROOT::Math::XYZVector &vec)
Print a XYZVector (useful for debugging)
Definition: TagVertexModule.cc:1047
Belle2::TagVertexModule::printMatrix
static std::string printMatrix(const TMatrixD &mat)
Print a TMatrix (useful for debugging)
Definition: TagVertexModule.cc:1056

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getBeamSpot()

const BeamSpot & getBeamSpot ( ) const
inline

returns the BeamSpot object

Definition at line 90 of file TagVertexModule.h.

90{ return *m_beamSpotDB; }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

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

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

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

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getParticlesAndWeights()

vector< ParticleAndWeight > getParticlesAndWeights ( const std::vector< const Particle * > &  tagParticles) const
private

Get a list of particles with attached weight and associated MC particle.

Definition at line 621 of file TagVertexModule.cc.

622{
623 vector<ParticleAndWeight> particleAndWeights;
624
625 for (const Particle* particle : tagParticles) {
626 ROOT::Math::PxPyPzEVector mom = particle->get4Vector();
627 if (!isfinite(mom.mag2())) continue;
628
629 ParticleAndWeight particleAndWeight;
630 particleAndWeight.mcParticle = 0;
631 particleAndWeight.weight = -1111.;
632 particleAndWeight.particle = particle;
633
634 if (m_useMCassociation == "breco" || m_useMCassociation == "internal")
635 particleAndWeight.mcParticle = particle->getRelatedTo<MCParticle>();
636
637 particleAndWeights.push_back(particleAndWeight);
638 }
639
640 return particleAndWeights;
641}
Belle2::ParticleAndWeight::particle
const Particle * particle
tag track fit result with pion mass hypo, for sorting purposes
Definition: TagVertexModule.h:290
Belle2::ParticleAndWeight::mcParticle
const MCParticle * mcParticle
mc particle matched to the tag track, for sorting purposes
Definition: TagVertexModule.h:291
Belle2::ParticleAndWeight::weight
double weight
rave weight associated to the track, for sorting purposes
Definition: TagVertexModule.h:289

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getRollBackPoca()

ROOT::Math::XYZVector getRollBackPoca ( ParticleAndWeight const &  paw)
private

This shifts the position of tracks by the vector difference of mother B and production point of track from truth info.

Definition at line 1001 of file TagVertexModule.cc.

1002{
1003 if (!paw.mcParticle) {
1004 B2ERROR("In TagVertexModule::getTruePoca: no MC particle set");
1005 return ROOT::Math::XYZVector(0., 0., 0.);
1006 }
1007
1008 return paw.particle->getTrackFitResult()->getPosition() - paw.mcParticle->getProductionVertex() + ROOT::Math::XYZVector(m_mcTagV);
1009}

◆ getTagTracks_standardAlgorithm()

std::vector< const Particle * > getTagTracks_standardAlgorithm ( const Particle *  Breco,
int  nPXDHits 
) const
private

performs the fit using the standard algorithm - using all tracks in RoE The user can specify a request on the PXD hits left by the tracks

Definition at line 601 of file TagVertexModule.cc.

602{
603 std::vector<const Particle*> fitParticles;
604 const RestOfEvent* roe = Breco->getRelatedTo<RestOfEvent>();
605 if (!roe) return fitParticles;
606 //load all particles from the ROE
607 std::vector<const Particle*> ROEParticles = roe->getChargedParticles(m_roeMaskName, 0, false);
608 if (ROEParticles.size() == 0) return fitParticles;
609
610 for (auto& ROEParticle : ROEParticles) {
611 HitPatternVXD roeTrackPattern = ROEParticle->getTrackFitResult()->getHitPatternVXD();
612
613 if (roeTrackPattern.getNPXDHits() >= reqPXDHits) {
614 fitParticles.push_back(ROEParticle);
615 }
616 }
617 return fitParticles;
618}
Belle2::HitPatternVXD
Hit pattern of the VXD within a track.
Definition: HitPatternVXD.h:37
Belle2::HitPatternVXD::getNPXDHits
unsigned short getNPXDHits() const
Get total number of hits in the PXD.
Definition: HitPatternVXD.cc:147
Belle2::RestOfEvent::getChargedParticles
std::vector< const Particle * > getChargedParticles(const std::string &maskName=c_defaultMaskName, unsigned int pdg=0, bool unpackComposite=true) const
Get charged particles from ROE mask.
Definition: RestOfEvent.cc:108

◆ getTrackWithRollBackCoordinates()

TrackFitResult getTrackWithRollBackCoordinates ( ParticleAndWeight const &  paw)
private

If the fit has to be done with the rolled back tracks, Rave or KFit is fed with a track where the position of track is shifted by the vector difference of mother B and production point of track from truth info The function below takes care of that.

Definition at line 988 of file TagVertexModule.cc.

989{
990 const TrackFitResult* tfr(paw.particle->getTrackFitResult());
991
992 return TrackFitResult(getRollBackPoca(paw),
993 tfr->getMomentum(),
994 tfr->getCovariance6(),
995 tfr->getChargeSign(),
996 tfr->getParticleType(),
997 tfr->getPValue(),
998 m_Bfield, 0, 0, tfr->getNDF());
999}
Belle2::TrackFitResult
Values of the result of a track fit with a given particle hypothesis.
Definition: TrackFitResult.h:49

◆ getTrackWithTrueCoordinates()

TrackFitResult getTrackWithTrueCoordinates ( ParticleAndWeight const &  paw) const
private

If the fit has to be done with the truth info, Rave is fed with a track where the momentum is replaced by the true momentum and the position replaced by the point on the true particle trajectory closest to the measured track position The function below takes care of that.

Definition at line 957 of file TagVertexModule.cc.

958{
959 if (!paw.mcParticle) {
960 B2ERROR("In TagVertexModule::getTrackWithTrueCoordinate: no MC particle set");
961 return TrackFitResult();
962 }
963
964 const TrackFitResult* tfr(paw.particle->getTrackFitResult());
965
966 return TrackFitResult(getTruePoca(paw),
967 paw.mcParticle->getMomentum(),
968 tfr->getCovariance6(),
969 tfr->getChargeSign(),
970 tfr->getParticleType(),
971 tfr->getPValue(),
972 m_Bfield, 0, 0, tfr->getNDF());
973}

◆ getTruePoca()

ROOT::Math::XYZVector getTruePoca ( ParticleAndWeight const &  paw)
staticprivate

This finds the point on the true particle trajectory closest to the measured track position.

Definition at line 976 of file TagVertexModule.cc.

977{
978 if (!paw.mcParticle) {
979 B2ERROR("In TagVertexModule::getTruePoca: no MC particle set");
980 return ROOT::Math::XYZVector(0., 0., 0.);
981 }
982
983 return DistanceTools::poca(paw.mcParticle->getProductionVertex(),
984 paw.mcParticle->getMomentum(),
985 paw.particle->getTrackFitResult()->getPosition());
986}
Belle2::DistanceTools::poca
ROOT::Math::XYZVector poca(ROOT::Math::XYZVector const &trackPos, ROOT::Math::XYZVector const &trackP, ROOT::Math::XYZVector const &vtxPos)
Returns the Point Of Closest Approach of a track to a vertex.
Definition: DistanceTools.cc:17

◆ 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}
Belle2::Module::m_type
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

167{
168 auto missing = m_moduleParamList.getUnsetForcedParams();
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}
Belle2::ModuleParamList::getUnsetForcedParams
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.
Definition: ModuleParamList.cc:54

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

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

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

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( )
overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 120 of file TagVertexModule.cc.

121{
122 // magnetic field
123 m_Bfield = BFieldManager::getFieldInTesla(ROOT::Math::XYZVector(m_BeamSpotCenter)).Z();
124 // RAVE setup
125 analysis::RaveSetup::initialize(1, m_Bfield);
126 B2INFO("TagVertexModule : magnetic field = " << m_Bfield);
127 // truth fit status will be set to 2 only if the MC info cannot be recovered
128 if (m_useTruthInFit) m_fitTruthStatus = 1;
129 // roll back status will be set to 2 only if the MC info cannot be recovered
130 if (m_useRollBack) m_rollbackStatus = 1;
131
132 //input
133 StoreArray<Particle>().isRequired();
134 m_plist.isRequired(m_listName);
135 // output
136 m_verArray.registerInDataStore();
137 StoreArray<Particle>().registerRelationTo(m_verArray);
138 //check if the fitting algorithm name is set correctly
139 if (m_fitAlgo != "Rave" && m_fitAlgo != "KFit")
140 B2FATAL("TagVertexModule: invalid fitting algorithm (must be set to either Rave or KFit).");
141 if (m_useRollBack && m_useTruthInFit)
142 B2FATAL("TagVertexModule: invalid fitting option (useRollBack and useTruthInFit cannot be simultaneously set to true).");
143 //temporary while the one track fit is broken
144 if (m_trackFindingType == "singleTrack" || m_trackFindingType == "singleTrack_PXD")
145 B2FATAL("TagVertexModule : the singleTrack option is temporarily broken.");
146}
Belle2::BFieldManager::getFieldInTesla
static ROOT::Math::XYZVector getFieldInTesla(const ROOT::Math::XYZVector &pos)
return the magnetic field at a given position in Tesla.
Definition: BFieldManager.h:61
Belle2::StoreAccessorBase::isRequired
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
Definition: StoreAccessorBase.h:78
Belle2::StoreArray
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113
Belle2::StoreArray::registerRelationTo
bool registerRelationTo(const StoreArray< TO > &toArray, DataStore::EDurability durability=DataStore::c_Event, DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut, const std::string &namedRelation="") const
Register a relation to the given StoreArray.
Definition: StoreArray.h:140

◆ makeGeneralFit()

bool makeGeneralFit ( )
private

TO DO: tag side vertex fit in the case of semileptonic tag side decay.

make the vertex fit on the tag side with chosen fit algorithm

Definition at line 643 of file TagVertexModule.cc.

644{
645 if (m_fitAlgo == "Rave") return makeGeneralFitRave();
646 else if (m_fitAlgo == "KFit") return makeGeneralFitKFit();
647 return false;
648}
Belle2::TagVertexModule::makeGeneralFitRave
bool makeGeneralFitRave()
make the vertex fit on the tag side: RAVE AVF tracks coming from Ks removed all other tracks used
Definition: TagVertexModule.cc:682
Belle2::TagVertexModule::makeGeneralFitKFit
bool makeGeneralFitKFit()
make the vertex fit on the tag side: KFit tracks coming from Ks removed all other tracks used
Definition: TagVertexModule.cc:838

◆ makeGeneralFitKFit()

bool makeGeneralFitKFit ( )
private

make the vertex fit on the tag side: KFit tracks coming from Ks removed all other tracks used

Definition at line 838 of file TagVertexModule.cc.

839{
840 //feed KFit with tracks without Kshorts
841 vector<ParticleAndWeight> particleAndWeights = getParticlesAndWeights(m_tagParticles);
842
843 analysis::VertexFitKFit kFit;
844
845
846 // iterative procedure which removes tracks with high chi2
847 for (int iteration_counter = 0; iteration_counter < 100; ++iteration_counter) {
848 analysis::VertexFitKFit kFitTemp = doSingleKfit(particleAndWeights);
849 if (!kFitTemp.isFitted() || isnan(kFitTemp.getCHIsq()))
850 return false;
851
852 double reduced_chi2 = kFitTemp.getCHIsq() / kFitTemp.getNDF();
853 int nTracks = kFitTemp.getTrackCount();
854
855 if (nTracks != int(particleAndWeights.size()))
856 B2ERROR("TagVertexModule: Different number of tracks in kFit and particles");
857
858 if (reduced_chi2 <= m_kFitReqReducedChi2 || nTracks <= 1 || (nTracks <= 2 && m_constraintType == "noConstraint")) {
859 kFit = kFitTemp;
860 break;
861 } else { // remove particle with highest chi2/ndf and continue
862 int badTrackID = getLargestChi2ID(kFitTemp);
863 if (0 <= badTrackID && badTrackID < int(particleAndWeights.size()))
864 particleAndWeights.erase(particleAndWeights.begin() + badTrackID);
865 else
866 B2ERROR("TagVertexModule: Obtained badTrackID is not within limits");
867 }
868
869 }
870
871 //save the track info for later use
872 //Tracks are sorted by weight, i.e. pushing the tracks with 0 weight (from KS) to the end of the list
873 fillParticles(particleAndWeights);
874
875 //Save the infos related to the vertex
876 fillTagVinfo(CLHEPToROOT::getXYZVector(kFit.getVertex()),
877 CLHEPToROOT::getTMatrixDSym(kFit.getVertexError()));
878
879 m_tagVNDF = kFit.getNDF();
880 m_tagVChi2 = kFit.getCHIsq();
881 m_fitPval = TMath::Prob(m_tagVChi2, m_tagVNDF);
882
883 return true;
884}
Belle2::TagVertexModule::fillTagVinfo
void fillTagVinfo(const ROOT::Math::XYZVector &tagVpos, const TMatrixDSym &tagVposErr)
Fill tagV vertex info.
Definition: TagVertexModule.cc:667
Belle2::TagVertexModule::getParticlesAndWeights
std::vector< ParticleAndWeight > getParticlesAndWeights(const std::vector< const Particle * > &tagParticles) const
Get a list of particles with attached weight and associated MC particle.
Definition: TagVertexModule.cc:621
Belle2::TagVertexModule::fillParticles
void fillParticles(std::vector< ParticleAndWeight > &particleAndWeights)
Fill sorted list of particles into external variable.
Definition: TagVertexModule.cc:650
Belle2::TagVertexModule::doSingleKfit
analysis::VertexFitKFit doSingleKfit(std::vector< ParticleAndWeight > &particleAndWeights)
performs single KFit on particles stored in particleAndWeights this function can be iterated several ...
Definition: TagVertexModule.cc:749
Belle2::analysis::KFitBase::getNDF
virtual int getNDF(void) const
Get an NDF of the fit.
Definition: KFitBase.cc:114
Belle2::analysis::KFitBase::isFitted
bool isFitted(void) const
Return false if fit is not performed yet or performed fit is failed; otherwise true.
Definition: KFitBase.cc:728
Belle2::analysis::KFitBase::getTrackCount
int getTrackCount(void) const
Get the number of added tracks.
Definition: KFitBase.cc:107
Belle2::analysis::VertexFitKFit::getCHIsq
double getCHIsq(void) const override
Get a chi-square of the fit.
Definition: VertexFitKFit.cc:139

◆ makeGeneralFitRave()

bool makeGeneralFitRave ( )
private

make the vertex fit on the tag side: RAVE AVF tracks coming from Ks removed all other tracks used

Definition at line 682 of file TagVertexModule.cc.

683{
684 // apply constraint
685 analysis::RaveSetup::getInstance()->unsetBeamSpot();
686 if (m_constraintType != "noConstraint")
687 analysis::RaveSetup::getInstance()->setBeamSpot(m_constraintCenter, m_constraintCov);
688 analysis::RaveVertexFitter rFit;
689
690 //feed rave with tracks without Kshorts
691 vector<ParticleAndWeight> particleAndWeights = getParticlesAndWeights(m_tagParticles);
692
693 for (const auto& pw : particleAndWeights) {
694 try {
695 if (m_useTruthInFit) {
696 if (pw.mcParticle) {
697 TrackFitResult tfr(getTrackWithTrueCoordinates(pw));
698 rFit.addTrack(&tfr);
699 } else
700 m_fitTruthStatus = 2;
701 } else if (m_useRollBack) {
702 if (pw.mcParticle) {
703 TrackFitResult tfr(getTrackWithRollBackCoordinates(pw));
704 rFit.addTrack(&tfr);
705 } else
706 m_rollbackStatus = 2;
707 } else {
708 rFit.addTrack(pw.particle->getTrackFitResult());
709 }
710 } catch (const rave::CheckedFloatException&) {
711 B2ERROR("Exception caught in TagVertexModule::makeGeneralFitRave(): Invalid inputs (nan/inf)?");
712 }
713 }
714
715 //perform fit
716
717 int isGoodFit(-1);
718
719 try {
720 isGoodFit = rFit.fit("avf");
721 // if problems
722 if (isGoodFit < 1) return false;
723 } catch (const rave::CheckedFloatException&) {
724 B2ERROR("Exception caught in TagVertexModule::makeGeneralFitRave(): Invalid inputs (nan/inf)?");
725 return false;
726 }
727
728 //save the track info for later use
729
730 for (unsigned int i(0); i < particleAndWeights.size() && isGoodFit >= 1; ++i)
731 particleAndWeights.at(i).weight = rFit.getWeight(i);
732
733 //Tracks are sorted from highest rave weight to lowest
734
735 fillParticles(particleAndWeights);
736
737 //if the fit is good, save the infos related to the vertex
738 fillTagVinfo(ROOT::Math::XYZVector(rFit.getPos(0)), rFit.getCov(0));
739
740 //fill quality variables
741 m_tagVNDF = rFit.getNdf(0);
742 m_tagVChi2 = rFit.getChi2(0);
743 m_fitPval = rFit.getPValue();
744
745 return true;
746}
Belle2::TagVertexModule::getTrackWithRollBackCoordinates
TrackFitResult getTrackWithRollBackCoordinates(ParticleAndWeight const &paw)
If the fit has to be done with the rolled back tracks, Rave or KFit is fed with a track where the pos...
Definition: TagVertexModule.cc:988
Belle2::TagVertexModule::getTrackWithTrueCoordinates
TrackFitResult getTrackWithTrueCoordinates(ParticleAndWeight const &paw) const
If the fit has to be done with the truth info, Rave is fed with a track where the momentum is replace...
Definition: TagVertexModule.cc:957
Belle2::analysis::RaveSetup::unsetBeamSpot
void unsetBeamSpot()
unset beam spot constraint
Definition: RaveSetup.cc:80
Belle2::analysis::RaveVertexFitter::getCov
TMatrixDSym getCov(VecSize vertexId=0) const
get the covariance matrix (3x3) of the of the fitted vertex position.
Definition: RaveVertexFitter.cc:230
Belle2::analysis::RaveVertexFitter::getNdf
double getNdf(VecSize vertexId=0) const
get the number of degrees of freedom (NDF) of the fitted vertex.
Definition: RaveVertexFitter.cc:214
Belle2::analysis::RaveVertexFitter::getChi2
double getChi2(VecSize vertexId=0) const
get the χ² of the fitted vertex.
Definition: RaveVertexFitter.cc:222
Belle2::analysis::RaveVertexFitter::getPos
B2Vector3D getPos(VecSize vertexId=0) const
get the position of the fitted vertex.
Definition: RaveVertexFitter.cc:169
Belle2::analysis::RaveVertexFitter::getWeight
double getWeight(int trackId, VecSize vertexId=0) const
get the weight Rave assigned to a specific input track.
Definition: RaveVertexFitter.cc:178
Belle2::analysis::RaveVertexFitter::getPValue
double getPValue(VecSize vertexId=0) const
get the p value of the fitted vertex.
Definition: RaveVertexFitter.cc:206

◆ printMatrix() [1/2]

std::string printMatrix ( const TMatrixD &  mat)
staticprivate

Print a TMatrix (useful for debugging)

Definition at line 1056 of file TagVertexModule.cc.

1057{
1058 std::ostringstream oss;
1059 int w = 14;
1060 for (int i = 0; i < mat.GetNrows(); ++i) {
1061 for (int j = 0; j < mat.GetNcols(); ++j) {
1062 oss << std::setw(w) << mat(i, j) << " ";
1063 }
1064 oss << endl;
1065 }
1066 return oss.str();
1067}

◆ printMatrix() [2/2]

std::string printMatrix ( const TMatrixDSym &  mat)
staticprivate

Print a TMatrixFSym (useful for debugging)

Definition at line 1070 of file TagVertexModule.cc.

1071{
1072 std::ostringstream oss;
1073 int w = 14;
1074 for (int i = 0; i < mat.GetNrows(); ++i) {
1075 for (int j = 0; j < mat.GetNcols(); ++j) {
1076 oss << std::setw(w) << mat(i, j) << " ";
1077 }
1078 oss << endl;
1079 }
1080 return oss.str();
1081}

◆ printVector()

std::string printVector ( const ROOT::Math::XYZVector &  vec)
staticprivate

Print a XYZVector (useful for debugging)

Definition at line 1047 of file TagVertexModule.cc.

1048{
1049 std::ostringstream oss;
1050 int w = 14;
1051 oss << "(" << std::setw(w) << vec.X() << ", " << std::setw(w) << vec.Y() << ", " << std::setw(w) << vec.Z() << ")" << std::endl;
1052 return oss.str();
1053}

◆ resetReturnParams()

void resetReturnParams ( )
private

Reset all parameters that are computed in each event and then used to compute tuple variables.

Definition at line 1011 of file TagVertexModule.cc.

1012{
1013 m_raveParticles.resize(0);
1014 m_raveMCParticles.resize(0);
1015 m_tagParticles.resize(0);
1016 m_raveWeights.resize(0);
1017
1018 m_fitPval = realNaN;
1019 m_tagV = vecNaN;
1020 m_tagVErrMatrix.ResizeTo(matNaN);
1021 m_tagVErrMatrix = matNaN;
1022 m_mcTagV = vecNaN;
1023 m_mcVertReco = vecNaN;
1024 m_deltaT = realNaN;
1025 m_deltaTErr = realNaN;
1026 m_mcDeltaTau = realNaN;
1027 m_constraintCov.ResizeTo(matNaN);
1028 m_constraintCov = matNaN;
1029 m_constraintCenter = vecNaN;
1030 m_tagVl = realNaN;
1031 m_truthTagVl = realNaN;
1032 m_tagVlErr = realNaN;
1033 m_tagVol = realNaN;
1034 m_truthTagVol = realNaN;
1035 m_tagVolErr = realNaN;
1036 m_tagVNDF = realNaN;
1037 m_tagVChi2 = realNaN;
1038 m_tagVChi2IP = realNaN;
1039 m_pvCov.ResizeTo(matNaN);
1040 m_pvCov = matNaN;
1041 m_tagMomentum = ROOT::Math::PxPyPzEVector(realNaN, realNaN, realNaN, realNaN);
1042}

◆ 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}
Belle2::LogConfig::ELogLevel
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
Belle2::LogConfig::setAbortLevel
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ 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}
Belle2::LogConfig::setDebugLevel
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig &  logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
Belle2::LogConfig::setLogInfo
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}
Belle2::LogConfig::setLogLevel
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

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

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList &  params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
239 m_moduleParamList.setParamPython(name, pyObj);
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}
Belle2::LogSystem
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
Belle2::LogSystem::updateModule
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
Belle2::LogSystem::Instance
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
Belle2::ModuleParamList::setParamPython
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.
Definition: ModuleParamList.templateDetails.h:104

◆ 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}
Belle2::Module::setParamPython
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}

◆ terminate()

virtual void terminate ( )
inlinevirtualinherited

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

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

This method can be implemented by subclasses.

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

Definition at line 176 of file Module.h.

176{};

Member Data Documentation

◆ m_BeamSpotCenter

ROOT::Math::XYZVector m_BeamSpotCenter
private

Beam spot position.

Definition at line 137 of file TagVertexModule.h.

◆ m_BeamSpotCov

TMatrixDSym m_BeamSpotCov
private

size of the beam spot == covariance matrix on the beam spot position

Definition at line 138 of file TagVertexModule.h.

◆ m_beamSpotDB

DBObjPtr<BeamSpot> m_beamSpotDB
private

Beam spot database object.

Definition at line 140 of file TagVertexModule.h.

◆ m_Bfield

double m_Bfield
private

magnetic field from data base

Definition at line 107 of file TagVertexModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_confidenceLevel

double m_confidenceLevel
private

required fit confidence level

Definition at line 100 of file TagVertexModule.h.

◆ m_constraintCenter

ROOT::Math::XYZVector m_constraintCenter
private

centre position of the constraint for the tag Vertex fit

Definition at line 136 of file TagVertexModule.h.

◆ m_constraintCov

TMatrixDSym m_constraintCov
private

constraint to be used in the tag vertex fit

Definition at line 135 of file TagVertexModule.h.

◆ m_constraintType

std::string m_constraintType
private

Choose constraint: noConstraint, IP, tube, boost, (breco)

Definition at line 103 of file TagVertexModule.h.

◆ m_deltaT

double m_deltaT
private

reconstructed DeltaT

Definition at line 131 of file TagVertexModule.h.

◆ m_deltaTErr

double m_deltaTErr
private

reconstructed DeltaT error

Definition at line 132 of file TagVertexModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_fitAlgo

std::string m_fitAlgo
private

Algorithm used for the tag fit (Rave or KFit)

Definition at line 151 of file TagVertexModule.h.

◆ m_fitPval

double m_fitPval
private

P value of the tag side fit result.

Definition at line 123 of file TagVertexModule.h.

◆ m_fitTruthStatus

int m_fitTruthStatus
private

Store info about whether the fit was performed with the truth info 0 fit performed with measured parameters 1 fit performed with true parameters 2 unable to recover truth parameters.

Definition at line 114 of file TagVertexModule.h.

◆ m_FitType

int m_FitType
private

fit algo used

Definition at line 141 of file TagVertexModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_kFitReqReducedChi2

double m_kFitReqReducedChi2
private

The required chi2/ndf to accept the kFit result, if it is higher, iteration procedure is applied.

Definition at line 152 of file TagVertexModule.h.

◆ m_listName

std::string m_listName
private

Breco particle list name.

Definition at line 99 of file TagVertexModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_mcDeltaT

double m_mcDeltaT
private

generated DeltaT with boost-direction approximation

Definition at line 134 of file TagVertexModule.h.

◆ m_mcDeltaTau

double m_mcDeltaTau
private

generated DeltaT

Definition at line 133 of file TagVertexModule.h.

◆ m_mcInfo

bool m_mcInfo
private

true if user wants to retrieve MC information out from the tracks used in the fit

Definition at line 139 of file TagVertexModule.h.

◆ m_mcLifeTimeReco

double m_mcLifeTimeReco
private

generated Breco life time

Definition at line 130 of file TagVertexModule.h.

◆ m_mcParticles

StoreArray<MCParticle> m_mcParticles
private

StoreArray of MCParticles.

Definition at line 96 of file TagVertexModule.h.

◆ m_mcPDG

int m_mcPDG
private

generated tag side B flavor

Definition at line 128 of file TagVertexModule.h.

◆ m_mcTagLifeTime

double m_mcTagLifeTime
private

generated tag side life time of B-decay

Definition at line 127 of file TagVertexModule.h.

◆ m_mcTagV

ROOT::Math::XYZVector m_mcTagV
private

generated tag side vertex

Definition at line 126 of file TagVertexModule.h.

◆ m_mcVertReco

ROOT::Math::XYZVector m_mcVertReco
private

generated Breco decay vertex

Definition at line 129 of file TagVertexModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 510 of file Module.h.

◆ m_plist

StoreObjPtr<ParticleList> m_plist
private

input particle list

Definition at line 97 of file TagVertexModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

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

Definition at line 512 of file Module.h.

◆ m_pvCov

TMatrixDSym m_pvCov
private

covariance matrix of the PV (useful with tube and KFit)

Definition at line 154 of file TagVertexModule.h.

◆ m_raveMCParticles

std::vector<const MCParticle*> m_raveMCParticles
private

Store the MC particles corresponding to each track used by Rave in the vtx fit.

Definition at line 112 of file TagVertexModule.h.

◆ m_raveParticles

std::vector<const Particle*> m_raveParticles
private

tracks given to rave for the track fit (after removing Kshorts

Definition at line 109 of file TagVertexModule.h.

◆ m_raveWeights

std::vector<double> m_raveWeights
private

Store the weights used by Rave in the vtx fit so that they can be accessed later.

Definition at line 110 of file TagVertexModule.h.

◆ m_reqPXDHits

int m_reqPXDHits
private

N of PXD hits for a track to be used.

Definition at line 105 of file TagVertexModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_roeMaskName

std::string m_roeMaskName
private

ROE particles from this mask will be used for vertex fitting.

Definition at line 106 of file TagVertexModule.h.

◆ m_rollbackStatus

int m_rollbackStatus
private

Store info about whether the fit was performed with the rolled back tracks 0 fit performed with measured parameters 1 fit performed with rolled back parameters 2 unable to recover truth parameters.

Definition at line 119 of file TagVertexModule.h.

◆ m_tagMomentum

ROOT::Math::PxPyPzEVector m_tagMomentum
private

B tag momentum computed from fully reconstructed B sig.

Definition at line 155 of file TagVertexModule.h.

◆ m_tagParticles

std::vector<const Particle*> m_tagParticles
private

tracks of the rest of the event

Definition at line 108 of file TagVertexModule.h.

◆ m_tagV

ROOT::Math::XYZVector m_tagV
private

tag side fit result

Definition at line 124 of file TagVertexModule.h.

◆ m_tagVChi2

double m_tagVChi2
private

chi^2 value of the tag vertex fit result

Definition at line 149 of file TagVertexModule.h.

◆ m_tagVChi2IP

double m_tagVChi2IP
private

IP component of the chi^2 of the tag vertex fit result.

Definition at line 150 of file TagVertexModule.h.

◆ m_tagVErrMatrix

TMatrixDSym m_tagVErrMatrix
private

Error matrix of the tag side fit result.

Definition at line 125 of file TagVertexModule.h.

◆ m_tagVl

double m_tagVl
private

tagV component in the boost direction

Definition at line 142 of file TagVertexModule.h.

◆ m_tagVlErr

double m_tagVlErr
private

Error of the tagV component in the boost direction

Definition at line 144 of file TagVertexModule.h.

◆ m_tagVNDF

double m_tagVNDF
private

Number of degrees of freedom in the tag vertex fit.

Definition at line 148 of file TagVertexModule.h.

◆ m_tagVol

double m_tagVol
private

tagV component in the direction orthogonal to the boost

Definition at line 145 of file TagVertexModule.h.

◆ m_tagVolErr

double m_tagVolErr
private

Error of the tagV component in the direction orthogonal to the boost.

Definition at line 147 of file TagVertexModule.h.

◆ m_trackFindingType

std::string m_trackFindingType
private

Choose how to find the tag tracks: standard, standard_PXD.

Definition at line 104 of file TagVertexModule.h.

◆ m_truthTagVl

double m_truthTagVl
private

MC tagV component in the boost direction

Definition at line 143 of file TagVertexModule.h.

◆ m_truthTagVol

double m_truthTagVol
private

MC tagV component in the direction orthogonal to the boost.

Definition at line 146 of file TagVertexModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_useMCassociation

std::string m_useMCassociation
private

No MC association or standard Breco particle or internal MCparticle association.

Definition at line 101 of file TagVertexModule.h.

◆ m_useRollBack

bool m_useRollBack
private

Set to true if the tag fit is to be made with the tag track position rolled back to mother B.

Definition at line 118 of file TagVertexModule.h.

◆ m_useTruthInFit

bool m_useTruthInFit
private

Set to true if the tag fit is to be made with the TRUE tag track momentum and position.

Definition at line 113 of file TagVertexModule.h.

◆ m_verArray

StoreArray<TagVertex> m_verArray
private

StoreArray of TagVertexes.

Definition at line 95 of file TagVertexModule.h.

◆ m_verbose

bool m_verbose
private

choose if you want to print extra infos

Definition at line 153 of file TagVertexModule.h.

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