Kinematic fitter module. More...

#include <ParticleKinematicFitterModule.h>

Inheritance diagram for ParticleKinematicFitterModule:

Collaboration diagram for ParticleKinematicFitterModule:

[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
	ParticleKinematicFitterModule ()
	Constructor.

virtual void	initialize () override
	Initialize the Module. More...

virtual void	terminate () override
	termination.

virtual void	event () override
	Event processor.

virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules. More...

virtual void	beginRun ()
	Called when entering a new run. More...

virtual void	endRun ()
	This method is called if the current run ends. More...

const std::string &	getName () const
	Returns the name of the module. More...

const std::string &	getType () const
	Returns the type of the module (i.e. More...

const std::string &	getPackage () const
	Returns the package this module is in.

const std::string &	getDescription () const
	Returns the description of the module.

void	setName (const std::string &name)
	Set the name of the module. More...

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties. More...

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

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module. More...

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module. More...

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module. More...

bool	hasCondition () const
	Returns true if at least one condition was set for the module.

const 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. More...

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). More...

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished. More...

std::vector< std::shared_ptr< Path > >	getAllConditionPaths () const
	Return all condition paths currently set (no matter if the condition is true or not).

bool	hasProperties (unsigned int propertyFlags) const
	Returns true if all specified property flags are available in this module. More...

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

const ModuleParamList &	getParamList () const
	Return module param list.

template<typename T >
ModuleParam< T > &	getParam (const std::string &name) const
	Returns a reference to a parameter. More...

bool	hasReturnValue () const
	Return true if this module has a valid return value set.

int	getReturnValue () const
	Return the return value set by this module. More...

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module. More...

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters. More...

Static Public Member Functions
static void	exposePythonAPI ()
	Exposes methods of the Module class to Python.

Protected Member Functions
virtual void	def_initialize ()
	Wrappers to make the methods without "def_" prefix callable from Python. More...

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

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

virtual void	def_endRun ()
	This method can receive that the current run ends as a call from the Python side. More...

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

void	setDescription (const std::string &description)
	Sets the description of the module. More...

void	setType (const std::string &type)
	Set the module type. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
	Adds a new parameter to the module. More...

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module. More...

void	setReturnValue (int value)
	Sets the return value for this module as integer. More...

void	setReturnValue (bool value)
	Sets the return value for this module as bool. More...

void	setParamList (const ModuleParamList &params)
	Replace existing parameter list.

Private Member Functions
bool	doKinematicFit (Particle *p)
	Main steering routine for any kinematic fitter. More...

bool	doOrcaKinFitFit (Particle *p)
	Kinematic fit using OrcaKinFit. More...

bool	fillFitParticles (Particle mother, std::vector< Particle > &particleChildren)
	Fills valid particle's children (with valid error matrix) in the vector of Particles that will enter the fit.

bool	AddFour (Particle *mother)
	Added four vectors and calculated a covariance matrix for a combined particles. More...

void	addParticleToOrcaKinFit (BaseFitter &fitter, Particle *particle, const int index)
	Adds given particle to the OrcaKinFit. More...

void	addFitObjectToConstraints (ParticleFitObject &fitobject)
	Adds Orca fit object to the constraints. More...

void	addConstraintsToFitter (BaseFitter &fitter)
	Adds Orca fit object to the constraints. More...

void	addTracerToFitter (BaseFitter &fitter)
	Adds tracer to the fitter. More...

void	setConstraints ()
	Sets constraints, this is not connect to particles or a fitter at this stage.

ROOT::Math::PxPyPzEVector	getLorentzVectorConstraints ()
	Get constraints (at whatever stage before/after fitting)

void	resetFitter (BaseFitter &fitter)
	Resets all objects associated with the OrcaKinFit fitter. More...

void	addUnmeasuredGammaToOrcaKinFit (BaseFitter &fitter)
	Adds an unmeasured gamma (E, phi, theta) to the fit (-3C) stored as EventExtraInfo TODO. More...

void	updateOrcaKinFitMother (BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
	Update the mother: momentum is sum of daughters TODO update covariance matrix. More...

bool	updateOrcaKinFitDaughters (BaseFitter &fitter, Particle *mother)
	Update the daughters: momentum is sum of daughters TODO update covariance matrix. More...

void	updateMapOfTrackAndDaughter (unsigned &l, std::vector< std::vector< unsigned >> &pars, std::vector< unsigned > &pard, std::vector< Particle * > &allparticles, const Particle *daughter)
	update the map of daughter and tracks, find out which tracks belong to each daughter. More...

bool	storeOrcaKinFitParticles (const std::string &prefix, BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
	store fit object information as ExtraInfo More...

CLHEP::HepSymMatrix	getCLHEPMomentumErrorMatrix (Particle *particle)
	Returns particle's 4x4 momentum-error matrix as a HepSymMatrix. More...

CLHEP::HepSymMatrix	getCLHEPMomentumVertexErrorMatrix (Particle *particle)
	Returns particle's 7x7 momentum-vertex-error matrix as a HepSymMatrix. More...

CLHEP::HepLorentzVector	getCLHEPLorentzVector (Particle *particle)
	Returns particle's 4-momentum as a HepLorentzVector. More...

ROOT::Math::PxPyPzEVector	getLorentzVector (ParticleFitObject *fitobject)

float	getFitObjectError (ParticleFitObject *fitobject, int ilocal)
	Returns fit object error on the parameter ilocal. More...

TMatrixFSym	getFitObjectCovMat (ParticleFitObject *fitobject)
	Returns covariance matrix. More...

TMatrixFSym	getCovMat7 (ParticleFitObject *fitobject)
	Returns covariance matrix. More...

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

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

std::list< 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. More...

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary. More...

Private Attributes
std::string	m_listName
	particle list name

std::string	m_kinematicFitter
	Kinematic Fitter name.

std::string	m_orcaFitterEngine
	Orca Fitter Engine name.

std::string	m_orcaTracer
	Tracer (None, Text or ROOT)

std::string	m_orcaConstraint
	Constraint (softBeam, hardBeam (default))

bool	m_debugFitter
	activate internal debugging (for New and Newton fitter only)

int	m_debugFitterLevel
	internal debugging level (for New and Newton fitter only)

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

bool	m_fixUnmeasuredPhotonToHER
	fix the momentum of the unmeasured photon to HER

bool	m_fixUnmeasuredPhotonToLER
	fix the momentum of the unmeasured photon to LER

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

bool	m_liftPhotonTheta
	lift theta constraint of the 3CPhoton. More...

bool	m_updateMother
	update mother kinematics

bool	m_updateDaughters
	update daughter kinematics

double	m_recoilMass
	Recoil mass for RecoilMass constraint.

double	m_invMass
	Invariant mass for Mass constraint.

TextTracer *	m_textTracer
	internal text output variable

StoreObjPtr< EventExtraInfo >	m_eventextrainfo
	StoreObjPtr for the EventExtraInfo in this mode.

std::vector< double >	m_unmeasuredLeptonFitObject
	unmeasured fit object

std::vector< double >	m_unmeasuredGammaFitObject
	unmeasured fit object

StoreObjPtr< ParticleList >	m_plist
	StoreObjPtr for the particle list.

MomentumConstraint	m_hardConstraintPx
	hard beam constraint px

MomentumConstraint	m_hardConstraintPy
	hard beam constraint py

MomentumConstraint	m_hardConstraintPz
	hard beam constraint pz

MomentumConstraint	m_hardConstraintE
	hard beam constraint E

RecoilMassConstraint	m_hardConstraintRecoilMass
	hard recoil mass constraint

MassConstraint	m_hardConstraintMass
	hard mass constraint

std::string	m_decayString
	daughter particles selection

DecayDescriptor	m_decaydescriptor
	Decay descriptor of decays to look for.

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

std::string	m_type
	The type of the module, saved as a string.

std::string	m_package
	Package this module is found in (may be empty).

std::string	m_description
	The description of the module.

unsigned int	m_propertyFlags
	The properties of the module as bitwise or (with \|) of EModulePropFlags.

LogConfig	m_logConfig
	The log system configuration of the module.

ModuleParamList	m_moduleParamList
	List storing and managing all parameter of the module.

bool	m_hasReturnValue
	True, if the return value is set.

int	m_returnValue
	The return value.

std::vector< ModuleCondition >	m_conditions
	Module condition, only non-null if set.

Detailed Description

Kinematic fitter module.

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

Member Function Documentation

◆ addConstraintsToFitter()

void addConstraintsToFitter ( BaseFitter & fitter )

private

Adds Orca fit object to the constraints.

Parameters

fitter reference to OrcaKinFit fitter object

Definition at line 524 of file ParticleKinematicFitterModule.cc.

 {
   if (m_orcaConstraint == "HardBeam") {
     fitter.addConstraint(m_hardConstraintPx);
     fitter.addConstraint(m_hardConstraintPy);
     fitter.addConstraint(m_hardConstraintPz);
     fitter.addConstraint(m_hardConstraintE);
   } else if (m_orcaConstraint == "RecoilMass") {
     fitter.addConstraint(m_hardConstraintRecoilMass);
   } else if (m_orcaConstraint == "Mass") {
     fitter.addConstraint(m_hardConstraintMass);
   }
  
   else {
     B2FATAL("ParticleKinematicFitterModule:  " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
   }
 }

◆ addFitObjectToConstraints()

void addFitObjectToConstraints ( ParticleFitObject & fitobject )

private

Adds Orca fit object to the constraints.

Parameters

fitobject reference to OrcaKinFit fit object

Definition at line 508 of file ParticleKinematicFitterModule.cc.

◆ AddFour()

bool AddFour ( Particle * mother )

private

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

Parameters

mother pointer to particle

Definition at line 295 of file ParticleKinematicFitterModule.cc.

◆ addParticleToOrcaKinFit()

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

private

Adds given particle to the OrcaKinFit.

Parameters

fitter	reference to OrcaKinFit fitter object
particle	pointer to particle
index	used to name particles: particle_index

Definition at line 316 of file ParticleKinematicFitterModule.cc.

◆ addTracerToFitter()

void addTracerToFitter ( BaseFitter & fitter )

private

Adds tracer to the fitter.

Parameters

fitter reference to OrcaKinFit fitter object

Definition at line 542 of file ParticleKinematicFitterModule.cc.

◆ addUnmeasuredGammaToOrcaKinFit()

void addUnmeasuredGammaToOrcaKinFit ( BaseFitter & fitter )

private

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

Parameters

fitter reference to OrcaKinFit fitter object

Definition at line 552 of file ParticleKinematicFitterModule.cc.

◆ beginRun()

virtual void beginRun ( void )

inlinevirtualinherited

Called when entering a new run.

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

This method can be implemented by subclasses.

Definition at line 147 of file Module.h.

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

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

◆ doKinematicFit()

bool doKinematicFit ( Particle * p )

private

Main steering routine for any kinematic fitter.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 113 of file ParticleKinematicFitterModule.cc.

◆ doOrcaKinFitFit()

bool doOrcaKinFitFit ( Particle * p )

private

Kinematic fit using OrcaKinFit.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 153 of file ParticleKinematicFitterModule.cc.

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

◆ evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns: True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

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

◆ getCLHEPLorentzVector()

CLHEP::HepLorentzVector getCLHEPLorentzVector ( Particle * particle )

private

Returns particle's 4-momentum as a HepLorentzVector.

Parameters

particle pointer to particle

Definition at line 406 of file ParticleKinematicFitterModule.cc.

◆ getCLHEPMomentumErrorMatrix()

CLHEP::HepSymMatrix getCLHEPMomentumErrorMatrix ( Particle * particle )

private

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

Parameters

particle pointer to particle

Definition at line 378 of file ParticleKinematicFitterModule.cc.

◆ getCLHEPMomentumVertexErrorMatrix()

CLHEP::HepSymMatrix getCLHEPMomentumVertexErrorMatrix ( Particle * particle )

private

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

Parameters

particle pointer to particle

Definition at line 392 of file ParticleKinematicFitterModule.cc.

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

◆ getCovMat7()

TMatrixFSym getCovMat7 ( ParticleFitObject * fitobject )

private

Returns covariance matrix.

Parameters

fitobject reference to OrcaKinFit fit object

Definition at line 776 of file ParticleKinematicFitterModule.cc.

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

◆ getFitObjectCovMat()

TMatrixFSym getFitObjectCovMat ( ParticleFitObject * fitobject )

private

Returns covariance matrix.

Parameters

fitobject reference to OrcaKinFit fit object

Definition at line 754 of file ParticleKinematicFitterModule.cc.

◆ getFitObjectError()

float getFitObjectError	(	ParticleFitObject *	fitobject,
		int	ilocal
	)

private

Returns fit object error on the parameter ilocal.

Parameters

fitobject	reference to OrcaKinFit fit object
ilocal	internal local ID

Definition at line 742 of file ParticleKinematicFitterModule.cc.

◆ getLorentzVector()

ROOT::Math::PxPyPzEVector getLorentzVector ( ParticleFitObject * fitobject )

private

Parameters

fitobject reference to OrcaKinFit fit object Returns particle's 4-momentum as a PxPyPzEVector

Definition at line 412 of file ParticleKinematicFitterModule.cc.

◆ getName()

const std::string& getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

◆ getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

propertyFlags Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

◆ initialize()

void initialize ( void )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 76 of file ParticleKinematicFitterModule.cc.

◆ resetFitter()

void resetFitter ( BaseFitter & fitter )

private

Resets all objects associated with the OrcaKinFit fitter.

Parameters

fitter reference to OrcaKinFit fitter object

Definition at line 502 of file ParticleKinematicFitterModule.cc.

◆ setDescription()

void setDescription ( const std::string & description )

protectedinherited

Sets the description of the module.

Parameters

description A description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value The value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value The value of the return value.

Definition at line 220 of file Module.cc.

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

◆ storeOrcaKinFitParticles()

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

private

store fit object information as ExtraInfo

Parameters

prefix	can be used to distinguish e.g. "Fitted" and "Measured"
fitter	reference to OrcaKinFit fitter object
particleChildren	list of all particle children
mother	mother particle

Definition at line 707 of file ParticleKinematicFitterModule.cc.

◆ updateMapOfTrackAndDaughter()

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

private

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

Parameters

l	represent the tracks ID
pars	map of all parameters
pard	vector of parameters
allparticles	vector of all particles
daughter	pointer to particle

Definition at line 660 of file ParticleKinematicFitterModule.cc.

◆ updateOrcaKinFitDaughters()

bool updateOrcaKinFitDaughters	(	BaseFitter &	fitter,
		Particle *	mother
	)

private

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

Parameters

fitter	reference to OrcaKinFit fitter object
mother	mother particle

Definition at line 594 of file ParticleKinematicFitterModule.cc.

◆ updateOrcaKinFitMother()

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

private

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

Parameters

fitter	reference to OrcaKinFit fitter object
particleChildren	list of daughter particles
mother	mother particle

Definition at line 682 of file ParticleKinematicFitterModule.cc.

Member Data Documentation

◆ m_liftPhotonTheta

bool m_liftPhotonTheta

private

lift theta constraint of the 3CPhoton.

Valid when add3CPhoton is true.

Definition at line 95 of file ParticleKinematicFitterModule.h.

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

analysis/modules/ParticleKinematicFitter/include/ParticleKinematicFitterModule.h
analysis/modules/ParticleKinematicFitter/src/ParticleKinematicFitterModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ addConstraintsToFitter()

◆ addFitObjectToConstraints()

◆ AddFour()

◆ addParticleToOrcaKinFit()

◆ addTracerToFitter()

◆ addUnmeasuredGammaToOrcaKinFit()

◆ beginRun()

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ doKinematicFit()

◆ doOrcaKinFitFit()

◆ endRun()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getCLHEPLorentzVector()

◆ getCLHEPMomentumErrorMatrix()

◆ getCLHEPMomentumVertexErrorMatrix()

◆ getConditionPath()

◆ getCovMat7()

◆ getFileNames()

◆ getFitObjectCovMat()

◆ getFitObjectError()

◆ getLorentzVector()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ resetFitter()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ storeOrcaKinFitParticles()

◆ updateMapOfTrackAndDaughter()

◆ updateOrcaKinFitDaughters()

◆ updateOrcaKinFitMother()

Member Data Documentation

◆ m_liftPhotonTheta