ParticleKinematicFitterModule Class Reference

Kinematic fitter module. More...

#include <ParticleKinematicFitterModule.h>

Inheritance diagram for ParticleKinematicFitterModule:

Collaboration diagram for ParticleKinematicFitterModule:

Public Types
enum	EModulePropFlags {   c_Input = 1 ,   c_Output = 2 ,   c_ParallelProcessingCertified = 4 ,   c_HistogramManager = 8 ,   c_InternalSerializer = 16 ,   c_TerminateInAllProcesses = 32 ,   c_DontCollectStatistics = 64 }
	Each module can be tagged with property flags, which indicate certain features of the module. More...
typedef ModuleCondition::EAfterConditionPath	EAfterConditionPath
	Forward the EAfterConditionPath definition from the ModuleCondition.

Public Member Functions
	ParticleKinematicFitterModule ()
	Constructor.
virtual void	initialize () override
	Initialize the Module.
virtual void	terminate () override
	termination.
virtual void	event () override
	Event processor.
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
virtual void	beginRun ()
	Called when entering a new run.
virtual void	endRun ()
	This method is called if the current run ends.
const std::string &	getName () const
	Returns the name of the module.
const std::string &	getType () const
	Returns the type of the module (i.e.
const std::string &	getPackage () const
	Returns the package this module is in.
const std::string &	getDescription () const
	Returns the description of the module.
void	setName (const std::string &name)
	Set the name of the module.
void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties.
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	doKinematicFit (Particle *p)
	Main steering routine for any kinematic fitter.
bool	doOrcaKinFitFit (Particle *p)
	Kinematic fit using OrcaKinFit.
bool	fillFitParticles (Particle *mother, std::vector< Particle * > &particleChildren)
	Fills valid particle's children (with valid error matrix) in the vector of Particles that will enter the fit.
bool	AddFour (Particle *mother)
	Added four vectors and calculated a covariance matrix for a combined particles.
void	addParticleToOrcaKinFit (BaseFitter &fitter, Particle *particle, const int index)
	Adds given particle to the OrcaKinFit.
void	addFitObjectToConstraints (ParticleFitObject &fitobject)
	Adds Orca fit object to the constraints.
void	addConstraintsToFitter (BaseFitter &fitter)
	Adds Orca fit object to the constraints.
void	addTracerToFitter (BaseFitter &fitter)
	Adds tracer to the fitter.
void	setConstraints ()
	Sets constraints, this is not connect to particles or a fitter at this stage.
ROOT::Math::PxPyPzEVector	getLorentzVectorConstraints ()
	Get constraints (at whatever stage before/after fitting)
void	resetFitter (BaseFitter &fitter)
	Resets all objects associated with the OrcaKinFit fitter.
void	addUnmeasuredGammaToOrcaKinFit (BaseFitter &fitter)
	Adds an unmeasured gamma (E, phi, theta) to the fit (-3C) stored as EventExtraInfo TODO.
void	updateOrcaKinFitMother (BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
	Update the mother: momentum is sum of daughters TODO update covariance matrix.
bool	updateOrcaKinFitDaughters (BaseFitter &fitter, Particle *mother)
	Update the daughters: momentum is sum of daughters TODO update covariance matrix.
void	updateMapOfTrackAndDaughter (unsigned &l, std::vector< std::vector< unsigned > > &pars, std::vector< unsigned > &pard, std::vector< Particle * > &allparticles, const Particle *daughter)
	update the map of daughter and tracks, find out which tracks belong to each daughter.
bool	storeOrcaKinFitParticles (const std::string &prefix, BaseFitter &fitter, std::vector< Particle * > &particleChildren, Particle *mother)
	store fit object information as ExtraInfo
CLHEP::HepSymMatrix	getCLHEPMomentumErrorMatrix (Particle *particle)
	Returns particle's 4x4 momentum-error matrix as a HepSymMatrix.
CLHEP::HepSymMatrix	getCLHEPMomentumVertexErrorMatrix (Particle *particle)
	Returns particle's 7x7 momentum-vertex-error matrix as a HepSymMatrix.
CLHEP::HepLorentzVector	getCLHEPLorentzVector (Particle *particle)
	Returns particle's 4-momentum as a HepLorentzVector.
ROOT::Math::PxPyPzEVector	getLorentzVector (ParticleFitObject *fitobject)
float	getFitObjectError (ParticleFitObject *fitobject, int ilocal)
	Returns fit object error on the parameter ilocal.
TMatrixFSym	getFitObjectCovMat (ParticleFitObject *fitobject)
	Returns covariance matrix.
TMatrixFSym	getCovMat7 (ParticleFitObject *fitobject)
	Returns covariance matrix.
TMatrixFSym	getTMatrixFSymMomentumErrorMatrix ()
	Returns particle's 7x7 momentum-error matrix as a TMatrixFSym.
TMatrixFSym	getTMatrixFSymMomentumVertexErrorMatrix ()
	Returns particle's 7x7 momentum-vertex-error matrix as a TMatrixFSym.
std::list< 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.

Private Attributes
std::string	m_listName
	particle list name
std::string	m_kinematicFitter
	Kinematic Fitter name.
std::string	m_orcaFitterEngine
	Orca Fitter Engine name.
std::string	m_orcaTracer
	Tracer (None, Text or ROOT)
std::string	m_orcaConstraint
	Constraint (softBeam, hardBeam (default))
bool	m_debugFitter
	activate internal debugging (for New and Newton fitter only)
int	m_debugFitterLevel
	internal debugging level (for New and Newton fitter only)
bool	m_addUnmeasuredPhoton
	add one unmeasured photon to the fit (costs 3 constraints)
bool	m_fixUnmeasuredPhotonToHER
	fix the momentum of the unmeasured photon to HER
bool	m_fixUnmeasuredPhotonToLER
	fix the momentum of the unmeasured photon to LER
bool	m_add3CPhoton
	add one photon with unmeasured energy to the fit (costs 1 constraints)
bool	m_liftPhotonTheta
	lift theta constraint of the 3CPhoton.
bool	m_updateMother
	update mother kinematics
bool	m_updateDaughters
	update daughter kinematics
double	m_recoilMass
	Recoil mass for RecoilMass constraint.
double	m_invMass
	Invariant mass for Mass constraint.
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 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.

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

ParticleKinematicFitterModule()

ParticleKinematicFitterModule

(

)

Constructor.

Definition at line 51 of file ParticleKinematicFitterModule.cc.

                                                             : Module(), m_textTracer(nullptr), m_eventextrainfo("",
      DataStore::c_Event)
{
  setDescription("Kinematic fitter for modular analysis");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // Add parameters
  addParam("listName", m_listName, "Name of particle list.", string(""));
  addParam("kinematicFitter", m_kinematicFitter, "Available: OrcaKinFit.", string("OrcaKinFit"));
  addParam("orcaFitterEngine", m_orcaFitterEngine, "OrcaKinFit engine: NewFitterGSL, NewtonFitterGSL, OPALFitterGSL.",
           string("OPALFitterGSL"));
  addParam("orcaTracer", m_orcaTracer, "OrcaKinFit tracer: None, Text.", string("None"));
  addParam("orcaConstraint", m_orcaConstraint, "OrcaKinFit constraint: HardBeam, RecoilMass.", string("HardBeam"));
  addParam("debugFitter", m_debugFitter, "Switch on/off internal debugging output if available.", false);
  addParam("debugFitterLevel", m_debugFitterLevel, "Internal debugging output level if available.", 10);
  addParam("addUnmeasuredPhoton", m_addUnmeasuredPhoton, "Add one unmeasured photon (-3C).", false);
  addParam("fixUnmeasuredToHER", m_fixUnmeasuredPhotonToHER, "fix the momentum of the unmeasured photon to HER (+2C).", false);
  addParam("fixUnmeasuredToLER", m_fixUnmeasuredPhotonToLER, "fix the momentum of the unmeasured photon to LER (+2C).", false);
  addParam("add3CPhoton", m_add3CPhoton, "Add one photon with unmeasured energy (-1C).", false);
  addParam("liftPhotonTheta", m_liftPhotonTheta, "Lift theta constraint of 3CPhoton. Valid when add3CPhoton is true.", false);
  addParam("decayString", m_decayString, "Specifies which daughter particles are included in the kinematic fit.", string(""));
  addParam("updateMother", m_updateMother, "Update the mother kinematics.", true);
  addParam("updateDaughters", m_updateDaughters, "Update the daughter kinematics.", false);
  addParam("recoilMass", m_recoilMass, "Recoil mass in GeV. RecoilMass constraint only.", 0.0);
  addParam("invMass", m_invMass, "Invariant mass in GeV. Mass constraint only.", 0.0);
 
}

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

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

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

{
  TMatrixFSym MomentumVertexErrorMatrix(7);
  for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
    auto* child = const_cast<Particle*>(mother->getDaughter(ichild));
 
    if (child->getPValue() > 0) {
      MomentumVertexErrorMatrix += child->getMomentumVertexErrorMatrix();
    } else if (child->getNDaughters() > 0) {
      AddFour(child);
      MomentumVertexErrorMatrix += child->getMomentumVertexErrorMatrix();
    } else {
      B2ERROR("Daughter with PDG code " << child->getPDGCode() << " does not have a valid p-value: p=" << child->getPValue() << ", E=" <<
              child->getEnergy() << " GeV");
      return false; // error matrix not valid
    }
  }
  mother->setMomentumVertexErrorMatrix(MomentumVertexErrorMatrix);
  return true;
}

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

{
  B2DEBUG(17, "ParticleKinematicFitterModule: adding a particle to the fitter!");
 
  if (m_add3CPhoton && index == 0) {
    if (particle -> getPDGCode() != Const::photon.getPDGCode()) {
      B2ERROR("In 3C Kinematic fit, the first daughter should be the Unmeasured Photon!");
    }
 
    const ECLCluster* cluster = particle->getECLCluster();
    double startingE = cluster->getEnergy(particle->getECLClusterEHypothesisBit());
    double startingPhi = cluster->getPhi();
    double startingTheta = cluster->getTheta();
 
    ClusterUtils clutls;
    const auto EPhiThetaCov = clutls.GetCovarianceMatrix3x3FromCluster(cluster);
    double startingeE = sqrt(fabs(EPhiThetaCov[0][0]));
    double startingePhi = sqrt(fabs(EPhiThetaCov[1][1]));
    double startingeTheta = sqrt(fabs(EPhiThetaCov[2][2]));
 
    B2DEBUG(17, startingPhi << " " << startingTheta << " " <<  startingePhi << " " << startingeTheta);
    // create a fit object
    ParticleFitObject* pfitobject;
    // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
    pfitobject  = new JetFitObject(startingE, startingTheta, startingPhi, startingeE, startingeTheta, startingePhi, 0.);
    pfitobject->setParam(0, startingE, false, false);
    if (m_liftPhotonTheta)
      pfitobject->setParam(1, startingTheta, false, false);
    else
      pfitobject->setParam(1, startingTheta, true, false);
    pfitobject->setParam(2, startingPhi, true, false);
 
    std::string fitObjectName = "Unmeasured3C";
    pfitobject->setName(fitObjectName.c_str());
    ParticleFitObject& fitobject = *pfitobject;
 
    // add this fit object (=particle) to the constraints
    addFitObjectToConstraints(fitobject);
 
    // add fit particle to the fitter
    fitter.addFitObject(fitobject);
 
  } else {
    // four vector
    CLHEP::HepLorentzVector clheplorentzvector = getCLHEPLorentzVector(particle);
 
    // error matrix
    CLHEP::HepSymMatrix clhepmomentumerrormatrix = getCLHEPMomentumErrorMatrix(particle);
 
    // create the fit object (ParticleFitObject is the base class)
    ParticleFitObject* pfitobject;
    // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
    pfitobject  = new PxPyPzMFitObject(clheplorentzvector, clhepmomentumerrormatrix);
    std::string fitObjectName = "particle_" + SSTR(index);
    pfitobject->setName(fitObjectName.c_str());
    ParticleFitObject& fitobject = *pfitobject;
 
    // add this fit object (=particle) to the constraints
    addFitObjectToConstraints(fitobject);
 
    // add fit particle to the fitter
    fitter.addFitObject(fitobject);
  }
 
  return;
}

addTracerToFitter()

void addTracerToFitter ( BaseFitter &  fitter )

private

Adds tracer to the fitter.

Parameters

fitter

reference to OrcaKinFit fitter object

Definition at line 550 of file ParticleKinematicFitterModule.cc.

{
  if (m_orcaTracer == "Text") {
    m_textTracer = new TextTracer(std::cout);
    fitter.setTracer(m_textTracer);
  } else if (m_orcaTracer != "None") {
    B2FATAL("ParticleKinematicFitterModule:  " << m_orcaTracer << " is an invalid OrcaKinFit tracer!");
  }
}

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

{
  B2DEBUG(17, "ParticleKinematicFitterModule::addUnmeasuredGammaToOrcaKinFit: adding an unmeasured photon to the fitter!");
  // Initialize photon using the existing constraints
  ROOT::Math::PxPyPzEVector tlv = getLorentzVectorConstraints();
  double startingE = tlv.E();
  double startingPhi = tlv.Phi();
  double startingTheta = tlv.Theta();
  bool paramFlag = false;
 
  // create a fit object
  ParticleFitObject* pfitobject;
 
  std::string fitObjectName = "UnmeasuredAlongBeam";
 
  if (m_fixUnmeasuredPhotonToHER) {
    startingTheta = 41.5e-3;  // TODO: Read beam crossing angle from db if it's available
    startingPhi = 0.0;
    paramFlag = true;
  } else if (m_fixUnmeasuredPhotonToLER) {
    startingTheta = TMath::Pi() - 41.5e-3;
    startingPhi = 0.0;
    paramFlag = true;
  } else {
    fitObjectName = "Unmeasured";
  }
 
  // memory allocated: it will be deallocated via "delete fo" in doOrcaKinFitFit
  pfitobject  = new JetFitObject(startingE, startingTheta, startingPhi, 0.0, 0.0, 0.0, 0.);
  pfitobject->setParam(0, startingE, false, false);
  pfitobject->setParam(1, startingTheta, paramFlag, paramFlag);
  pfitobject->setParam(2, startingPhi, paramFlag, paramFlag);
 
  pfitobject->setName(fitObjectName.c_str());
  ParticleFitObject& fitobject = *pfitobject;
 
  // add this fit object (=particle) to the constraints
  addFitObjectToConstraints(fitobject);
 
  // add fit particle to the fitter
  fitter.addFitObject(fitobject);
}

beginRun()

virtual void beginRun ( )

inlinevirtualinherited

Called when entering a new run.

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

This method can be implemented by subclasses.

Reimplemented in EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, CreateFieldMapModule, ExportGeometryModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, and PyModule.

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.

{
  ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
  newModule->m_moduleParamList.setParameters(getParamList());
  newModule->setName(getName());
  newModule->m_package = m_package;
  newModule->m_propertyFlags = m_propertyFlags;
  newModule->m_logConfig = m_logConfig;
  newModule->m_conditions = m_conditions;
 
  return newModule;
}

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.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

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

{
  B2DEBUG(17, "ParticleKinematicFitterModule::doKinematicFit");
 
  bool ok = false;
 
  // fitting with OrcaKinFit
  if (m_kinematicFitter == "OrcaKinFit") {
 
    // select subset of particles for the fit
    if (m_decayString != "") {
      B2FATAL("ParticleKinematicFitterModule: OrcaKinFit does not support yet selection of daughters via decay string!") ;
    }
 
    // check requested fit engine
    if (!(m_orcaFitterEngine == "OPALFitterGSL" or
          m_orcaFitterEngine == "NewtonFitterGSL" or
          m_orcaFitterEngine == "NewFitterGSL")) {
      B2FATAL("ParticleKinematicFitterModule:  " << m_orcaFitterEngine << " is an invalid OrcaKinFit fitter engine!");
    }
 
    // check requested constraint
    if (!(m_orcaConstraint == "HardBeam" or
          m_orcaConstraint == "RecoilMass" or
          m_orcaConstraint == "Mass")) {
      B2FATAL("ParticleKinematicFitterModule:  " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
    }
 
    // basic  check is good, go to fitting routine
    ok = doOrcaKinFitFit(mother);
  } else { // invalid fitter
    B2FATAL("ParticleKinematicFitter: " << m_kinematicFitter << " is an invalid kinematic fitter!");
  }
 
  if (!ok) return false;
 
  return true;
 
}

doOrcaKinFitFit()

bool doOrcaKinFitFit ( Particle *  p )

private

Kinematic fit using OrcaKinFit.

Parameters

p	pointer to particle

Returns

true for successful fit

Definition at line 156 of file ParticleKinematicFitterModule.cc.

{
  if (mother->getNDaughters() <= 1) {
    B2WARNING("ParticleKinematicFitterModule: Cannot fit with " << mother->getNDaughters() << " daughters.");
    return false;
  }
 
  // fill particles
  std::vector<Particle*> particleChildren;
  bool validChildren = fillFitParticles(mother, particleChildren);
 
  if (!validChildren) {
    B2WARNING("ParticleKinematicFitterModule: Cannot find valid children for the fit.");
    return false;
  }
 
  // set fit engine
  BaseFitter* pfitter;
 
  // internal debugger
  int debugfitter = 0;
  if (m_debugFitter) debugfitter = m_debugFitterLevel;
 
  // choose minimization
  if (m_orcaFitterEngine == "OPALFitterGSL") {
    pfitter = new OPALFitterGSL(); // OPAL fitter has no debugger
  } else if (m_orcaFitterEngine == "NewtonFitterGSL") {
    pfitter = new NewtonFitterGSL();
    (dynamic_cast<NewtonFitterGSL*>(pfitter))->setDebug(debugfitter);
  } else if (m_orcaFitterEngine == "NewFitterGSL") {
    pfitter = new NewFitterGSL();
    (dynamic_cast<NewFitterGSL*>(pfitter))->setDebug(debugfitter);
  } else {
    B2FATAL("ParticleKinematicFitterModule:  " << m_orcaFitterEngine << " is an invalid OrcaKinFit fitter engine!");
    return false;
  }
 
  if (!pfitter) return false;
  BaseFitter& fitter(*pfitter);
 
  // reset fitter
  resetFitter(fitter);
 
  // set constraints (not connected to a fitter or particles at this point!)
  setConstraints();
 
  // add fit particles from particle list to the fitter and to all constraints
  for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
    addParticleToOrcaKinFit(fitter, particleChildren[iChild], iChild);
  }
 
  // add unmeasured photon to the fitter and to all constraints
  if (m_addUnmeasuredPhoton) addUnmeasuredGammaToOrcaKinFit(fitter);
 
  // add constraints to the fitter
  addConstraintsToFitter(fitter);
 
  // add tracers to the fitter
  addTracerToFitter(fitter);
 
  //store information before the fit
  storeOrcaKinFitParticles("Measured", fitter, particleChildren, mother);
 
  double prob   = fitter.fit();
  double chi2   = fitter.getChi2();
  int niter     = fitter.getIterations();
  int ndof      = fitter.getDoF();
  int errorcode = fitter.getError();
 
  B2DEBUG(17, "ParticleKinematicFitterModule: -------------------------------------------");
  B2DEBUG(17, "ParticleKinematicFitterModule: Fit result of OrcaKinFit using " << m_orcaFitterEngine);
  B2DEBUG(17, "ParticleKinematicFitterModule:   prob              " << prob);
  B2DEBUG(17, "ParticleKinematicFitterModule:   chi2              " << chi2);
  B2DEBUG(17, "ParticleKinematicFitterModule:   iterations        " << niter);
  B2DEBUG(17, "ParticleKinematicFitterModule:   ndf               " << ndof);
  B2DEBUG(17, "ParticleKinematicFitterModule:   errorcode         " << errorcode);
  B2DEBUG(17, "ParticleKinematicFitterModule: -------------------------------------------");
 
  // default update mother information
  if (m_updateMother) updateOrcaKinFitMother(fitter, particleChildren, mother);
 
  // update daughter information if that is requested
  if (m_updateDaughters) updateOrcaKinFitDaughters(fitter, mother);
 
  // store information after the fit
  storeOrcaKinFitParticles("Fitted", fitter, particleChildren, mother);
 
  //store general fit results
  mother->addExtraInfo("OrcaKinFitProb", prob);
  mother->setPValue(prob);
  mother->addExtraInfo("OrcaKinFitChi2", chi2);
  mother->addExtraInfo("OrcaKinFitErrorCode", errorcode);
 
  // if we added an unmeasured photon, add the kinematics to the mother - at some point we may want to create a particle list from this?
  std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
  for (auto fo : *fitObjectContainer) {
    if (m_addUnmeasuredPhoton) {
      const std::string name = fo->getName();
      if (name.find("Unmeasured") != std::string::npos) {
        auto* fitobject = static_cast<ParticleFitObject*>(fo);
        ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
        mother->addExtraInfo("OrcaKinFit" + name + "Theta", tlv.Theta());
        mother->addExtraInfo("OrcaKinFit" + name + "Phi", tlv.Phi());
        mother->addExtraInfo("OrcaKinFit" + name + "E", tlv.E());
 
        // Uncertainty
        // const double err0 = getFitObjectError(fitobject, 0);
        mother->addExtraInfo("OrcaKinFit" + name + "ErrorTheta", getFitObjectError(fitobject, 1));
        mother->addExtraInfo("OrcaKinFit" + name + "ErrorPhi", getFitObjectError(fitobject, 2));
        mother->addExtraInfo("OrcaKinFit" + name + "ErrorE", getFitObjectError(fitobject, 0));
      }
    }
    delete fo;
  }
 
  delete pfitter;
  delete m_textTracer;
  return true;
}

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.

{};

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.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( )

overridevirtual

Event processor.

Reimplemented from Module.

Definition at line 96 of file ParticleKinematicFitterModule.cc.

{
  B2DEBUG(17, "ParticleKinematicFitterModule::event");
 
  unsigned int n = m_plist->getListSize();
 
  for (unsigned i = 0; i < n; i++) {
    Particle* particle = m_plist->getParticle(i);
 
    if (m_updateDaughters == true) {
      if (m_decayString.empty()) ParticleCopy::copyDaughters(particle);
      else B2ERROR("Daughters update works only when all daughters are selected. Daughters will not be updated");
    }
 
    bool ok = doKinematicFit(particle);
 
    if (!ok) particle->setPValue(-1.);
  }
}

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: 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.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: 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.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "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.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

fillFitParticles()

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

private

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

Definition at line 276 of file ParticleKinematicFitterModule.cc.

{
  for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
    auto* child = const_cast<Particle*>(mother->getDaughter(ichild));
 
    if (child->getNDaughters() > 0) {
      bool err = fillFitParticles(child, particleChildren);
      if (!err) {
        B2WARNING("ParticleKinematicFitterModule: Cannot find valid children for the fit.");
        return false;
      }
    } else if (child->getPValue() > 0) {
      particleChildren.push_back(child);
    } else {
      B2ERROR("Daughter with PDG code " << child->getPDGCode() << " does not have a valid p-value: p=" << child->getPValue() << ", E=" <<
              child->getEnergy() << " GeV");
      return false; // error matrix not valid
    }
  }
  return true;
}

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.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

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.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCLHEPLorentzVector()

CLHEP::HepLorentzVector getCLHEPLorentzVector ( Particle *  particle )

private

Returns particle's 4-momentum as a HepLorentzVector.

Parameters

particle

pointer to particle

Definition at line 414 of file ParticleKinematicFitterModule.cc.

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

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

{
  CLHEP::HepSymMatrix covMatrix(4);
  TMatrixFSym errMatrix = particle->getMomentumErrorMatrix();
 
  for (int i = 0; i < 4; i++) {
    for (int j = 0; j < 4; j++) {
      covMatrix[i][j] = errMatrix[i][j];
    }
  }
 
  return covMatrix;
}

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

{
  CLHEP::HepSymMatrix covMatrix(7);
  TMatrixFSym errMatrix = particle->getMomentumVertexErrorMatrix();
 
  for (int i = 0; i < 7; i++) {
    for (int j = 0; j < 7; j++) {
      covMatrix[i][j] = errMatrix[i][j];
    }
  }
 
  return covMatrix;
}

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.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

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.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getCovMat7()

TMatrixFSym getCovMat7 ( ParticleFitObject *  fitobject )

private

Returns covariance matrix.

Parameters

fitobject

reference to OrcaKinFit fit object

Definition at line 785 of file ParticleKinematicFitterModule.cc.

{
  TMatrixFSym fitCovMatrix(3);
 
  if (strcmp(fitobject->getParamName(0), "E") == 0) {
    //check if it is a JetFitObject
    auto* jetfitObject = static_cast<JetFitObject*>(fitobject);
    if (jetfitObject) {
 
      fitCovMatrix = getFitObjectCovMat(fitobject);
      ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
 
      const double energy = tlv.E();
      const double theta  = tlv.Theta();
      const double phi    = tlv.Phi();
 
      const double st    = sin(theta);
      const double ct    = cos(theta);
      const double sp    = sin(phi);
      const double cp    = cos(phi);
 
      // updated covariance matrix is: A * cov * A^T where A is the Jacobi matrix (use Similarity)
      TMatrixF A(7, 3);
      A(0, 0) =  cp * st ; // dpx/dE
      A(0, 1) =  energy * cp * ct ; // dpx/dtheta
      A(0, 2) = -energy *  sp * st ; // dpx/dphi
      A(1, 0) =  sp * st ; // dpy/dE
      A(1, 1) =  energy *  sp * ct ; // dpz/dtheta
      A(1, 2) =  energy *  cp * st ; // dpy/dphi
      A(2, 0) =  ct ; // dpz/dE
      A(2, 1) = -energy * st ; //   dpz/dtheta
      A(2, 2) =  0 ; // dpz/dphi
      A(3, 0) = 1.0; // dE/dE
      A(3, 1) = 0.0; // dE/dphi
      A(3, 2) = 0.0; // dE/dtheta
 
      TMatrixFSym D = fitCovMatrix.Similarity(A);
      return D;
 
    } else {
      B2FATAL("ParticleKinematicFitterModule: not implemented yet");
    }
  } else {
    //check if it is a PxPyPzMFitObject
    auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
    if (pxpypzmfitobject) {
 
      fitCovMatrix = getFitObjectCovMat(fitobject);
 
      // updated covariance matrix is: A * cov * A^T where A is the Jacobi matrix (use Similarity)
      ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
      TMatrixF A(7, 3);
      A[0][0] = 1.; // px/dpx
      A[0][1] = 0.; // px/dpy
      A[0][2] = 0.; // px/dpz
      A[1][0] = 0.; // py/dpx
      A[1][1] = 1.; // py/dpy
      A[1][2] = 0.; // py/dpz
      A[2][0] = 0.; // pz/dpx
      A[2][1] = 0.; // pz/dpy
      A[2][2] = 1.; // pz/dpz
      if (tlv.E() > 0.0) {
        A[3][0] = tlv.Px() / tlv.E(); // E/dpx, E=sqrt(px^2 + py^2 + pz^2 + m^2)
        A[3][1] = tlv.Py() / tlv.E(); // E/dpy
        A[3][2] = tlv.Pz() / tlv.E(); // E/dpz
      }
 
      TMatrixFSym D = fitCovMatrix.Similarity(A);
 
      return D;
    } else {
      B2FATAL("ParticleKinematicFitterModule: not implemented yet");
    }
  }
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

getFitObjectCovMat()

TMatrixFSym getFitObjectCovMat ( ParticleFitObject *  fitobject )

private

Returns covariance matrix.

Parameters

fitobject

reference to OrcaKinFit fit object

Definition at line 763 of file ParticleKinematicFitterModule.cc.

{
 
  //check if it is a PxPyPzMFitObject
  auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
  if (pxpypzmfitobject) {
 
    TMatrixFSym errMatrix(3);
 
    //loop over the i-j local variables.
    for (int i = 0; i < 3; i++) {
      for (int j = 0; j < 3; j++) {
        errMatrix[i][j] = pxpypzmfitobject->getCov(i, j);
      }
    }
 
    return errMatrix;
  } else {
    B2FATAL("ParticleKinematicFitterModule: not implemented yet");
  }
}

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

{
  //check if it is a PxPyPzMFitObject
  auto* pxpypzmfitobject = static_cast<PxPyPzMFitObject*>(fitobject);
  if (pxpypzmfitobject) {
    return fitobject->getError(ilocal);
  } else {
    B2FATAL("ParticleKinematicFitterModule: not implemented yet");
  }
}

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

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

{
  ROOT::Math::PxPyPzEVector mom(fitobject->getPx(), fitobject->getPy(), fitobject->getPz(), fitobject->getE());
  return mom;
}

getLorentzVectorConstraints()

ROOT::Math::PxPyPzEVector getLorentzVectorConstraints ( )

private

Get constraints (at whatever stage before/after fitting)

Definition at line 454 of file ParticleKinematicFitterModule.cc.

{
  if (m_orcaConstraint == "HardBeam") {
    ROOT::Math::PxPyPzEVector constraints4vector(m_hardConstraintPx.getValue(),
                                                 m_hardConstraintPy.getValue(),
                                                 m_hardConstraintPz.getValue(),
                                                 m_hardConstraintE.getValue());
    return constraints4vector;
  } else {
    B2FATAL("ParticleKinematicFitterModule:  " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
  }
 
  // should not reach this point...
  return ROOT::Math::PxPyPzEVector(0., 0., 0., 0.);
}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

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

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

{
 
  std::string output = getName();
 
  for (const auto& condition : m_conditions) {
    output += condition.getString();
  }
 
  return output;
}

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.

{ return m_returnValue; }

getTMatrixFSymMomentumErrorMatrix()

TMatrixFSym getTMatrixFSymMomentumErrorMatrix ( )

private

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

Definition at line 427 of file ParticleKinematicFitterModule.cc.

{
  TMatrixFSym errMatrix(4);
 
  for (int i = 0; i < 4; i++) {
    for (int j = i; j < 4; j++) {
      errMatrix[i][j] = 0.0;
    }
  }
 
  return errMatrix;
}

getTMatrixFSymMomentumVertexErrorMatrix()

TMatrixFSym getTMatrixFSymMomentumVertexErrorMatrix ( )

private

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

Definition at line 441 of file ParticleKinematicFitterModule.cc.

{
  TMatrixFSym errMatrix(7);
 
  for (int i = 0; i < 7; i++) {
    for (int j = i; j < 7; j++) {
      errMatrix[i][j] = 0.0;
    }
  }
 
  return errMatrix;
}

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.

{
  if (m_type.empty())
    B2FATAL("Module type not set for " << getName());
  return m_type;
}

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.

{ 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

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

{
  return (propertyFlags & m_propertyFlags) == propertyFlags;
}

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

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

{
  auto missing = m_moduleParamList.getUnsetForcedParams();
  std::string allMissing = "";
  for (const auto& s : missing)
    allMissing += s + " ";
  if (!missing.empty())
    B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
            "\nPlease add them to your steering file.");
  return !missing.empty();
}

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_value("<1", path, afterConditionPath);
}

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(">=1", path, afterConditionPath);
}

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.

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

initialize()

void initialize ( )

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 79 of file ParticleKinematicFitterModule.cc.

{
  m_eventextrainfo.registerInDataStore();
 
  if (m_decayString != "") {
    m_decaydescriptor.init(m_decayString);
    B2INFO("ParticleKinematicFitter: Using specified decay string: " << m_decayString);
  }
 
  m_plist.isRequired(m_listName);
}

resetFitter()

void resetFitter ( BaseFitter &  fitter )

private

Resets all objects associated with the OrcaKinFit fitter.

Parameters

fitter

reference to OrcaKinFit fitter object

Definition at line 510 of file ParticleKinematicFitterModule.cc.

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

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setConstraints()

void setConstraints ( )

private

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

Definition at line 470 of file ParticleKinematicFitterModule.cc.

{
  if (m_orcaConstraint == "HardBeam") {
    PCmsLabTransform T;
    const ROOT::Math::PxPyPzEVector boost = T.getBeamFourMomentum();
 
    m_hardConstraintPx = MomentumConstraint(0, 1, 0, 0, boost.Px());
    m_hardConstraintPy = MomentumConstraint(0, 0, 1, 0, boost.Py());
    m_hardConstraintPz = MomentumConstraint(0, 0, 0, 1, boost.Pz());
    m_hardConstraintE  = MomentumConstraint(1, 0, 0, 0, boost.E());
 
    m_hardConstraintPx.resetFOList();
    m_hardConstraintPy.resetFOList();
    m_hardConstraintPz.resetFOList();
    m_hardConstraintE.resetFOList();
 
    m_hardConstraintPx.setName("Sum(p_x) [hard]");
    m_hardConstraintPy.setName("Sum(p_y) [hard]");
    m_hardConstraintPz.setName("Sum(p_z) [hard]");
    m_hardConstraintE.setName("Sum(E) [hard]");
 
  } else if (m_orcaConstraint == "RecoilMass") {
    PCmsLabTransform T;
    const ROOT::Math::PxPyPzEVector boost = T.getBeamFourMomentum();
 
    m_hardConstraintRecoilMass = RecoilMassConstraint(m_recoilMass, boost.Px(), boost.Py(), boost.Pz(), boost.E());
 
    m_hardConstraintRecoilMass.resetFOList();
    m_hardConstraintRecoilMass.setName("Recoil Mass [hard]");
 
  } else if (m_orcaConstraint == "Mass") {
    m_hardConstraintMass = MassConstraint(m_invMass);
 
    m_hardConstraintMass.resetFOList();
    m_hardConstraintMass.setName("Mass [hard]");
  } else {
    B2FATAL("ParticleKinematicFitterModule:  " << m_orcaConstraint << " is an invalid OrcaKinFit constraint!");
  }
}

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

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.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

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.

{
  m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
}

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

{
  m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
}

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.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ 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

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.

{
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
  try {
    m_moduleParamList.setParamPython(name, pyObj);
  } catch (std::runtime_error& e) {
    throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
                             + m_name + "': " + e.what());
  }
 
  logSystem.updateModule(nullptr);
}

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.

{
 
  LogSystem& logSystem = LogSystem::Instance();
  logSystem.updateModule(&(getLogConfig()), getName());
 
  boost::python::list dictKeys = dictionary.keys();
  int nKey = boost::python::len(dictKeys);
 
  //Loop over all keys in the dictionary
  for (int iKey = 0; iKey < nKey; ++iKey) {
    boost::python::object currKey = dictKeys[iKey];
    boost::python::extract<std::string> keyProxy(currKey);
 
    if (keyProxy.check()) {
      const boost::python::object& currValue = dictionary[currKey];
      setParamPython(keyProxy, currValue);
    } else {
      B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
    }
  }
 
  logSystem.updateModule(nullptr);
}

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.

{
  m_propertyFlags = propertyFlags;
}

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.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

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.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

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.

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

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

{
  bool updated = false;
  std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
 
  for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
    BaseFitObject* fo = fitObjectContainer->at(iChild);
    auto* fitobject = static_cast<ParticleFitObject*>(fo);
    ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
 
    // name of extra variables
    std::string extraVariableParticlePx    = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_Px";
    std::string extraVariableParticlePy    = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_Py";
    std::string extraVariableParticlePz    = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_Pz";
    std::string extraVariableParticleE     = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_E";
    std::string extraVariableParticlePxErr = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_PxErr";
    std::string extraVariableParticlePyErr = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_PyErr";
    std::string extraVariableParticlePzErr = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_PzErr";
    std::string extraVariableParticleEErr  = "OrcaKinFit" + prefix + "_" + SSTR(iChild) + "_EErr";
 
    mother->addExtraInfo(extraVariableParticlePx, tlv.Px());
    mother->addExtraInfo(extraVariableParticlePy, tlv.Py());
    mother->addExtraInfo(extraVariableParticlePz, tlv.Pz());
    mother->addExtraInfo(extraVariableParticleE, tlv.E());
    mother->addExtraInfo(extraVariableParticlePxErr, getFitObjectError(fitobject, 0));
    mother->addExtraInfo(extraVariableParticlePyErr, getFitObjectError(fitobject, 1));
    mother->addExtraInfo(extraVariableParticlePzErr, getFitObjectError(fitobject, 2));
    mother->addExtraInfo(extraVariableParticleEErr, -1.0);
 
  }
 
  return updated;
}

terminate()

void terminate ( )

overridevirtual

termination.

Reimplemented from Module.

Definition at line 91 of file ParticleKinematicFitterModule.cc.

{
  B2INFO("ParticleKinematicFitterModule::terminate");
}

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

{
  std::vector <Belle2::Particle*> dDau = daughter->getDaughters();
  for (unsigned ichild = 0; ichild < daughter->getNDaughters(); ichild++) {
    const Particle* child = daughter->getDaughter(ichild);
    std::vector<unsigned> pard;
    if (child->getNDaughters() > 0) {
      updateMapOfTrackAndDaughter(l, pars, pard, allparticles, child);
      parm.insert(parm.end(), pard.begin(), pard.end());
      pars.push_back(pard);
      allparticles.push_back(dDau[ichild]);
    } else {
      pard.push_back(l);
      parm.push_back(l);
      pars.push_back(pard);
      allparticles.push_back(dDau[ichild]);
      l++;
    }
  }
}

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

{
  std::vector <Belle2::Particle*> bDau = mother->getDaughters();
  std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
 
  const unsigned nd = bDau.size();
  unsigned l = 0;
  std::vector<std::vector<unsigned>> pars;
  std::vector<Particle*> allparticles;
  for (unsigned ichild = 0; ichild < nd; ichild++) {
    const Particle* daughter = mother->getDaughter(ichild);
    std::vector<unsigned> pard;
    if (daughter->getNDaughters() > 0) {
      updateMapOfTrackAndDaughter(l, pars, pard, allparticles, daughter);
      pars.push_back(pard);
      allparticles.push_back(bDau[ichild]);
    } else {
      pard.push_back(l);
      pars.push_back(pard);
      allparticles.push_back(bDau[ichild]);
      l++;
    }
  }
 
  if (l == fitObjectContainer->size() - m_addUnmeasuredPhoton) {
 
    if (fitter.getError() == 0) {
      for (unsigned iDaug = 0; iDaug < allparticles.size(); iDaug++) {
        ROOT::Math::PxPyPzEVector tlv ;
        TMatrixFSym errMatrixU(7);
        if (pars[iDaug].size() > 0) {
          for (unsigned int iChild : pars[iDaug]) {
            BaseFitObject* fo = fitObjectContainer->at(iChild);
            auto* fitobject = static_cast<ParticleFitObject*>(fo);
            ROOT::Math::PxPyPzEVector tlv_sub = getLorentzVector(fitobject);
            TMatrixFSym errMatrixU_sub = getCovMat7(fitobject);
            tlv = tlv + tlv_sub;
            errMatrixU = errMatrixU + errMatrixU_sub;
          }
        } else {
          B2FATAL("ParticleKinematicFitterModule:   no fitObject could be used to update the daughter!");
        }
        ROOT::Math::XYZVector pos = allparticles[iDaug]->getVertex(); // we don't update the vertex yet
        TMatrixFSym errMatrix     = allparticles[iDaug]->getMomentumVertexErrorMatrix();
        TMatrixFSym errMatrixMom  = allparticles[iDaug]->getMomentumErrorMatrix();
        TMatrixFSym errMatrixVer  = allparticles[iDaug]->getVertexErrorMatrix();
 
        for (int i = 0; i < 3; i++) {
          for (int j = i; j < 3; j++) {
            errMatrixU[i + 4][j + 4] = errMatrixVer[i][j];
          }
        }
 
        allparticles[iDaug]->set4Vector(tlv);
        allparticles[iDaug]->setVertex(pos);
        allparticles[iDaug]->setMomentumVertexErrorMatrix(errMatrixU);
      }
    }
 
    return true;
  } else {
    B2ERROR("updateOrcaKinFitDaughters: Cannot update daughters, mismatch between number of daughters and number of fitobjects!");
    return false;
  }
}

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

{
  // get old values
  ROOT::Math::XYZVector pos = mother->getVertex();
  TMatrixFSym errMatrix = mother->getMomentumVertexErrorMatrix();
  float pvalue          = mother->getPValue();
 
  // update momentum vector
  ROOT::Math::PxPyPzEVector momnew(0., 0., 0., 0.);
 
  std::vector <BaseFitObject*>* fitObjectContainer = fitter.getFitObjects();
  for (unsigned iChild = 0; iChild < particleChildren.size(); iChild++) {
    BaseFitObject* fo = fitObjectContainer->at(iChild);
    auto* fitobject = static_cast<ParticleFitObject*>(fo);
    ROOT::Math::PxPyPzEVector tlv = getLorentzVector(fitobject);
    momnew += tlv;
  }
 
  // update
  // TODO: use pvalue of the fit or the old one of the mother? use fit covariance matrix?
  // Maybe here should use the pvalue and errmatrix of the fit  ----Yu Hu
  mother->updateMomentum(momnew, pos, errMatrix, pvalue);
}

Member Data Documentation

m_add3CPhoton

bool m_add3CPhoton

private

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

Definition at line 94 of file ParticleKinematicFitterModule.h.

m_addUnmeasuredPhoton

bool m_addUnmeasuredPhoton

private

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

Definition at line 91 of file ParticleKinematicFitterModule.h.

m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

m_debugFitter

bool m_debugFitter

private

activate internal debugging (for New and Newton fitter only)

Definition at line 89 of file ParticleKinematicFitterModule.h.

m_debugFitterLevel

int m_debugFitterLevel

private

internal debugging level (for New and Newton fitter only)

Definition at line 90 of file ParticleKinematicFitterModule.h.

m_decaydescriptor

DecayDescriptor m_decaydescriptor

private

Decay descriptor of decays to look for.

Definition at line 120 of file ParticleKinematicFitterModule.h.

m_decayString

std::string m_decayString

private

daughter particles selection

Definition at line 119 of file ParticleKinematicFitterModule.h.

m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

m_eventextrainfo

StoreObjPtr<EventExtraInfo> m_eventextrainfo

private

StoreObjPtr for the EventExtraInfo in this mode.

Definition at line 103 of file ParticleKinematicFitterModule.h.

m_fixUnmeasuredPhotonToHER

bool m_fixUnmeasuredPhotonToHER

private

fix the momentum of the unmeasured photon to HER

Definition at line 92 of file ParticleKinematicFitterModule.h.

m_fixUnmeasuredPhotonToLER

bool m_fixUnmeasuredPhotonToLER

private

fix the momentum of the unmeasured photon to LER

Definition at line 93 of file ParticleKinematicFitterModule.h.

m_hardConstraintE

MomentumConstraint m_hardConstraintE

private

hard beam constraint E

Definition at line 112 of file ParticleKinematicFitterModule.h.

m_hardConstraintMass

MassConstraint m_hardConstraintMass

private

hard mass constraint

Definition at line 116 of file ParticleKinematicFitterModule.h.

m_hardConstraintPx

MomentumConstraint m_hardConstraintPx

private

hard beam constraint px

Definition at line 109 of file ParticleKinematicFitterModule.h.

m_hardConstraintPy

MomentumConstraint m_hardConstraintPy

private

hard beam constraint py

Definition at line 110 of file ParticleKinematicFitterModule.h.

m_hardConstraintPz

MomentumConstraint m_hardConstraintPz

private

hard beam constraint pz

Definition at line 111 of file ParticleKinematicFitterModule.h.

m_hardConstraintRecoilMass

RecoilMassConstraint m_hardConstraintRecoilMass

private

hard recoil mass constraint

Definition at line 114 of file ParticleKinematicFitterModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_invMass

double m_invMass

private

Invariant mass for Mass constraint.

Definition at line 99 of file ParticleKinematicFitterModule.h.

m_kinematicFitter

std::string m_kinematicFitter

private

Kinematic Fitter name.

Definition at line 85 of file ParticleKinematicFitterModule.h.

m_liftPhotonTheta

bool m_liftPhotonTheta

private

lift theta constraint of the 3CPhoton.

Valid when add3CPhoton is true.

Definition at line 95 of file ParticleKinematicFitterModule.h.

m_listName

std::string m_listName

private

particle list name

Definition at line 84 of file ParticleKinematicFitterModule.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

m_orcaConstraint

std::string m_orcaConstraint

private

Constraint (softBeam, hardBeam (default))

Definition at line 88 of file ParticleKinematicFitterModule.h.

m_orcaFitterEngine

std::string m_orcaFitterEngine

private

Orca Fitter Engine name.

Definition at line 86 of file ParticleKinematicFitterModule.h.

m_orcaTracer

std::string m_orcaTracer

private

Tracer (None, Text or ROOT)

Definition at line 87 of file ParticleKinematicFitterModule.h.

m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

m_plist

StoreObjPtr<ParticleList> m_plist

private

StoreObjPtr for the particle list.

Definition at line 106 of file ParticleKinematicFitterModule.h.

m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

m_recoilMass

double m_recoilMass

private

Recoil mass for RecoilMass constraint.

Definition at line 98 of file ParticleKinematicFitterModule.h.

m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

m_textTracer

TextTracer* m_textTracer

private

internal text output variable

Definition at line 102 of file ParticleKinematicFitterModule.h.

m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

m_unmeasuredGammaFitObject

std::vector<double> m_unmeasuredGammaFitObject

private

unmeasured fit object

Definition at line 105 of file ParticleKinematicFitterModule.h.

m_unmeasuredLeptonFitObject

std::vector<double> m_unmeasuredLeptonFitObject

private

unmeasured fit object

Definition at line 104 of file ParticleKinematicFitterModule.h.

m_updateDaughters

bool m_updateDaughters

private

update daughter kinematics

Definition at line 97 of file ParticleKinematicFitterModule.h.

m_updateMother

bool m_updateMother

private

update mother kinematics

Definition at line 96 of file ParticleKinematicFitterModule.h.

---

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

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