Vertex fitter module. More...

#include <ParticleVertexFitterModule.h>

Inheritance diagram for ParticleVertexFitterModule:

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

virtual void	initialize () override
	Initialize the Module.

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

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	endRun ()
	This method is called if the current run ends.

virtual void	terminate ()
	This method is called at the end of the event processing.

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

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

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

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

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

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

LogConfig &	getLogConfig ()
	Returns the log system configuration.

void	setLogConfig (const LogConfig &logConfig)
	Set the log system configuration.

void	setLogLevel (int logLevel)
	Configure the log level.

void	setDebugLevel (int debugLevel)
	Configure the debug messaging level.

void	setAbortLevel (int abortLevel)
	Configure the abort log level.

void	setLogInfo (int logLevel, unsigned int logInfo)
	Configure the printed log information for the given level.

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

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

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

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

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

const std::vector< ModuleCondition > &	getAllConditions () const
	Return all set conditions for this module.

bool	evalCondition () const
	If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

std::shared_ptr< Path >	getConditionPath () const
	Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
bool	doVertexFit (Particle *p)
	Main steering routine.

bool	doKVertexFit (Particle *p, bool ipProfileConstraint, bool ipTubeConstraint)
	Unconstrained vertex fit using KFit.

bool	doKMassVertexFit (Particle *p)
	Mass-constrained vertex fit using KFit.

bool	doKMassPointingVertexFit (Particle *p)
	Mass-constrained vertex fit with additional pointing constraint using KFit.

bool	doKMassFit (Particle *p)
	Mass fit using KFit.

bool	doKFourCFit (Particle *p)
	FourC fit using KFit.

bool	doKMassFourCFit (Particle *p)
	MassFourC fit using KFit.

bool	doKRecoilMassFit (Particle *p)
	RecoilMass fit using KFit.

bool	makeKVertexMother (analysis::VertexFitKFit &kv, Particle *p)
	Update mother particle after unconstrained vertex fit using KFit.

bool	makeKMassVertexMother (analysis::MassVertexFitKFit &kv, Particle *p)
	Update mother particle after mass-constrained vertex fit using KFit.

bool	makeKMassPointingVertexMother (analysis::MassPointingVertexFitKFit &kv, Particle *p)
	Update mother particle after mass-constrained vertex fit with additional pointing constraint using KFit.

bool	makeKMassMother (analysis::MassFitKFit &kv, Particle *p)
	Update mother particle after mass fit using KFit.

bool	makeKFourCMother (analysis::FourCFitKFit &kv, Particle *p)
	Update mother particle after FourC fit using KFit.

bool	makeMassKFourCMother (analysis::MassFourCFitKFit &kv, Particle *p)
	Update mother particle after MassFourC fit using KFit.

bool	makeKRecoilMassMother (analysis::RecoilMassKFit &kf, Particle *p)
	Update mother particle after RecoilMass fit using KFit.

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	addChildofParticletoKFit (analysis::FourCFitKFit &kv, const Particle *particle)
	Adds given particle's child to the FourCFitKFit.

bool	addChildofParticletoMassKFit (analysis::MassFourCFitKFit &kf, const Particle *particle, std::vector< unsigned > &particleId)
	Adds given particle's child to the MassFourCFitKFit.

void	addIPProfileToKFit (analysis::VertexFitKFit &kv)
	Adds IPProfile constraint to the vertex fit using KFit.

void	addIPTubeToKFit (analysis::VertexFitKFit &kv)
	Adds IPTube constraint to the vertex fit using KFit.

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

bool	fillNotFitParticles (const Particle mother, std::vector< const Particle > &notFitChildren, const std::vector< const Particle * > &fitChildren)
	Fills valid particle's children (with valid error matrix) in the vector of Particles that will not enter the fit.

bool	redoTwoPhotonDaughterMassFit (Particle postFit, const Particle preFit, const analysis::VertexFitKFit &kv)
	Combines preFit particle and vertex information from vertex fit kv to create new postFit particle.

bool	doRaveFit (Particle *mother)
	Fit using Rave.

bool	allSelectedDaughters (const Particle mother, const std::vector< const Particle > &tracksVertex)
	check if all the Daughters (o grand-daughters) are selected for the vertex fit

void	findConstraintBoost (double cut)
	calculate iptube constraint (quasi cylinder along boost direction) for RAVE fit

void	smearBeamSpot (double width)
	smear beam spot covariance

double	getChi2TracksLBoost (const analysis::VertexFitKFit &kv)
	calculate the chi2 using only lboost information of tracks

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
StoreObjPtr< ParticleList >	m_plist
	particle list

std::string	m_listName
	particle list name

double	m_confidenceLevel
	required fit confidence level

double	m_Bfield
	magnetic field from data base

std::string	m_vertexFitter
	Vertex Fitter name.

std::string	m_fitType
	type of the kinematic fit

std::string	m_withConstraint
	additional constraint on vertex

std::string	m_decayString
	daughter particles selection

bool	m_updateDaughters
	flag for daughters update

DecayDescriptor	m_decaydescriptor
	Decay descriptor of decays to look for.

bool	m_hasCovMatrix = false
	flag for mother covariance matrix (PseudoFitter)

ROOT::Math::XYZVector	m_BeamSpotCenter
	Beam spot position.

TMatrixDSym	m_beamSpotCov
	Beam spot covariance matrix.

DBObjPtr< BeamSpot >	m_beamSpotDB
	Beam spot database object.

double	m_smearing
	smearing width applied to IP tube

double	m_recoilMass
	recoil mass for constraint

std::vector< int >	m_massConstraintList
	PDG codes of the particles to be mass constraint (massfourC)

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

Vertex fitter module.

Definition at line 45 of file ParticleVertexFitterModule.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

◆ ParticleVertexFitterModule()

ParticleVertexFitterModule ( )

Constructor.

Definition at line 66 of file ParticleVertexFitterModule.cc.

                                                       : Module(),
  m_Bfield(0)
{
  // set module description (e.g. insert text)
  setDescription("Vertex fitter for modular analysis");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // Add parameters
  addParam("listName", m_listName, "name of particle list", string(""));
  addParam("confidenceLevel", m_confidenceLevel,
           "Confidence level to accept the fit. Particle candidates with "
           "p-value less than confidenceLevel are removed from the particle "
           "list. If set to -1, all candidates are kept; if set to 0, "
           "the candidates failing the fit are removed.",
           0.001);
  addParam("vertexFitter", m_vertexFitter, "KFit or Rave", string("KFit"));
  addParam("fitType", m_fitType, "type of the kinematic fit (vertex, massvertex, mass)", string("vertex"));
  addParam("withConstraint", m_withConstraint,
           "additional constraint on vertex: ipprofile, iptube, mother, iptubecut, pointing, btube",
           string(""));
  addParam("decayString", m_decayString, "specifies which daughter particles are included in the kinematic fit", string(""));
  addParam("updateDaughters", m_updateDaughters, "true: update the daughters after the vertex fit", false);
  addParam("smearing", m_smearing, "smear IP tube width by given length", 0.002);
  addParam("recoilMass", m_recoilMass, "recoil invariant mass (GeV)", 0.);
  addParam("massConstraintList", m_massConstraintList,
           "Type::[int]. List of daughter particles to mass constrain with int = pdg code. (only for MassFourCKFit)", {});
}

Member Function Documentation

◆ addChildofParticletoKFit()

bool addChildofParticletoKFit	(	analysis::FourCFitKFit &	kv,
		const Particle *	particle )

private

Adds given particle's child to the FourCFitKFit.

Parameters

kv	reference to KFit FourCFit object
particle	pointer to particle

Definition at line 1424 of file ParticleVertexFitterModule.cc.

{
  for (unsigned ichild = 0; ichild < particle->getNDaughters(); ichild++) {
    const Particle* child = particle->getDaughter(ichild);
    if (child->getNDaughters() > 0) addChildofParticletoKFit(kf, child);
    else {
      if (child->getPValue() < 0) return false; // error matrix not valid
 
      kf.addParticle(child);
    }
  }
  return true;
}

◆ addChildofParticletoMassKFit()

bool addChildofParticletoMassKFit	(	analysis::MassFourCFitKFit &	kf,
		const Particle *	particle,
		std::vector< unsigned > &	particleId )

private

Adds given particle's child to the MassFourCFitKFit.

Parameters

kf	reference to KFit FourCFit object
particle	pointer to particle
particleId	vector of daughters track id

Definition at line 1438 of file ParticleVertexFitterModule.cc.

{
  for (unsigned ichild = 0; ichild < particle->getNDaughters(); ichild++) {
    const Particle* child = particle->getDaughter(ichild);
    if (child->getNDaughters() > 0) {
      bool massconstraint = std::find(m_massConstraintList.begin(), m_massConstraintList.end(),
                                      std::abs(child->getPDGCode())) != m_massConstraintList.end();
      std::vector<unsigned> childId;
      addChildofParticletoMassKFit(kf, child, childId);
      if (massconstraint) kf.addMassConstraint(child->getPDGMass(), childId);
      particleId.insert(particleId.end(), childId.begin(), childId.end());
    } else {
      if (child->getPValue() < 0) return false; // error matrix not valid
      kf.addParticle(child);
      particleId.push_back(kf.getTrackCount() - 1);
    }
  }
  return true;
}

◆ addIPProfileToKFit()

void addIPProfileToKFit ( analysis::VertexFitKFit & kv )

private

Adds IPProfile constraint to the vertex fit using KFit.

Definition at line 1459 of file ParticleVertexFitterModule.cc.

{
  HepPoint3D pos = ROOTToCLHEP::getPoint3D(m_BeamSpotCenter);
  CLHEP::HepSymMatrix covMatrix = ROOTToCLHEP::getHepSymMatrix(m_beamSpotCov);
 
  kv.setIpProfile(pos, covMatrix);
}

◆ addIPTubeToKFit()

void addIPTubeToKFit ( analysis::VertexFitKFit & kv )

private

Adds IPTube constraint to the vertex fit using KFit.

Definition at line 1467 of file ParticleVertexFitterModule.cc.

{
  CLHEP::HepSymMatrix err(7, 0);
 
  for (int i = 0; i < 3; i++) {
    for (int j = 0; j < 3; j++) {
      err[i + 4][j + 4] = m_beamSpotCov(i, j);
    }
  }
 
  PCmsLabTransform T;
  ROOT::Math::PxPyPzEVector iptube_mom = T.getBeamFourMomentum();
 
  kv.setIpTubeProfile(
    ROOTToCLHEP::getHepLorentzVector(iptube_mom),
    ROOTToCLHEP::getPoint3D(m_BeamSpotCenter),
    err,
    0.);
}

◆ allSelectedDaughters()

bool allSelectedDaughters	(	const Particle *	mother,
		const std::vector< const Particle * > &	tracksVertex )

private

check if all the Daughters (o grand-daughters) are selected for the vertex fit

Definition at line 1400 of file ParticleVertexFitterModule.cc.

{
  bool isAll = false;
  if (mother->getNDaughters() == 0) return false;
 
  int nNotIncluded = mother->getNDaughters();
 
  for (unsigned i = 0; i < mother->getNDaughters(); i++) {
    bool dauOk = false;
    for (auto& vi : tracksVertex) {
      if (vi == mother->getDaughter(i)) {
        nNotIncluded = nNotIncluded - 1;
        dauOk = true;
      }
    }
    if (!dauOk) {
      if (allSelectedDaughters(mother->getDaughter(i), tracksVertex)) nNotIncluded--;
    }
  }
  if (nNotIncluded == 0) isAll = true;
  return isAll;
}

◆ beginRun()

void beginRun ( void )

overridevirtual

Called when entering a new run.

Set run dependent things like run header parameters, alignment, etc.

Reimplemented from Module.

Definition at line 120 of file ParticleVertexFitterModule.cc.

{
  // TODO: set magnetic field for each run
  // m_Bfield = BFieldManager::getFieldInTesla(ROOT::Math::XYZVector(0, 0, 0)).Z();
  // TODO: set IP spot size for each run
}

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

425{ beginRun(); }

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

438{ endRun(); }

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

431{ event(); }

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

419{ initialize(); }

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

444{ terminate(); }

◆ doKFourCFit()

bool doKFourCFit ( Particle * p )

private

FourC fit using KFit.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 738 of file ParticleVertexFitterModule.cc.

{
  if (mother->getNDaughters() < 2) return false;
 
  analysis::FourCFitKFit kf;
  kf.setMagneticField(m_Bfield);
 
  for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
    const Particle* child = mother->getDaughter(ichild);
 
    if (child->getNDaughters() > 0) {
      bool err = addChildofParticletoKFit(kf, child);
      if (!err) return false;
    } else {
      if (child->getPValue() < 0) return false; // error matrix not valid
 
      kf.addParticle(child);
    }
  }
 
  // apply four momentum constraint
  PCmsLabTransform T;
  kf.setFourMomentum(T.getBeamFourMomentum());
 
  int err = kf.doFit();
 
  if (err != 0) return false;
 
  bool ok = makeKFourCMother(kf, mother);
 
  return ok;
}

◆ doKMassFit()

bool doKMassFit ( Particle * p )

private

Mass fit using KFit.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 711 of file ParticleVertexFitterModule.cc.

{
  if (mother->getNDaughters() < 2) return false;
 
  analysis::MassFitKFit km;
  km.setMagneticField(m_Bfield);
 
  for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
    const Particle* child = mother->getDaughter(ichild);
 
    if (child->getPValue() < 0) return false; // error matrix not valid
 
    km.addParticle(child);
  }
 
  // apply mass constraint
  km.setInvariantMass(mother->getPDGMass());
 
  int err = km.doFit();
 
  if (err != 0) return false;
 
  bool ok = makeKMassMother(km, mother);
 
  return ok;
}

◆ doKMassFourCFit()

bool doKMassFourCFit ( Particle * p )

private

MassFourC fit using KFit.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 771 of file ParticleVertexFitterModule.cc.

{
  if (mother->getNDaughters() < 2) return false;
 
  analysis::MassFourCFitKFit kf;
  kf.setMagneticField(m_Bfield);
 
  for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
    const Particle* child = mother->getDaughter(ichild);
 
    if (child->getNDaughters() > 0) {
      bool massconstraint = std::find(m_massConstraintList.begin(), m_massConstraintList.end(),
                                      std::abs(child->getPDGCode())) != m_massConstraintList.end();
      std::vector<unsigned> childId;
      bool err = addChildofParticletoMassKFit(kf, child, childId);
      if (massconstraint) kf.addMassConstraint(child->getPDGMass(), childId);
      if (!err) return false;
    } else {
      if (child->getPValue() < 0) return false; // error matrix not valid
      kf.addParticle(child);
    }
  }
 
  // apply four momentum constraint
  PCmsLabTransform T;
  kf.setFourMomentum(T.getBeamFourMomentum());
 
  int err = kf.doFit();
 
  if (err != 0) return false;
 
  bool ok = makeMassKFourCMother(kf, mother);
 
  return ok;
}

◆ doKMassPointingVertexFit()

bool doKMassPointingVertexFit ( Particle * p )

private

Mass-constrained vertex fit with additional pointing constraint using KFit.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 666 of file ParticleVertexFitterModule.cc.

{
  if (!(mother->hasExtraInfo("prodVertX") && mother->hasExtraInfo("prodVertY") && mother->hasExtraInfo("prodVertZ"))) {
    return false;
  }
 
  if (mother->getNDaughters() < 2) return false;
 
  std::vector<const Particle*> fitChildren;
  std::vector<const Particle*> twoPhotonChildren;
  bool validChildren = fillFitParticles(mother, fitChildren, twoPhotonChildren);
 
  if (!validChildren)
    return false;
 
  if (twoPhotonChildren.size() > 0) {
    B2FATAL("[ParticleVertexFitterModule::doKMassPointingVertexFit] MassPointingVertex fit using KFit does not support fit with two-photon daughters (yet).");
  }
 
  if (fitChildren.size() < 2) {
    B2WARNING("[ParticleVertexFitterModule::doKMassPointingVertexFit] Number of particles with valid error matrix entering the vertex fit using KFit is less than 2.");
    return false;
  }
 
  bool ok = false;
  // Initialise the Fitter
  analysis::MassPointingVertexFitKFit kmpv;
  kmpv.setMagneticField(m_Bfield);
 
  for (auto child : fitChildren)
    kmpv.addParticle(child);
 
  kmpv.setInvariantMass(mother->getPDGMass());
  HepPoint3D productionVertex(mother->getExtraInfo("prodVertX"),
                              mother->getExtraInfo("prodVertY"),
                              mother->getExtraInfo("prodVertZ"));
  kmpv.setProductionVertex(productionVertex);
  int err = kmpv.doFit();
  if (err != 0) return false;
 
  ok = makeKMassPointingVertexMother(kmpv, mother);
 
  return ok;
}

◆ doKMassVertexFit()

bool doKMassVertexFit ( Particle * p )

private

Mass-constrained vertex fit using KFit.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 579 of file ParticleVertexFitterModule.cc.

{
  if (mother->getNDaughters() < 2) return false;
 
  std::vector<const Particle*> fitChildren;
  std::vector<const Particle*> twoPhotonChildren;
  bool validChildren = fillFitParticles(mother, fitChildren, twoPhotonChildren);
 
  if (!validChildren)
    return false;
 
  if (twoPhotonChildren.size() > 1) {
    B2FATAL("[ParticleVertexFitterModule::doKVertexFit] MassVertex fit using KFit does not support fit with multiple particles decaying to two photons like pi0 (yet).");
  }
 
  if (fitChildren.size() < 2) {
    B2WARNING("[ParticleVertexFitterModule::doKVertexFit] Number of particles with valid error matrix entering the vertex fit using KFit is less than 2.");
    return false;
  }
 
  bool ok = false;
  if (twoPhotonChildren.size() == 0) {
    // Initialise the Fitter
    analysis::MassVertexFitKFit kmv;
    kmv.setMagneticField(m_Bfield);
 
    if (mother->getV0()) {
      HepPoint3D V0vertex_heppoint(mother->getV0()->getFittedVertexX(),
                                   mother->getV0()->getFittedVertexY(),
                                   mother->getV0()->getFittedVertexZ());
      kmv.setInitialVertex(V0vertex_heppoint);
    }
 
    for (auto child : fitChildren)
      kmv.addParticle(child);
 
    kmv.setInvariantMass(mother->getPDGMass());
    int err = kmv.doFit();
    if (err != 0)
      return false;
 
    // in the case daughters do not include particles with two photon daughters like pi0 - this is it (fit done)
    ok = makeKMassVertexMother(kmv, mother);
  } else if (twoPhotonChildren.size() == 1) {
    // there is a daughter reconstructed from two photons so without position information
    // 1. determine vertex based on all other valid daughters
    // 2. set position and error matrix of two-photon daughter to previously determined vertex
    // 3. redo the fit using all particles (including two-photon particle this time)
 
    analysis::VertexFitKFit kv;
    kv.setMagneticField(m_Bfield);
 
    for (auto child : fitChildren)
      kv.addParticle(child);
 
    // Perform vertex fit using only the particles with valid error matrices
    int err = kv.doFit();
    if (err != 0)
      return false;
 
    const Particle* twoPhotonDaughter = twoPhotonChildren[0];
    Particle fixedTwoPhotonDaughter(twoPhotonDaughter->get4Vector(), twoPhotonDaughter->getPDGCode());
    ok = redoTwoPhotonDaughterMassFit(&fixedTwoPhotonDaughter, twoPhotonDaughter, kv);
    if (!ok)
      return false;
 
    // finally perform the fit using all daughter particles
    analysis::MassVertexFitKFit kmv2;
    kmv2.setMagneticField(m_Bfield);
 
    for (auto child : fitChildren)
      kmv2.addParticle(child);
    kmv2.addParticle(&fixedTwoPhotonDaughter);
 
    kmv2.setInvariantMass(mother->getPDGMass());
    err = kmv2.doFit();
 
    if (err != 0)
      return false;
 
    ok = makeKMassVertexMother(kmv2, mother);
  }
 
  return ok;
 
}

◆ doKRecoilMassFit()

bool doKRecoilMassFit ( Particle * p )

private

RecoilMass fit using KFit.

Parameters

p	pointer to particle

Returns: true for successful fit

Definition at line 807 of file ParticleVertexFitterModule.cc.

{
  analysis::RecoilMassKFit kf;
  kf.setMagneticField(m_Bfield);
 
  for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
    const Particle* child = mother->getDaughter(ichild);
 
    if (child->getPValue() < 0) return false; // error matrix not valid
 
    kf.addParticle(child);
  }
 
  // apply four momentum constraint
  PCmsLabTransform T;
  kf.setFourMomentum(T.getBeamFourMomentum());
 
  // apply recoil mass constraint
  kf.setRecoilMass(m_recoilMass);
 
  int err = kf.doFit();
 
  if (err != 0) return false;
 
  bool ok = makeKRecoilMassMother(kf, mother);
 
  return ok;
}

◆ doKVertexFit()

bool doKVertexFit	(	Particle *	p,
		bool	ipProfileConstraint,
		bool	ipTubeConstraint )

private

Unconstrained vertex fit using KFit.

Parameters

p	pointer to particle
ipProfileConstraint	flag for IP profile constraint
ipTubeConstraint	flag for IP tube constraint

Returns: true for successful fit

Definition at line 483 of file ParticleVertexFitterModule.cc.

{
  if ((mother->getNDaughters() < 2 && !ipTubeConstraint) || mother->getNDaughters() < 1) return false;
 
  std::vector<const Particle*> fitChildren;
  std::vector<const Particle*> twoPhotonChildren;
  bool validChildren = fillFitParticles(mother, fitChildren, twoPhotonChildren);
 
  if (!validChildren)
    return false;
 
  std::vector<const Particle*> notFitChildren;
  fillNotFitParticles(mother, notFitChildren, fitChildren);
 
 
  if (twoPhotonChildren.size() > 1) {
    B2FATAL("[ParticleVertexFitterModule::doKVertexFit] Vertex fit using KFit does not support fit with multiple particles decaying to two photons like pi0 (yet).");
  }
 
  if ((fitChildren.size() < 2 && !ipTubeConstraint) || fitChildren.size() < 1) {
    B2WARNING("[ParticleVertexFitterModule::doKVertexFit] Number of particles with valid error matrix entering the vertex fit using KFit is too low.");
    return false;
  }
 
  // Initialise the Fitter
  analysis::VertexFitKFit kv;
  kv.setMagneticField(m_Bfield);
 
  if (mother->getV0()) {
    kv.setInitialVertex(mother->getV0()->getFittedVertexPosition());
  }
 
  for (auto& child : fitChildren)
    kv.addParticle(child);
 
  if (ipProfileConstraint)
    addIPProfileToKFit(kv);
 
  if (ipTubeConstraint)
    addIPTubeToKFit(kv);
 
  // Perform vertex fit using only the particles with valid error matrices
  int err = kv.doFit();
  if (err != 0)
    return false;
 
  double chi2_track = getChi2TracksLBoost(kv);
  unsigned track_count = kv.getTrackCount();
  mother->writeExtraInfo("chiSquared_trackL", chi2_track);
  mother->writeExtraInfo("kFit_nTracks", track_count);
 
  bool ok = false;
  if (twoPhotonChildren.size() == 0)
    // in the case daughters do not include pi0 - this is it (fit done)
    ok = makeKVertexMother(kv, mother);
  else if (twoPhotonChildren.size() == 1) {
    // there is a daughter reconstructed from two photons so without position information
    // 1. determine vertex based on all other valid daughters
    // 2. set position and error matrix of two-photon daughter to previously determined vertex
    // 3. redo the fit using all particles (including two-photon particle this time)
 
    const Particle* twoPhotonDaughter = twoPhotonChildren[0];
    Particle fixedTwoPhotonDaughter(twoPhotonDaughter->get4Vector(), twoPhotonDaughter->getPDGCode());
    ok = redoTwoPhotonDaughterMassFit(&fixedTwoPhotonDaughter, twoPhotonDaughter, kv);
    if (!ok)
      return false;
 
    // finally perform the fit using all daughter particles
    analysis::VertexFitKFit kv2;
    kv2.setMagneticField(m_Bfield);
 
    for (auto& child : fitChildren)
      kv2.addParticle(child);
 
    kv2.addParticle(&fixedTwoPhotonDaughter);
 
    if (ipProfileConstraint)
      addIPProfileToKFit(kv2);
 
    err = kv2.doFit();
 
    if (err != 0)
      return false;
 
    ok = makeKVertexMother(kv2, mother);
  }
 
  // update 4-vector using not-fit-particles
  ROOT::Math::PxPyPzEVector total4Vector(mother->get4Vector());
  for (auto& child : notFitChildren)
    total4Vector += child->get4Vector();
  mother->set4Vector(total4Vector);
 
  return ok;
}

◆ doRaveFit()

bool doRaveFit ( Particle * mother )

private

Fit using Rave.

Parameters

mother pointer to particle

Returns: true for successful fit and update of mother

Definition at line 1245 of file ParticleVertexFitterModule.cc.

{
  if ((m_decayString.empty() ||
       (m_withConstraint == "" && m_fitType != "mass")) && mother->getNDaughters() < 2) return false;
  if (m_withConstraint == "") analysis::RaveSetup::getInstance()->unsetBeamSpot();
  if (m_withConstraint == "ipprofile" || m_withConstraint == "iptube"  || m_withConstraint == "mother"
      || m_withConstraint == "iptubecut" || m_withConstraint == "btube")
    analysis::RaveSetup::getInstance()->setBeamSpot(m_BeamSpotCenter, m_beamSpotCov);
 
  analysis::RaveKinematicVertexFitter rf;
  if (m_fitType == "mass") rf.setVertFit(false);
 
  if (m_decayString.empty()) {
    rf.addMother(mother);
  } else {
    std::vector<const Particle*> tracksVertex = m_decaydescriptor.getSelectionParticles(mother);
    std::vector<std::string> tracksName = m_decaydescriptor.getSelectionNames();
 
    if (allSelectedDaughters(mother, tracksVertex)) {
      for (auto& itrack : tracksVertex) {
        if (itrack != mother) rf.addTrack(itrack);
      }
      rf.setMother(mother);
    } else {
 
      analysis::RaveKinematicVertexFitter rsf;
      bool mothSel = false;
      int nTrk = 0;
      for (unsigned itrack = 0; itrack < tracksVertex.size(); itrack++) {
        if (tracksVertex[itrack] != mother) {
          rsf.addTrack(tracksVertex[itrack]);
          B2DEBUG(1, "ParticleVertexFitterModule: Adding particle " << tracksName[itrack] << " to vertex fit ");
          nTrk++;
        }
        if (tracksVertex[itrack] == mother) mothSel = true;
      }
 
 
      // Fit one particle constrained to originate from the beam spot
      bool mothIPfit = false;
      if (tracksVertex.size() == 1 && mothSel == true && m_withConstraint != "" && nTrk == 0) {
        rsf.addTrack(tracksVertex[0]);
        if (tracksVertex[0] != mother)
          B2FATAL("ParticleVertexFitterModule: FATAL Error in IP constrained mother fit");
        nTrk++;
        mothIPfit = true;
      }
 
 
      ROOT::Math::XYZVector pos;
      TMatrixDSym RerrMatrix(3);
      int nvert = 0;
 
      // one track fit is not kinematic
      if (nTrk == 1) {
        analysis::RaveVertexFitter rsg;
        for (auto& itrack : tracksVertex) {
          rsg.addTrack(itrack);
          nvert = rsg.fit("kalman");
          if (nvert > 0) {
            pos = rsg.getPos(0);
            RerrMatrix = rsg.getCov(0);
            double prob = rsg.getPValue(0);
            ROOT::Math::PxPyPzEVector mom(mother->get4Vector());
            TMatrixDSym errMatrix(7);
            for (int i = 0; i < 7; i++) {
              for (int j = 0; j < 7; j++) {
                if (i > 3 && j > 3) {errMatrix[i][j] = RerrMatrix[i - 4][j - 4];}
                else {errMatrix[i][j] = 0;}
              }
            }
            if (mothIPfit) {
              mother->writeExtraInfo("prodVertX", pos.X());
              mother->writeExtraInfo("prodVertY", pos.Y());
              mother->writeExtraInfo("prodVertZ", pos.Z());
              mother->writeExtraInfo("prodVertSxx", RerrMatrix[0][0]);
              mother->writeExtraInfo("prodVertSxy", RerrMatrix[0][1]);
              mother->writeExtraInfo("prodVertSxz", RerrMatrix[0][2]);
              mother->writeExtraInfo("prodVertSyx", RerrMatrix[1][0]);
              mother->writeExtraInfo("prodVertSyy", RerrMatrix[1][1]);
              mother->writeExtraInfo("prodVertSyz", RerrMatrix[1][2]);
              mother->writeExtraInfo("prodVertSzx", RerrMatrix[2][0]);
              mother->writeExtraInfo("prodVertSzy", RerrMatrix[2][1]);
              mother->writeExtraInfo("prodVertSzz", RerrMatrix[2][2]);
            } else {
              mother->updateMomentum(mom, pos, errMatrix, prob);
            }
            return true;
          } else {return false;}
        }
      } else {
        nvert = rsf.fit();
      }
 
      if (nvert > 0) {
        pos = rsf.getPos();
        RerrMatrix = rsf.getVertexErrorMatrix();
        double prob = rsf.getPValue();
        ROOT::Math::PxPyPzEVector mom(mother->get4Vector());
        TMatrixDSym errMatrix(7);
        for (int i = 0; i < 7; i++) {
          for (int j = 0; j < 7; j++) {
            if (i > 3 && j > 3) {errMatrix[i][j] = RerrMatrix[i - 4][j - 4];}
            else {errMatrix[i][j] = 0;}
          }
        }
        mother->updateMomentum(mom, pos, errMatrix, prob);
      } else {return false;}
 
 
      if (mothSel && nTrk > 1) {
        analysis::RaveSetup::getInstance()->setBeamSpot(pos, RerrMatrix);
        rf.addMother(mother);
        int nKfit = rf.fit();
        rf.updateMother();
        analysis::RaveSetup::getInstance()->unsetBeamSpot();
 
        if (nKfit > 0) {return true;}
        else return false;
      } else return true;
    }
  }
 
  bool okFT = false;
  if (m_fitType == "vertex") {
    okFT = true;
    int nVert = rf.fit();
    rf.updateMother();
    if (m_decayString.empty() && m_updateDaughters == true) rf.updateDaughters();
    if (nVert != 1) return false;
  }
  if (m_fitType == "mass") {
    // add protection
    okFT = true;
    rf.setMassConstFit(true);
    rf.setVertFit(false);
    int nVert = rf.fit();
    rf.updateMother();
    if (nVert != 1) return false;
  };
  if (m_fitType == "massvertex") {
    okFT = true;
    rf.setMassConstFit(true);
    int nVert = rf.fit();
    rf.updateMother();
    if (m_decayString.empty() && m_updateDaughters == true) rf.updateDaughters();
    if (nVert != 1) return false;
  };
  if (!okFT) {
    B2FATAL("fitType : " << m_fitType << " ***invalid fit type ");
  }
 
  return true;
}

◆ doVertexFit()

bool doVertexFit ( Particle * p )

private

Main steering routine.

Parameters

p	pointer to particle

Returns: true for successful fit and prob(chi^2,ndf) > m_confidenceLevel

Definition at line 205 of file ParticleVertexFitterModule.cc.

{
  // steering starts here
 
  if (m_Bfield == 0) {
    B2FATAL("ParticleVertexFitter: No magnetic field");
  }
 
  if (m_withConstraint != "ipprofile" &&
      m_withConstraint != "iptube" &&
      m_withConstraint != "mother" &&
      m_withConstraint != "iptubecut" &&
      m_withConstraint != "pointing" &&
      m_withConstraint != "btube" &&
      m_withConstraint != "")
    B2FATAL("ParticleVertexFitter: " << m_withConstraint << " ***invalid Constraint ");
 
  bool ok = false;
  // fits with KFit
  if (m_vertexFitter == "KFit") {
 
    if (m_decayString != "" and m_fitType != "vertex")
      B2FATAL("ParticleVertexFitter: KFit does not support yet selection of daughters via decay string except for vertex fit!");
 
    // vertex fit
    if (m_fitType == "vertex") {
      if (m_withConstraint == "ipprofile") {
        ok = doKVertexFit(mother, true, false);
      } else if (m_withConstraint == "iptube") {
        ok = doKVertexFit(mother, false, true);
      } else {
        ok = doKVertexFit(mother, false, false);
      }
    }
 
    // mass-constrained vertex fit
    if (m_fitType == "massvertex") {
      if (m_withConstraint == "ipprofile" || m_withConstraint == "iptube" || m_withConstraint == "iptubecut") {
        B2FATAL("ParticleVertexFitter: Invalid options - mass-constrained fit using KFit does not work with iptube or ipprofile constraint.");
      } else if (m_withConstraint == "pointing") {
        ok = doKMassPointingVertexFit(mother);
      } else {
        ok = doKMassVertexFit(mother);
      }
    }
 
    // mass fit
    if (m_fitType == "mass") {
      if (m_withConstraint == "ipprofile" || m_withConstraint == "iptube" || m_withConstraint == "iptubecut") {
        B2FATAL("ParticleVertexFitter: Invalid options - mass fit using KFit does not work with iptube or ipprofile constraint.");
      } else {
        ok = doKMassFit(mother);
      }
    }
 
    // four C fit
    if (m_fitType == "fourC") {
      if (m_withConstraint == "ipprofile" || m_withConstraint == "iptube" || m_withConstraint == "iptubecut") {
        B2FATAL("ParticleVertexFitter: Invalid options - four C fit using KFit does not work with iptube or ipprofile constraint.");
      } else {
        ok = doKFourCFit(mother);
      }
    }
 
    // four mass C fit
    if (m_fitType == "massfourC") {
      if (m_withConstraint == "ipprofile" || m_withConstraint == "iptube" || m_withConstraint == "iptubecut") {
        B2FATAL("ParticleVertexFitter: Invalid options - four C fit using KFit does not work with iptube or ipprofile constraint.");
      } else {
        ok = doKMassFourCFit(mother);
      }
    }
 
    // recoil mass C fit
    if (m_fitType == "recoilmass") {
      if (m_withConstraint == "ipprofile" || m_withConstraint == "iptube" || m_withConstraint == "iptubecut") {
        B2FATAL("ParticleVertexFitter: Invalid options - recoil mass fit using KFit does not work with iptube or ipprofile constraint.");
      } else {
        ok = doKRecoilMassFit(mother);
      }
    }
 
    // invalid KFit fit type
    if (m_fitType != "vertex"
        && m_fitType != "massvertex"
        && m_fitType != "mass"
        && m_fitType != "fourC"
        && m_fitType != "massfourC"
        && m_fitType != "recoilmass")
      B2FATAL("ParticleVertexFitter: " << m_fitType << " ***invalid fit type for the vertex fitter ");
  }
 
  // fits using Rave
  if (m_vertexFitter == "Rave") {
    try {
      ok = doRaveFit(mother);
    } catch (const rave::CheckedFloatException&) {
      B2ERROR("Invalid inputs (nan/inf)?");
      ok = false;
    }
  }
 
  // invalid fitter
  if (m_vertexFitter != "KFit" && m_vertexFitter != "Rave")
    B2FATAL("ParticleVertexFitter: " << m_vertexFitter << " ***invalid vertex fitter ");
 
  if (!ok) return false;
 
  // steering ends here
 
  //if (mother->getPValue() < m_confidenceLevel) return false;
  return true;
 
}

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

165{};

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

{
  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 ( void )

overridevirtual

Event processor.

Reimplemented from Module.

Definition at line 127 of file ParticleVertexFitterModule.cc.

{
  if (m_vertexFitter == "Rave")
    analysis::RaveSetup::initialize(1, m_Bfield);
 
  m_BeamSpotCenter = m_beamSpotDB->getIPPosition();
  m_beamSpotCov.ResizeTo(3, 3);
  if (m_withConstraint == "ipprofile") m_beamSpotCov = m_beamSpotDB->getCovVertex();
  if (m_withConstraint == "iptube") {
    if (m_smearing > 0 && m_vertexFitter == "KFit") {
      ParticleVertexFitterModule::smearBeamSpot(m_smearing);
    } else {
      ParticleVertexFitterModule::findConstraintBoost(2.);
    }
  }
  if (m_withConstraint == "iptubecut") {  // for development purpose only
    m_BeamSpotCenter = ROOT::Math::XYZVector(0.001, 0., .013);
    findConstraintBoost(0.03);
  }
  if ((m_vertexFitter == "Rave") && (m_withConstraint == "ipprofile" || m_withConstraint == "iptube"
                                     || m_withConstraint == "mother" || m_withConstraint == "iptubecut" || m_withConstraint == "btube"))
    analysis::RaveSetup::getInstance()->setBeamSpot(m_BeamSpotCenter, m_beamSpotCov);
 
  std::vector<unsigned int> toRemove;
  unsigned int nParticles = m_plist->getListSize();
 
  for (unsigned iPart = 0; iPart < nParticles; iPart++) {
    Particle* particle = m_plist->getParticle(iPart);
    m_hasCovMatrix = false;
    if (m_updateDaughters == true) {
      if (m_decayString.empty() || m_vertexFitter == "KFit")
        ParticleCopy::copyDaughters(particle);
      else B2ERROR("Daughters update works only when all daughters are selected. Daughters will not be updated");
    }
 
    if (m_withConstraint == "mother") {
      m_BeamSpotCenter = particle->getVertex();
      m_beamSpotCov = particle->getVertexErrorMatrix();
    }
 
    TMatrixFSym mother_errMatrix(7);
    mother_errMatrix = particle->getMomentumVertexErrorMatrix();
    for (int k = 0; k < 7; k++) {
      for (int j = 0; j < 7; j++) {
        if (mother_errMatrix[k][j] > 0) {
          m_hasCovMatrix = true;
        }
      }
    }
 
    bool hasTube = true;
    if (m_withConstraint == "btube") {
      Btube* Ver = particle->getRelatedTo<Btube>();
      if (!Ver) {
        hasTube = false;
        toRemove.push_back(particle->getArrayIndex());
      } else {
        m_BeamSpotCenter.SetXYZ(Ver->getTubeCenter()(0, 0), Ver->getTubeCenter()(1, 0), Ver->getTubeCenter()(2, 0));
        m_beamSpotCov = Ver->getTubeMatrix();
      }
    }
    bool ok = false;
    if (hasTube) {
      ok = doVertexFit(particle);
    }
    if (!ok)
      particle->setPValue(-1);
    if (particle->getPValue() < m_confidenceLevel)
      toRemove.push_back(particle->getArrayIndex());
 
  }
  m_plist->removeParticles(toRemove);
 
  //free memory allocated by rave. initialize() would be enough, except that we must clean things up before program end...
  if (m_vertexFitter == "Rave")
    analysis::RaveSetup::getInstance()->reset();
}

◆ 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 paths */
  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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  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	(	const Particle *	mother,
		std::vector< const Particle * > &	fitChildren,
		std::vector< const Particle * > &	twoPhotonChildren )

private

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

Particles formed from two photons (e.g. pi0) are treated separately so they are filled to another vector.

Definition at line 320 of file ParticleVertexFitterModule.cc.

{
  if (m_decayString.empty()) {
    // if decayString is empty, just use all primary daughters
    for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
      const Particle* child = mother->getDaughter(ichild);
      // This if allows to skip the daughters, which cannot be used in the fits, particularly K_L0 from KLM.
      // Useful for fully-inclusive particles.
      if (mother->getProperty() == Particle::PropertyFlags::c_IsUnspecified and child->getPValue() < 0) {
        continue;
      }
      fitChildren.push_back(child);
    }
  } else {
    fitChildren = m_decaydescriptor.getSelectionParticles(mother);
  }
 
  auto itr = fitChildren.begin();
  while (itr != fitChildren.end()) {
    const Particle* child = *itr;
 
    if (child->getPValue() < 0) {
      B2WARNING("Daughter with PDG code " << child->getPDGCode() << " does not have a valid error matrix.");
      return false; // error matrix not valid
    }
    bool isTwoPhotonParticle = false;
    if (m_hasCovMatrix == false) {
      if (child->getPDGCode() == Const::pi0.getPDGCode() or child->getPDGCode() == 221) { // pi0 or eta
        if (child->getNDaughters() == 2) {
          if (child->getDaughter(0)->getPDGCode() == Const::photon.getPDGCode()
              && child->getDaughter(1)->getPDGCode() == Const::photon.getPDGCode()) {
            isTwoPhotonParticle = true;
          }
        }
      }
    }
    if (isTwoPhotonParticle) {
      // move children from fitChildren to twoPhotonChildren
      twoPhotonChildren.push_back(child);
      itr = fitChildren.erase(itr);
    } else {
      itr++;
    }
  }
 
  return true;
}

◆ fillNotFitParticles()

bool fillNotFitParticles	(	const Particle *	mother,
		std::vector< const Particle * > &	notFitChildren,
		const std::vector< const Particle * > &	fitChildren )

private

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

Definition at line 369 of file ParticleVertexFitterModule.cc.

{
  if (fitChildren.empty())
    B2WARNING("[ParticleVertexFitterModule::fillNotFitParticles] fitChildren is empty! Please call fillFitParticles firstly");
  if (!notFitChildren.empty())
    B2WARNING("[ParticleVertexFitterModule::fillNotFitParticles] notFitChildren is NOT empty!"
              << " The function should be called only once");
 
  if (m_decayString.empty())
    // if decayString is empty, just use all primary daughters
    return true;
 
  std::function<bool(const Particle*)> funcCheckInFit =
  [&funcCheckInFit, &notFitChildren, fitChildren](const Particle * part) {
 
    // check if the given particle in fitChildren
    // if it is included, return true
    if (std::find(fitChildren.begin(), fitChildren.end(), part) != fitChildren.end())
      return true;
 
    // if not, firstly check if particle has children
    if (part->getNDaughters() == 0)
      // if it has no children (=final-state-particle), return false
      return false;
 
    // here, the given particle is not in fitChildren and has children
    bool isAnyChildrenInFit = false;
    vector<const Particle*> notFitChildren_tmp;
    for (unsigned ichild = 0; ichild < part->getNDaughters(); ichild++) {
      // call funcCheckInFit recursively for all children
      const Particle* child = part->getDaughter(ichild);
      bool isChildrenInFit = funcCheckInFit(child);
      isAnyChildrenInFit = isChildrenInFit or isAnyChildrenInFit;
 
      // if the child is not in fitChildren, fill the child in a temporary vector
      if (!isChildrenInFit)
        notFitChildren_tmp.push_back(child);
    }
 
    // if there are a sister in fitChildren, the children in the temporary vector will be filled in notFitChildren
    if (isAnyChildrenInFit)
      notFitChildren.insert(notFitChildren.end(), notFitChildren_tmp.begin(), notFitChildren_tmp.end());
 
    // if no children in fitChildren, the given particle should be filled instead of all children.
 
    return isAnyChildrenInFit;
  };
 
 
  // call funcCheckInFit for all primary children
  for (unsigned ichild = 0; ichild < mother->getNDaughters(); ichild++) {
    const Particle* child = mother->getDaughter(ichild);
    bool isGivenParticleOrAnyChildrenInFit = funcCheckInFit(child);
    if (!isGivenParticleOrAnyChildrenInFit)
      notFitChildren.push_back(child);
  }
 
  return true;
}

◆ findConstraintBoost()

void findConstraintBoost ( double cut )

private

calculate iptube constraint (quasi cylinder along boost direction) for RAVE fit

Definition at line 1487 of file ParticleVertexFitterModule.cc.

{
  PCmsLabTransform T;
 
  ROOT::Math::XYZVector boostDir = T.getBoostVector().Unit();
 
  TMatrixDSym beamSpotCov = m_beamSpotDB->getCovVertex();
  beamSpotCov(2, 2) = cut * cut;
  double thetab = boostDir.Theta();
  double phib = boostDir.Phi();
 
  double stb = TMath::Sin(thetab);
  double ctb = TMath::Cos(thetab);
  double spb = TMath::Sin(phib);
  double cpb = TMath::Cos(phib);
 
 
  TMatrix rz(3, 3);  rz(2, 2) = 1;
  rz(0, 0) = cpb; rz(0, 1) = spb;
  rz(1, 0) = -1 * spb; rz(1, 1) = cpb;
 
  TMatrix ry(3, 3);  ry(1, 1) = 1;
  ry(0, 0) = ctb; ry(0, 2) = -1 * stb;
  ry(2, 0) = stb; ry(2, 2) = ctb;
 
  TMatrix r(3, 3);  r.Mult(rz, ry);
  TMatrix rt(3, 3); rt.Transpose(r);
 
  TMatrix TubePart(3, 3);  TubePart.Mult(rt, beamSpotCov);
  TMatrix Tube(3, 3); Tube.Mult(TubePart, r);
 
  m_beamSpotCov(0, 0) = Tube(0, 0);  m_beamSpotCov(0, 1) = Tube(0, 1);  m_beamSpotCov(0, 2) = Tube(0, 2);
  m_beamSpotCov(1, 0) = Tube(1, 0);  m_beamSpotCov(1, 1) = Tube(1, 1);  m_beamSpotCov(1, 2) = Tube(1, 2);
  m_beamSpotCov(2, 0) = Tube(2, 0);  m_beamSpotCov(2, 1) = Tube(2, 1);  m_beamSpotCov(2, 2) = Tube(2, 2);
}

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

    {
      return m_conditions;
    }

◆ getChi2TracksLBoost()

double getChi2TracksLBoost ( const analysis::VertexFitKFit & kv )

private

calculate the chi2 using only lboost information of tracks

Definition at line 1532 of file ParticleVertexFitterModule.cc.

{
  double chi2TrackL = 0;
 
  for (int iTrack = 0; iTrack < kv.getTrackCount(); iTrack++) {
 
    analysis::KFitTrack trk_i = kv.getTrack(iTrack); // KFitTrack contains parameters before/after fit.
 
    TMatrixFSym err = CLHEPToROOT::getTMatrixFSym(trk_i.getError(analysis::KFitConst::kBeforeFit)); // px, py, pz, E, x, y, z
 
    ROOT::Math::XYZVector x_before = CLHEPToROOT::getXYZVector(trk_i.getPosition(analysis::KFitConst::kBeforeFit));
    ROOT::Math::XYZVector x_after = CLHEPToROOT::getXYZVector(trk_i.getPosition());
    ROOT::Math::XYZVector dPos = x_after - x_before;
 
    PCmsLabTransform T;
    ROOT::Math::XYZVector boost3 = T.getBoostVector().Unit();
    TVectorD boostD(0, 6, 0., 0., 0., 0., boost3.X(), boost3.Y(), boost3.Z(), "END");
 
    double dLBoost = dPos.Dot(boost3);
 
    chi2TrackL += TMath::Power(dLBoost, 2) / err.Similarity(boostD);
  }
  return chi2TrackL;
}

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 313 of file Module.h.

    {
      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;
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

201{return m_description;}

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 186 of file Module.h.

186{return m_name;}

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

196{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

380{ return m_returnValue; }

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

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

377{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

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

Parameters

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

overridevirtual

Initialize the Module.

This method is called at the beginning of data processing.

Reimplemented from Module.

Definition at line 94 of file ParticleVertexFitterModule.cc.

{
  // Particle list with name m_listName has to exist
  m_plist.isRequired(m_listName);
 
  // magnetic field
  m_Bfield = BFieldManager::getFieldInTesla(ROOT::Math::XYZVector(0, 0, 0)).Z();
 
  // RAVE setup
  if (m_vertexFitter == "Rave")
    analysis::RaveSetup::initialize(1, m_Bfield);
 
  B2DEBUG(1, "ParticleVertexFitterModule : magnetic field = " << m_Bfield);
 
 
  if (m_decayString != "")
    m_decaydescriptor.init(m_decayString);
 
  B2INFO("ParticleVertexFitter: Performing " << m_fitType << " fit on " << m_listName << " using " << m_vertexFitter);
  if (m_decayString != "")
    B2INFO("ParticleVertexFitter: Using specified decay string: " << m_decayString);
  if (m_withConstraint != "")
    B2INFO("ParticleVertexFitter: Additional " << m_withConstraint << " will be applied");
 
}

◆ makeKFourCMother()

bool makeKFourCMother	(	analysis::FourCFitKFit &	kv,
		Particle *	p )

private

Update mother particle after FourC fit using KFit.

Parameters

kv	reference to KFit MassFit object
p	pointer to particle

Returns: true for successful construction of mother

Definition at line 1054 of file ParticleVertexFitterModule.cc.

{
  enum analysis::KFitError::ECode fitError;
  fitError = kf.updateMother(mother);
  if (fitError != analysis::KFitError::kNoError)
    return false;
  mother->addExtraInfo("FourCFitProb", kf.getCHIsq());
  mother->addExtraInfo("FourCFitChi2", kf.getNDF());
  if (m_decayString.empty() && m_updateDaughters == true) {
    // update daughter momenta as well
    // the order of daughters in the *fitter is the same as in the mother Particle
 
    std::vector<Particle*> daughters = mother->getDaughters();
 
    const unsigned nd = daughters.size();
    unsigned l = 0;
    std::vector<std::vector<unsigned>> pars;
    pars.reserve(nd);
    std::vector<Particle*> allparticles;
    allparticles.reserve(nd);
    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(std::move(pard));
        allparticles.push_back(daughters[ichild]);
      } else {
        pard.push_back(l);
        pars.push_back(std::move(pard));
        allparticles.push_back(daughters[ichild]);
        l++;
      }
    }
 
    unsigned track_count = kf.getTrackCount();
    if (l != track_count)
      return false;
 
    for (unsigned iDaug = 0; iDaug < allparticles.size(); iDaug++) {
      ROOT::Math::PxPyPzEVector childMoms;
      ROOT::Math::XYZVector childPoss;
      TMatrixFSym childErrMatrixs(7);
      for (unsigned int iChild : pars[iDaug]) {
        childMoms = childMoms +
                    CLHEPToROOT::getLorentzVector(
                      kf.getTrackMomentum(iChild));
        childPoss = childPoss +
                    CLHEPToROOT::getXYZVector(
                      kf.getTrackPosition(iChild));
        TMatrixFSym childErrMatrix =
          CLHEPToROOT::getTMatrixFSym(kf.getTrackError(iChild));
        childErrMatrixs = childErrMatrixs + childErrMatrix;
      }
      allparticles[iDaug]->set4Vector(childMoms);
      allparticles[iDaug]->setVertex(childPoss);
      allparticles[iDaug]->setMomentumVertexErrorMatrix(childErrMatrixs);
    }
  }
 
  return true;
}

◆ makeKMassMother()

bool makeKMassMother	(	analysis::MassFitKFit &	kv,
		Particle *	p )

private

Update mother particle after mass fit using KFit.

Parameters

kv	reference to KFit MassFit object
p	pointer to particle

Returns: true for successful construction of mother

Definition at line 1014 of file ParticleVertexFitterModule.cc.

{
  enum analysis::KFitError::ECode fitError;
  fitError = km.updateMother(mother);
  if (fitError != analysis::KFitError::kNoError)
    return false;
  if (m_decayString.empty() && m_updateDaughters == true) {
    // update daughter momenta as well
    // the order of daughters in the *fitter is the same as in the mother Particle
 
    std::vector<Particle*> daughters = mother->getDaughters();
 
    unsigned track_count = km.getTrackCount();
    if (daughters.size() != track_count)
      return false;
 
    for (unsigned iChild = 0; iChild < track_count; iChild++) {
      double a = -1 * Const::speedOfLight * 1e-4 * m_Bfield * daughters[iChild]->getCharge();
      double dx = km.getVertex().x() - km.getTrackPosition(iChild).x();
      double dy = km.getVertex().y() - km.getTrackPosition(iChild).y();
 
      ROOT::Math::PxPyPzEVector i4Vector(km.getTrackMomentum(iChild).x() - a * dy,
                                         km.getTrackMomentum(iChild).y() + a * dx,
                                         km.getTrackMomentum(iChild).z(),
                                         km.getTrackMomentum(iChild).t());
      daughters[iChild]->set4VectorDividingByMomentumScaling(i4Vector);
 
      daughters[iChild]->setVertex(
        CLHEPToROOT::getXYZVector(km.getTrackPosition(iChild)));
      daughters[iChild]->setMomentumVertexErrorMatrix(
        CLHEPToROOT::getTMatrixFSym(km.getTrackError(iChild)));
    }
  }
 
  return true;
}

◆ makeKMassPointingVertexMother()

bool makeKMassPointingVertexMother	(	analysis::MassPointingVertexFitKFit &	kv,
		Particle *	p )

private

Update mother particle after mass-constrained vertex fit with additional pointing constraint using KFit.

Parameters

kv	reference to KFit MassPointingVertexFit object
p	pointer to particle

Returns: true for successful construction of mother

Definition at line 973 of file ParticleVertexFitterModule.cc.

{
  enum analysis::KFitError::ECode fitError;
  fitError = kmpv.updateMother(mother);
  if (fitError != analysis::KFitError::kNoError) {
    return false;
  }
 
  if (m_decayString.empty() && m_updateDaughters == true) {
    // update daughter momenta as well
    // the order of daughters in the *fitter is the same as in the mother Particle
 
    std::vector<Particle*> daughters = mother->getDaughters();
 
    unsigned track_count = kmpv.getTrackCount();
    if (daughters.size() != track_count)
      return false;
 
    for (unsigned iChild = 0; iChild < track_count; iChild++) {
      double a = -1 * Const::speedOfLight * 1e-4 * m_Bfield * daughters[iChild]->getCharge();
      double dx = kmpv.getVertex().x() - kmpv.getTrackPosition(iChild).x();
      double dy = kmpv.getVertex().y() - kmpv.getTrackPosition(iChild).y();
 
      ROOT::Math::PxPyPzEVector i4Vector(kmpv.getTrackMomentum(iChild).x() - a * dy,
                                         kmpv.getTrackMomentum(iChild).y() + a * dx,
                                         kmpv.getTrackMomentum(iChild).z(),
                                         kmpv.getTrackMomentum(iChild).t());
      daughters[iChild]->set4VectorDividingByMomentumScaling(i4Vector);
 
      daughters[iChild]->setVertex(
        CLHEPToROOT::getXYZVector(kmpv.getTrackPosition(iChild)));
      daughters[iChild]->setMomentumVertexErrorMatrix(
        CLHEPToROOT::getTMatrixFSym(kmpv.getTrackError(iChild)));
    }
  }
 
  return true;
}

◆ makeKMassVertexMother()

bool makeKMassVertexMother	(	analysis::MassVertexFitKFit &	kv,
		Particle *	p )

private

Update mother particle after mass-constrained vertex fit using KFit.

Parameters

kv	reference to KFit MassVertexFit object
p	pointer to particle

Returns: true for successful construction of mother

Definition at line 935 of file ParticleVertexFitterModule.cc.

{
  enum analysis::KFitError::ECode fitError;
  fitError = kmv.updateMother(mother);
  if (fitError != analysis::KFitError::kNoError)
    return false;
  if (m_decayString.empty() && m_updateDaughters == true) {
    // update daughter momenta as well
    // the order of daughters in the *fitter is the same as in the mother Particle
 
    std::vector<Particle*> daughters = mother->getDaughters();
 
    unsigned track_count = kmv.getTrackCount();
    if (daughters.size() != track_count)
      return false;
 
    for (unsigned iChild = 0; iChild < track_count; iChild++) {
      double a = -1 * Const::speedOfLight * 1e-4 * m_Bfield * daughters[iChild]->getCharge();
      double dx = kmv.getVertex().x() - kmv.getTrackPosition(iChild).x();
      double dy = kmv.getVertex().y() - kmv.getTrackPosition(iChild).y();
 
      ROOT::Math::PxPyPzEVector i4Vector(kmv.getTrackMomentum(iChild).x() - a * dy,
                                         kmv.getTrackMomentum(iChild).y() + a * dx,
                                         kmv.getTrackMomentum(iChild).z(),
                                         kmv.getTrackMomentum(iChild).t());
      daughters[iChild]->set4VectorDividingByMomentumScaling(i4Vector);
 
      daughters[iChild]->setVertex(
        CLHEPToROOT::getXYZVector(kmv.getTrackPosition(iChild)));
      daughters[iChild]->setMomentumVertexErrorMatrix(
        CLHEPToROOT::getTMatrixFSym(kmv.getTrackError(iChild)));
    }
  }
 
  return true;
}

◆ makeKRecoilMassMother()

bool makeKRecoilMassMother	(	analysis::RecoilMassKFit &	kf,
		Particle *	p )

private

Update mother particle after RecoilMass fit using KFit.

Parameters

kf	reference to KFit MassFit object
p	pointer to particle

Returns: true for successful construction of mother

Definition at line 1181 of file ParticleVertexFitterModule.cc.

{
  enum analysis::KFitError::ECode fitError;
  fitError = kf.updateMother(mother);
  if (fitError != analysis::KFitError::kNoError)
    return false;
  mother->addExtraInfo("RecoilMassFitProb", TMath::Prob(kf.getCHIsq(), kf.getNDF()));
  mother->addExtraInfo("RecoilMassFitChi2", kf.getCHIsq());
  mother->addExtraInfo("RecoilMassFitNDF", kf.getNDF());
  if (m_decayString.empty() && m_updateDaughters == true) {
    // update daughter momenta as well
    // the order of daughters in the *fitter is the same as in the mother Particle
 
    std::vector<Particle*> daughters = mother->getDaughters();
 
    unsigned track_count = kf.getTrackCount();
    if (daughters.size() != track_count)
      return false;
 
    for (unsigned iChild = 0; iChild < track_count; iChild++) {
      double a = -1 * Const::speedOfLight * 1e-4 * m_Bfield * daughters[iChild]->getCharge();
      double dx = kf.getVertex().x() - kf.getTrackPosition(iChild).x();
      double dy = kf.getVertex().y() - kf.getTrackPosition(iChild).y();
 
      ROOT::Math::PxPyPzEVector i4Vector(kf.getTrackMomentum(iChild).x() - a * dy,
                                         kf.getTrackMomentum(iChild).y() + a * dx,
                                         kf.getTrackMomentum(iChild).z(),
                                         kf.getTrackMomentum(iChild).t());
      daughters[iChild]->set4VectorDividingByMomentumScaling(i4Vector);
 
      daughters[iChild]->setVertex(
        CLHEPToROOT::getXYZVector(kf.getTrackPosition(iChild)));
      daughters[iChild]->setMomentumVertexErrorMatrix(
        CLHEPToROOT::getTMatrixFSym(kf.getTrackError(iChild)));
    }
  }
 
  return true;
}

◆ makeKVertexMother()

bool makeKVertexMother	(	analysis::VertexFitKFit &	kv,
		Particle *	p )

private

Update mother particle after unconstrained vertex fit using KFit.

Parameters

kv	reference to KFit VertexFit object
p	pointer to particle

Returns: true for successful construction of mother

Definition at line 836 of file ParticleVertexFitterModule.cc.

{
  enum analysis::KFitError::ECode fitError;
  fitError = kv.updateMother(mother);
  if (fitError != analysis::KFitError::kNoError)
    return false;
  if (m_decayString.empty() && m_updateDaughters == true) {
    // update daughter momenta as well
    // the order of daughters in the *fitter is the same as in the mother Particle
 
    std::vector<Particle*> daughters = mother->getDaughters();
 
    unsigned track_count = kv.getTrackCount();
    if (daughters.size() != track_count)
      return false;
 
    for (unsigned iChild = 0; iChild < track_count; iChild++) {
      double a = -1 * Const::speedOfLight * 1e-4 * m_Bfield * daughters[iChild]->getCharge();
      double dx = kv.getVertex().x() - kv.getTrackPosition(iChild).x();
      double dy = kv.getVertex().y() - kv.getTrackPosition(iChild).y();
 
      ROOT::Math::PxPyPzEVector i4Vector(kv.getTrackMomentum(iChild).x() - a * dy,
                                         kv.getTrackMomentum(iChild).y() + a * dx,
                                         kv.getTrackMomentum(iChild).z(),
                                         kv.getTrackMomentum(iChild).t());
      daughters[iChild]->set4VectorDividingByMomentumScaling(i4Vector);
 
      daughters[iChild]->setVertex(
        CLHEPToROOT::getXYZVector(kv.getTrackPosition(iChild)));
      daughters[iChild]->setMomentumVertexErrorMatrix(
        CLHEPToROOT::getTMatrixFSym(kv.getTrackError(iChild)));
    }
 
  } else if (m_updateDaughters == true) { // if decayString is not empty
    // first, update only the fit children
    std::vector<const Particle*> fitChildren = m_decaydescriptor.getSelectionParticles(mother);
 
    unsigned track_count = kv.getTrackCount();
    if (fitChildren.size() != track_count)
      return false;
 
    for (unsigned iChild = 0; iChild < track_count; iChild++) {
      auto daughter = const_cast<Particle*>(fitChildren[iChild]);
 
      double a = -1 * Const::speedOfLight * 1e-4 * m_Bfield * daughter->getCharge();
      double dx = kv.getVertex().x() - kv.getTrackPosition(iChild).x();
      double dy = kv.getVertex().y() - kv.getTrackPosition(iChild).y();
 
      ROOT::Math::PxPyPzEVector i4Vector(kv.getTrackMomentum(iChild).x() - a * dy,
                                         kv.getTrackMomentum(iChild).y() + a * dx,
                                         kv.getTrackMomentum(iChild).z(),
                                         kv.getTrackMomentum(iChild).t());
      daughter->set4VectorDividingByMomentumScaling(i4Vector);
 
      daughter->setVertex(CLHEPToROOT::getXYZVector(kv.getTrackPosition(iChild)));
      daughter->setMomentumVertexErrorMatrix(CLHEPToROOT::getTMatrixFSym(kv.getTrackError(iChild)));
    }
 
    // then, update other particles that have a fit-child in decay
    std::function<bool(Particle*)> funcUpdateMomentum =
    [&funcUpdateMomentum, fitChildren](Particle * part) {
 
      if (part->getNDaughters() == 0) {
        // check if part is included in fitChildren
        if (std::find(fitChildren.begin(), fitChildren.end(), part) != fitChildren.end())
          return true;
        else
          return false;
      }
 
      bool includeFitChildren = false;
 
      // Update daughters' momentum
      for (auto daughter : part->getDaughters())
        includeFitChildren = funcUpdateMomentum(daughter) || includeFitChildren;
 
      if (includeFitChildren) {
        // Using updated daughters, update part's momentum
        ROOT::Math::PxPyPzEVector sum4Vector;
        for (auto daughter : part->getDaughters())
          sum4Vector += daughter->get4Vector();
 
        part->set4VectorDividingByMomentumScaling(sum4Vector);
      }
 
      return includeFitChildren;
    };
 
    // Update all daughters
    for (auto daughter : mother->getDaughters())
      funcUpdateMomentum(daughter);
 
  }
 
 
  return true;
}

◆ makeMassKFourCMother()

bool makeMassKFourCMother	(	analysis::MassFourCFitKFit &	kv,
		Particle *	p )

private

Update mother particle after MassFourC fit using KFit.

Parameters

kv	reference to KFit MassFit object
p	pointer to particle

Returns: true for successful construction of mother

Definition at line 1117 of file ParticleVertexFitterModule.cc.

{
  enum analysis::KFitError::ECode fitError;
  fitError = kf.updateMother(mother);
  if (fitError != analysis::KFitError::kNoError)
    return false;
  mother->addExtraInfo("MassFourCFitProb", TMath::Prob(kf.getCHIsq(), kf.getNDF()));
  mother->addExtraInfo("MassFourCFitChi2", kf.getCHIsq());
  mother->addExtraInfo("MassFourCFitNDF", kf.getNDF());
  if (m_decayString.empty() && m_updateDaughters == true) {
    // update daughter momenta as well
    // the order of daughters in the *fitter is the same as in the mother Particle
 
    std::vector<Particle*> daughters = mother->getDaughters();
 
    const unsigned nd = daughters.size();
    unsigned l = 0;
    std::vector<std::vector<unsigned>> pars;
    pars.reserve(nd);
    std::vector<Particle*> allparticles;
    allparticles.reserve(nd);
    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(std::move(pard));
        allparticles.push_back(daughters[ichild]);
      } else {
        pard.push_back(l);
        pars.push_back(std::move(pard));
        allparticles.push_back(daughters[ichild]);
        l++;
      }
    }
 
    unsigned track_count = kf.getTrackCount();
    if (l != track_count)
      return false;
 
    for (unsigned iDaug = 0; iDaug < allparticles.size(); iDaug++) {
      ROOT::Math::PxPyPzEVector childMoms;
      ROOT::Math::XYZVector childPoss;
      TMatrixFSym childErrMatrixs(7);
      for (unsigned int iChild : pars[iDaug]) {
        childMoms = childMoms +
                    CLHEPToROOT::getLorentzVector(
                      kf.getTrackMomentum(iChild));
        childPoss = childPoss +
                    CLHEPToROOT::getXYZVector(
                      kf.getTrackPosition(iChild));
        TMatrixFSym childErrMatrix =
          CLHEPToROOT::getTMatrixFSym(kf.getTrackError(iChild));
        childErrMatrixs = childErrMatrixs + childErrMatrix;
      }
      allparticles[iDaug]->set4Vector(childMoms);
      allparticles[iDaug]->setVertex(childPoss);
      allparticles[iDaug]->setMomentumVertexErrorMatrix(childErrMatrixs);
    }
  }
 
  return true;
}

◆ redoTwoPhotonDaughterMassFit()

bool redoTwoPhotonDaughterMassFit	(	Particle *	postFit,
		const Particle *	preFit,
		const analysis::VertexFitKFit &	kv )

private

Combines preFit particle and vertex information from vertex fit kv to create new postFit particle.

A mass refit of this new particle is performed assuming that it originates from the point given by VertexFit.

Definition at line 430 of file ParticleVertexFitterModule.cc.

{
  // TODO: something like setGammaError is necessary
  // this is just workaround for the moment
 
  const Particle* g1Orig = preFit->getDaughter(0);
  const Particle* g2Orig = preFit->getDaughter(1);
  Particle g1Temp(g1Orig->get4Vector(), 22);
  Particle g2Temp(g2Orig->get4Vector(), 22);
 
  TMatrixFSym g1ErrMatrix = g1Orig->getMomentumVertexErrorMatrix();
  TMatrixFSym g2ErrMatrix = g2Orig->getMomentumVertexErrorMatrix();
 
  ROOT::Math::XYZVector pos(kv.getVertex().x(), kv.getVertex().y(), kv.getVertex().z());
  CLHEP::HepSymMatrix posErrorMatrix = kv.getVertexError();
 
  TMatrixFSym errMatrix(3);
  for (int i = 0; i < 3; i++)
    for (int j = 0; j < 3; j++)
      errMatrix(i, j) = posErrorMatrix[i][j];
 
  g1ErrMatrix.SetSub(4, errMatrix);
  g2ErrMatrix.SetSub(4, errMatrix);
 
  g1Temp.updateMomentum(g1Orig->get4Vector(), pos, g1ErrMatrix, 1.0);
  g2Temp.updateMomentum(g2Orig->get4Vector(), pos, g2ErrMatrix, 1.0);
 
  // perform the mass fit for the two-photon particle
  analysis::MassFitKFit km;
  km.setMagneticField(m_Bfield);
 
  km.addParticle(&g1Temp);
  km.addParticle(&g2Temp);
 
  km.setVertex(kv.getVertex());
  km.setVertexError(kv.getVertexError());
  km.setInvariantMass(preFit->getPDGMass());
 
  int err = km.doFit();
  if (err != 0) {
    return false;
  }
 
  // The update of the daughters is disabled for this mass fit.
  bool updateDaughters = m_updateDaughters;
  m_updateDaughters = false;
  bool ok = makeKMassMother(km, postFit);
  m_updateDaughters = updateDaughters;
 
  return ok;
}

◆ 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));
}

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

229{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo )

inherited

Configure the printed log information for the given level.

Parameters

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

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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;
}

◆ smearBeamSpot()

void smearBeamSpot ( double width )

private

smear beam spot covariance

Definition at line 1523 of file ParticleVertexFitterModule.cc.

{
  TMatrixDSym beamSpotCov = m_beamSpotDB->getCovVertex();
  for (int i = 0; i < 3; i++)
    beamSpotCov(i, i) += width * width;
 
  m_beamSpotCov = beamSpotCov;
}

◆ terminate()

virtual void terminate ( void )

inlinevirtualinherited

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

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

This method can be implemented by subclasses.

Definition at line 175 of file Module.h.

175{};

◆ 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 1222 of file ParticleVertexFitterModule.cc.

{
  std::vector <Particle*> daughters = 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(daughters[ichild]);
    } else  {
      pard.push_back(l);
      parm.push_back(l);
      pars.push_back(pard);
      allparticles.push_back(daughters[ichild]);
      l++;
    }
  }
}

Member Data Documentation

◆ m_BeamSpotCenter

ROOT::Math::XYZVector m_BeamSpotCenter

private

Beam spot position.

Definition at line 84 of file ParticleVertexFitterModule.h.

◆ m_beamSpotCov

TMatrixDSym m_beamSpotCov

private

Beam spot covariance matrix.

Definition at line 85 of file ParticleVertexFitterModule.h.

◆ m_beamSpotDB

DBObjPtr<BeamSpot> m_beamSpotDB

private

Beam spot database object.

Definition at line 86 of file ParticleVertexFitterModule.h.

◆ m_Bfield

double m_Bfield

private

magnetic field from data base

Definition at line 76 of file ParticleVertexFitterModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

◆ m_confidenceLevel

double m_confidenceLevel

private

required fit confidence level

Definition at line 75 of file ParticleVertexFitterModule.h.

◆ m_decaydescriptor

DecayDescriptor m_decaydescriptor

private

Decay descriptor of decays to look for.

Definition at line 82 of file ParticleVertexFitterModule.h.

◆ m_decayString

std::string m_decayString

private

daughter particles selection

Definition at line 80 of file ParticleVertexFitterModule.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_fitType

std::string m_fitType

private

type of the kinematic fit

Definition at line 78 of file ParticleVertexFitterModule.h.

◆ m_hasCovMatrix

bool m_hasCovMatrix = false

private

flag for mother covariance matrix (PseudoFitter)

Definition at line 83 of file ParticleVertexFitterModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_listName

std::string m_listName

private

particle list name

Definition at line 74 of file ParticleVertexFitterModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_massConstraintList

std::vector<int> m_massConstraintList

private

PDG codes of the particles to be mass constraint (massfourC)

Definition at line 89 of file ParticleVertexFitterModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_name

std::string m_name

privateinherited

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

Definition at line 507 of file Module.h.

◆ m_package

std::string m_package

privateinherited

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

Definition at line 509 of file Module.h.

◆ m_plist

StoreObjPtr<ParticleList> m_plist

private

particle list

Definition at line 73 of file ParticleVertexFitterModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 511 of file Module.h.

◆ m_recoilMass

double m_recoilMass

private

recoil mass for constraint

Definition at line 88 of file ParticleVertexFitterModule.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_smearing

double m_smearing

private

smearing width applied to IP tube

Definition at line 87 of file ParticleVertexFitterModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ m_updateDaughters

bool m_updateDaughters

private

flag for daughters update

Definition at line 81 of file ParticleVertexFitterModule.h.

◆ m_vertexFitter

std::string m_vertexFitter

private

Vertex Fitter name.

Definition at line 77 of file ParticleVertexFitterModule.h.

◆ m_withConstraint

std::string m_withConstraint

private

additional constraint on vertex

Definition at line 79 of file ParticleVertexFitterModule.h.

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

analysis/modules/ParticleVertexFitter/include/ParticleVertexFitterModule.h
analysis/modules/ParticleVertexFitter/src/ParticleVertexFitterModule.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ ParticleVertexFitterModule()

Member Function Documentation

◆ addChildofParticletoKFit()

◆ addChildofParticletoMassKFit()

◆ addIPProfileToKFit()

◆ addIPTubeToKFit()

◆ allSelectedDaughters()

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ doKFourCFit()

◆ doKMassFit()

◆ doKMassFourCFit()

◆ doKMassPointingVertexFit()

◆ doKMassVertexFit()

◆ doKRecoilMassFit()

◆ doKVertexFit()

◆ doRaveFit()

◆ doVertexFit()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ fillFitParticles()

◆ fillNotFitParticles()

◆ findConstraintBoost()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getChi2TracksLBoost()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ makeKFourCMother()

◆ makeKMassMother()

◆ makeKMassPointingVertexMother()

◆ makeKMassVertexMother()

◆ makeKRecoilMassMother()

◆ makeKVertexMother()

◆ makeMassKFourCMother()

◆ redoTwoPhotonDaughterMassFit()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()