#include <KinkFinderModule.h>

Inheritance diagram for KinkFinderModule:

Classes
struct	CDCForwardBackwardWallLine
	Structure to store the information about forward and backward walls of CDC. More...

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
	KinkFinderModule ()
	Setting of module description, parameters.

	~KinkFinderModule () override=default
	Acknowledgement of destructor.

void	initialize () override
	Registration of StoreArrays, Relations.

void	beginRun () override
	Read parameters from the database and apply to KinkFitter.

void	event () override
	Creates Belle2::Kink from Belle2::Track as described in the class documentation.

void	terminate () override
	Prints status summary.

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.

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
void	fitAndStore (const Track trackMother, const Track trackDaughter, const short filterFlag)
	Kink fitting and storing.

bool	kinkFitterModeSplitTrack ()
	Fitter mode 4th bit responsible for turning On/Off track splitting.

bool	ifInCDC (const ROOT::Math::XYZVector &pos)
	Test if the point in space is inside CDC (approximate custom geometry) with respect to shifts from outer wall, passed as parameters of the module.

bool	preFilterMotherTracks (Track const *const track)
	Check if the track can be a mother candidate based on some simple selections.

bool	preFilterDaughterTracks (Track const *const track)
	Check if the track can be a daughter candidate based on some simple selections.

bool	preFilterTracksToSplit (Track const *const track)
	Check if the track can be a candidate to be split based on some simple selections.

short	isTrackPairSelected (const Track motherTrack, const Track daughterTrack)
	Track pair preselection based on distance between two tracks with different options.

std::list< ModulePtr >	getModules () const override
	no submodules, return empty list

std::string	getPathString () const override
	return the module name.

void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.

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

Private Attributes
std::string	m_arrayNameTrack
	StoreArray name of the Belle2::Track (Input).

StoreArray< Track >	m_tracks
	StoreArray of Belle2::Track.

std::unique_ptr< KinkFitter >	m_kinkFitter
	Object containing the algorithm of Kink creation.

std::string	m_arrayNameRecoTrack
	StoreArray name of the RecoTrack (Input).

std::string	m_arrayNameCopiedRecoTrack
	StoreArray name of the RecoTrack used for creating copies.

std::string	m_arrayNameTFResult
	StoreArray name of the TrackFitResult (In- and Output).

std::string	m_arrayNameKink
	StoreArray name of the Kink (Output).

DBObjPtr< KinkFinderParameters >	m_kinkFinderParameters
	kinkFinder parameters Database ObjPtr

CDCForwardBackwardWallLine	m_cdcForwardBottomWall
	Bottom part of forward CDC wall.

CDCForwardBackwardWallLine	m_cdcForwardTopWall
	Top part of forward CDC wall.

CDCForwardBackwardWallLine	m_cdcBackwardBottomWall
	Bottom part of backward CDC wall.

CDCForwardBackwardWallLine	m_cdcBackwardTopWall
	Top part of backward CDC wall.

unsigned int	m_allStored = 0
	counter for all saved Kinks

unsigned int	m_f1Stored = 0
	counter for filter 1 saved Kinks

unsigned int	m_f2Stored = 0
	counter for filter 2 saved Kinks

unsigned int	m_f3Stored = 0
	counter for filter 3 saved Kinks

unsigned int	m_f4Stored = 0
	counter for filter 4 saved Kinks

unsigned int	m_f5Stored = 0
	counter for filter 5 saved Kinks

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.

Static Private Attributes
static constexpr double	m_cdcInnerWithFirstLayerWall = 15
	Smaller radius of inner CDC wall [cm].

static constexpr double	m_cdcInnerWallWithoutFirstLayer = 17
	Bigger radius of inner CDC wall [cm].

static constexpr double	m_cdcInnerWallWithoutFirstTwoLayers = 18
	Second bigger radius of inner CDC wall [cm].

static constexpr double	m_cdcOuterWall = 112
	Radius of outer CDC wall [cm].

static constexpr double	m_svdBeforeOuterLayer = 12
	Radius between two outer SVD layers (10.4 and 13.5 cm) [cm].

Detailed Description

Kink finder module.

Preselects and pairs up tracks and tries to find a vertex between them. Preselects and tries to split tracks that might be combined from two kink tracks.

The resulting pairs of tracks are stored as Belle2::Kink.

Definition at line 37 of file KinkFinderModule.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

◆ KinkFinderModule()

KinkFinderModule ( )

Setting of module description, parameters.

Definition at line 24 of file KinkFinderModule.cc.

                                   : Module()
{
 
  setDescription("This is a Kink finder module which preselects mother and daughter candidate tracks and matches them "
                 "and fits a vertex for each pair. Depending on the outcome of each fit, a corresponding "
                 "``Belle2::Kink`` is stored or not.\n\n"
                 "The parameters of the ``KinkFinder`` are stored as payloads in ``KinkFinderParameters``.\n\n"
                 "A loose cut on the pair is applied before the fit; then, a vertex fit is performed, and only pairs "
                 "passing a chi^2 (``KinkFinderParameters::m_vertexChi2Cut``) and distance "
                 "(``KinkFinderParameters::m_vertexDistanceCut``) are stored as ``Belle2::Kink``.\n\n"
                 "If a corresponding ``KinkFitter`` mode is ON, hits are reassigned between mother and daughter tracks "
                 "to improve the resolutions and efficiency. If a corresponding ``KinkFitter`` mode is ON, the track "
                 "pair is also fitted as one track and a special flag is filled based on the result to supress the clones.\n\n"
                 "If a corresponding ``KinkFitter`` mode is ON, ``KinkFinder`` preselects track candidates "
                 "that might be formed from two kink tracks, and ``KinkFitter`` splits such tracks. "
                 "After that the result is stored in ``Belle2::Kink``.");
 
  setPropertyFlags(c_ParallelProcessingCertified);
 
  // input: RecoTracks
  addParam("RecoTracks", m_arrayNameRecoTrack,
           "RecoTrack StoreArray name (input)", std::string(""));
 
  // RecoTracks for the refitting procedures
  addParam("CopiedRecoTracks", m_arrayNameCopiedRecoTrack,
           "RecoTrack StoreArray name (used for track refitting)", std::string("RecoTracksKinkTmp"));
 
  // input: Tracks and TrackFitResults; output: TrackFitResults (for the refitted tracks)
  addParam("TrackFitResults", m_arrayNameTFResult,
           "Belle2::TrackFitResult StoreArray name (in- and output).\n"
           "Note that the Kinks use pointers indices into these arrays, so all hell may break loose, "
           "if you change this.", std::string(""));
  addParam("Tracks", m_arrayNameTrack,
           "Belle2::Track StoreArray name (input).\n"
           "Note that the Kinks use pointers indices into these arrays, so all hell may break loose, "
           "if you change this.", std::string(""));
 
  // output: Kinks
  addParam("Kinks", m_arrayNameKink, "Kink StoreArray name (output).", std::string(""));
 
}

Member Function Documentation

◆ beginRun()

void beginRun ( void )

overridevirtual

Read parameters from the database and apply to KinkFitter.

Reimplemented from Module.

Definition at line 92 of file KinkFinderModule.cc.

{
  if (!m_kinkFinderParameters.isValid())
    B2FATAL("KinkFinder parameters are not available.");
 
  // apply cuts and fitter mode to KinkFitter
  m_kinkFitter->initializeCuts(m_kinkFinderParameters->getVertexDistanceCut(),
                               m_kinkFinderParameters->getVertexChi2Cut(),
                               m_kinkFinderParameters->getPrecutDistance());
  m_kinkFitter->setFitterMode(m_kinkFinderParameters->getKinkFitterMode());
}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

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

◆ def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }

Belle2::Module::beginRun

virtual void beginRun()

Called when entering a new run.

Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }

Belle2::Module::endRun

virtual void endRun()

This method is called if the current run ends.

Definition: Module.h:166

◆ def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }

Belle2::Module::event

virtual void event()

This method is the core of the module.

Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }

Belle2::Module::initialize

virtual void initialize()

Initialize the Module.

Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }

Belle2::Module::terminate

virtual void terminate()

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

Definition: Module.h:176

◆ endRun()

virtual void endRun ( void )

inlinevirtualinherited

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Definition at line 166 of file Module.h.

166{};

◆ evalCondition()

bool evalCondition ( ) const

inherited

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

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

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

Definition at line 96 of file Module.cc.

{
  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

Creates Belle2::Kink from Belle2::Track as described in the class documentation.

Reimplemented from Module.

Definition at line 105 of file KinkFinderModule.cc.

{
  B2DEBUG(29, m_tracks.getEntries() << " tracks in event.");
 
  // Group tracks into mother and daughter candidates.
  std::vector<const Track*> tracksMother;
  tracksMother.reserve(m_tracks.getEntries());
 
  std::vector<const Track*> tracksDaughter;
  tracksDaughter.reserve(m_tracks.getEntries());
 
  for (const auto& track : m_tracks) {
    RecoTrack const* const recoTrack = track.getRelated<RecoTrack>(m_arrayNameRecoTrack);
    B2ASSERT("No RecoTrack available for given Track.", recoTrack);
 
    // track is fitted
    if (!recoTrack->hasTrackFitStatus() || !recoTrack->wasFitSuccessful()) continue;
 
    // exclude tracks that have CDC hits and end with VXD hits (the kink efficiency loss is negligible)
    const auto& recoHitsInformation = recoTrack->getRecoHitInformations(true);
    if (recoTrack->getNumberOfCDCHits() &&
        ((recoHitsInformation.back())->getTrackingDetector() == RecoHitInformation::RecoHitDetector::c_SVD ||
         (recoHitsInformation.back())->getTrackingDetector() == RecoHitInformation::RecoHitDetector::c_PXD))
      continue;
 
    bool trackChosen = false;
    // select mother candidates
    if (preFilterMotherTracks(&track)) {
      tracksMother.push_back(&track);
      trackChosen = true;
 
      // if mother candidate pass criteria for splitting, split it with filter 7
      if (kinkFitterModeSplitTrack() && preFilterTracksToSplit(&track)) {
        const short filterFlag = 7;
        fitAndStore(&track, &track, filterFlag);
      }
    }
    // select daughter candidates
    if (preFilterDaughterTracks(&track)) {
      tracksDaughter.push_back(&track);
      trackChosen = true;
 
      // if daughter candidate pass criteria for splitting, split it with filter 8
      if (kinkFitterModeSplitTrack() && preFilterTracksToSplit(&track)) {
        const short filterFlag = 8;
        fitAndStore(&track, &track, filterFlag);
      }
    }
 
    // if track does not pass mother or daughter selection but passes criteria for splitting, split it with filter 9
    if (kinkFitterModeSplitTrack() && !trackChosen && preFilterTracksToSplit(&track)) {
      const short filterFlag = 9;
      fitAndStore(&track, &track, filterFlag);
    }
  }
 
  // Reject boring events.
  if (tracksMother.empty() || tracksDaughter.empty()) {
    B2DEBUG(29, "No interesting track pairs found. Number of selected tracksMother: " << tracksMother.size() <<
            ", tracksDaughter " << tracksDaughter.size());
    return;
  }
 
  // Pair up each mother track with each daughter track.
  for (auto& trackMother : tracksMother) {
    for (auto& trackDaughter : tracksDaughter) {
      const short filterFlag = isTrackPairSelected(trackMother, trackDaughter);
      if (!filterFlag) continue;
      B2DEBUG(29, "Found kink candidate with filterFlag " << filterFlag);
      fitAndStore(trackMother, trackDaughter, filterFlag);
    }
  }
 
}

◆ exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ fitAndStore()

void fitAndStore	(	const Track *	trackMother,
		const Track *	trackDaughter,
		const short	filterFlag
	)

private

Kink fitting and storing.

Parameters

trackMother	mother track
trackDaughter	daughter track
filterFlag	flag of the satisfied preselection criteria

Definition at line 397 of file KinkFinderModule.cc.

{
  bool ok = m_kinkFitter->fitAndStore(trackMother, trackDaughter, filterFlag);
  if (ok) {
    ++m_allStored;
    switch (filterFlag) {
      case 1:
      case 2:
      case 4:
      case 5:
        ++m_f1Stored;
        break;
      case 3:
      case 6:
        ++m_f2Stored;
        break;
      case 7:
        ++m_f3Stored;
        break;
      case 8:
        ++m_f4Stored;
        break;
      case 9:
        ++m_f5Stored;
    }
  }
}

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

◆ getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}

Belle2::Module::m_description

std::string m_description

The description of the module.

Definition: Module.h:511

◆ getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}

Belle2::Module::m_name

std::string m_name

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

Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

◆ getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

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

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags ) const

inherited

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

Parameters

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

◆ if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

inherited

Add a condition to the module.

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

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

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

Parameters

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

Definition at line 79 of file Module.cc.

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

◆ ifInCDC()

bool ifInCDC ( const ROOT::Math::XYZVector & pos )

private

Test if the point in space is inside CDC (approximate custom geometry) with respect to shifts from outer wall, passed as parameters of the module.

Test if the point in space is inside CDC (approximate custom geometry) with respect to shifts from outer wall.

Parameters

pos	point in space

Returns: true if the pos is inside the required volume of the CDC; false if outside

Definition at line 199 of file KinkFinderModule.cc.

{
  // check for the first layer of CDC (needed separately because of calculation of trapezoid shapes later)
  if (pos.Perp2() < m_cdcInnerWallWithoutFirstLayer * m_cdcInnerWallWithoutFirstLayer
      && pos.Perp2() > m_cdcInnerWithFirstLayerWall * m_cdcInnerWithFirstLayerWall)
    return true;
 
  // position inside CDC with respect to required shifts
  const double z = (pos.Z() > 0) ? (pos.Z() + m_kinkFinderParameters->getPrecutZ()) : (pos.Z() -
                   m_kinkFinderParameters->getPrecutZ());
  const double r = sqrt(pos.Perp2()) + m_kinkFinderParameters->getPrecutRho();
 
  // the point should be inside CDC with respect to shift, precutRho, from outer wall
  if (!((r < m_cdcOuterWall) && (r > m_cdcInnerWallWithoutFirstLayer + m_kinkFinderParameters->getPrecutRho())))
    return false;
 
  // the z coordinate point restriction
  // CDC has a shape of two trapezoids; thus, the forward and backward walls are described with two lines: bottom and top
  bool z_part;
  if (z > 0) {
    // forward walls of CDC
    z_part = (r > m_cdcForwardBottomWall.getLine(z)) && (r > m_cdcForwardTopWall.getLine(z));
  } else {
    // backward walls of CDC
    z_part = (r > m_cdcBackwardBottomWall.getLine(z)) && (r > m_cdcBackwardTopWall.getLine(z));
  }
  return z_part;
}

◆ initialize()

void initialize ( void )

overridevirtual

Registration of StoreArrays, Relations.

Reimplemented from Module.

Definition at line 67 of file KinkFinderModule.cc.

{
  m_tracks.isRequired(m_arrayNameTrack);
  StoreArray<RecoTrack> recoTracks(m_arrayNameRecoTrack);
  m_tracks.requireRelationTo(recoTracks);
  // All the other required StoreArrays are checked in the Constructor of the KinkFitter.
 
  // Create KinkFitter object.
  // Its parameters and cuts are set at the beginning of each run based on the information from the database.
  m_kinkFitter = std::make_unique<KinkFitter>(m_arrayNameTFResult, m_arrayNameKink,
                                              m_arrayNameRecoTrack,
                                              m_arrayNameCopiedRecoTrack);
 
  // Set geometry of CDC forward and backward walls.
  // Here the tangent is forward CDC acceptance (17 degrees).
  m_cdcForwardBottomWall.setLine(tan(17. / 180 * M_PI), 0);
  // Here numbers are calculated from the CDC technical geometry.
  m_cdcForwardTopWall.setLine(4.97, -670);
  // Here the tangent is backward CDC acceptance (30 degrees).
  m_cdcBackwardBottomWall.setLine(-tan(30. / 180 * M_PI), 0);
  // Here numbers are calculated from the CDC technical geometry.
  m_cdcBackwardTopWall.setLine(-4.2, -192.5);
 
}

◆ isTrackPairSelected()

short isTrackPairSelected	(	const Track *	motherTrack,
		const Track *	daughterTrack
	)

private

Track pair preselection based on distance between two tracks with different options.

Track pair preselection based on distance between two tracks with six different options.

Filter 1: Distance between first point of the daughter and last point of the mother < m_precutDistance (majority). Filter 2: Distance between last point of the daughter and last point of the mother < m_precutDistance (wrong daughter sign; minority but can be increased in future). Filter 3: Distance between the daughter Helix extrapolation to last point of the mother and last point of the mother < m_precutDistance (lost layers for daughter, second largest contribution). Filter 4: 2D distance between first point of the daughter and last point of the mother < m_precutDistance2D (bad daughter resolution recovered by hit reassignment). Filter 5: 2D distance between last point of the daughter and last point of the mother < m_precutDistance2D (bad daughter resolution and wrong daughter sign, almost no events). Filter 6: Distance between the daughter Helix extrapolation to last point of the mother and last point of the mother < m_precutDistance2D (lost layers for daughter combined with bad daughter resolution).

Parameters

motherTrack	mother track
daughterTrack	daughter track

Returns: flag of the satisfied preselection criteria (1-6 as it was listed above), or 0 otherwise.

Definition at line 313 of file KinkFinderModule.cc.

{
  constexpr double M_PI_over_6 = M_PI / 6.;
  const double cos_M_PI_over_6 = cos(M_PI_over_6);
 
  // cut variables squared for convenience
  const double precutDistanceSquared = m_kinkFinderParameters->getPrecutDistance() * m_kinkFinderParameters->getPrecutDistance();
  const double precutDistance2DSquared = m_kinkFinderParameters->getPrecutDistance2D() *
                                         m_kinkFinderParameters->getPrecutDistance2D();
 
  // get recoTracks and check that they are not the same
  RecoTrack const* const motherRecoTrack = motherTrack->getRelated<RecoTrack>(m_arrayNameRecoTrack);
  RecoTrack const* const daughterRecoTrack = daughterTrack->getRelated<RecoTrack>(m_arrayNameRecoTrack);
  if (motherRecoTrack == daughterRecoTrack) return 0;
 
  // Filter 1 check.
  const ROOT::Math::XYZVector motherPosLast(motherRecoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
  const ROOT::Math::XYZVector daughterPosFirst(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
  if ((daughterPosFirst - motherPosLast).Mag2() < precutDistanceSquared) return 1;
 
  // Filter 2 check.
  const ROOT::Math::XYZVector daughterPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
  if ((daughterPosLast - motherPosLast).Mag2() < precutDistanceSquared) return 2;
 
  // Filter 3 check. Here the same direction of daughter and mother is checked to exclude intersection of tracks
  // from different hemispheres.
  // Here and further M_PI_over_6 criteria was obtained empirically: it conservatively reduces the combinatorial
  // background while saving as much signal events as possible.
  if (daughterPosLast.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
      daughterPosFirst.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
      fabs(daughterPosLast.Phi() - motherPosLast.Phi()) < M_PI_over_6 ||
      fabs(daughterPosFirst.Phi() - motherPosLast.Phi()) < M_PI_over_6) {
 
    const ROOT::Math::XYZVector daughterPosClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
    const ROOT::Math::XYZVector daughterMomClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getMom());
    const double Bz = BFieldManager::getFieldInTesla(daughterPosClosestToMotherPosLast).Z();
    // daughter Helix with move to mother last point
    Helix daughterHelixClosestToMotherPosLast(daughterPosClosestToMotherPosLast,
                                              daughterMomClosestToMotherPosLast,
                                              static_cast<short>(daughterRecoTrack->getTrackFitStatus()->getCharge()),
                                              Bz);
    daughterHelixClosestToMotherPosLast.passiveMoveBy(motherPosLast);
 
    if ((daughterHelixClosestToMotherPosLast.getD0() * daughterHelixClosestToMotherPosLast.getD0() +
         daughterHelixClosestToMotherPosLast.getZ0() * daughterHelixClosestToMotherPosLast.getZ0()) <
        precutDistanceSquared)
      return 3;
  }
 
  // Filter 4 check.
  if ((daughterPosFirst - motherPosLast).Perp2() < precutDistance2DSquared)
    return 4;
 
  // Filter 5 check.
  if ((daughterPosLast - motherPosLast).Perp2() < precutDistance2DSquared)
    return 5;
 
  // Filter 6 check. Here the same direction of daughter and mother is checked to exclude intersection of tracks
  // from different hemispheres.
  if (daughterPosLast.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
      daughterPosFirst.Unit().Dot(motherPosLast.Unit()) > cos_M_PI_over_6 ||
      fabs(daughterPosLast.Phi() - motherPosLast.Phi()) < M_PI_over_6 ||
      fabs(daughterPosFirst.Phi() - motherPosLast.Phi()) < M_PI_over_6) {
 
    const ROOT::Math::XYZVector daughterPosClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
    const ROOT::Math::XYZVector daughterMomClosestToMotherPosLast(daughterRecoTrack->getMeasuredStateOnPlaneFromFirstHit().getMom());
    const double Bz = BFieldManager::getFieldInTesla(daughterPosClosestToMotherPosLast).Z();
    // daughter Helix with move to mother last point
    Helix daughterHelixClosestToMotherPosLast(daughterPosClosestToMotherPosLast,
                                              daughterMomClosestToMotherPosLast,
                                              static_cast<short>(daughterRecoTrack->getTrackFitStatus()->getCharge()),
                                              Bz);
    daughterHelixClosestToMotherPosLast.passiveMoveBy(motherPosLast);
 
    if (fabs(daughterHelixClosestToMotherPosLast.getD0()) < m_kinkFinderParameters->getPrecutDistance())
      return 6;
  }
 
  // No filter is passed.
  return 0;
 
}

◆ kinkFitterModeSplitTrack()

bool kinkFitterModeSplitTrack ( )

private

Fitter mode 4th bit responsible for turning On/Off track splitting.

Returns: true if the track splitting is On and false if it is Off

Definition at line 193 of file KinkFinderModule.cc.

{
  return m_kinkFinderParameters->getKinkFitterMode() & 0b1000;
}

◆ preFilterDaughterTracks()

bool preFilterDaughterTracks ( Track const *const track )

private

Check if the track can be a daughter candidate based on some simple selections.

Parameters

track of the candidate

Returns: true if track pass the criteria; false otherwise

They are conservative enough to reduces the combinatorial background and save as much signal events as possible.

Definition at line 264 of file KinkFinderModule.cc.

{
  // RecoTrack (existence and fit checked before calling this function)
  RecoTrack const* const recoTrack = track->getRelated<RecoTrack>(m_arrayNameRecoTrack);
  // track fit result
  TrackFitResult const* const trackFitResult = track->getTrackFitResultWithClosestMass(Const::pion);
 
  // first and last points of the track are > precutRho and > precutZ from outer walls of CDC (against back splashes)
  const ROOT::Math::XYZVector posLast(recoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
  const ROOT::Math::XYZVector posFirst(recoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
  if (!ifInCDC(posLast) && !ifInCDC(posFirst)) return false;
 
  // first point of the track is outside inner layers of VXD, or impact parameter in rphi > 1 cm
  // inverse criteria for mother
  if (posFirst.Perp2() < m_svdBeforeOuterLayer * m_svdBeforeOuterLayer && fabs(trackFitResult->getD0()) < 1) return false;
  return true;
}

◆ preFilterMotherTracks()

bool preFilterMotherTracks ( Track const *const track )

private

Check if the track can be a mother candidate based on some simple selections.

Parameters

track of the candidate

Returns: true if track pass the criteria; false otherwise

They are conservative enough to reduces the combinatorial background and save as much signal events as possible.

Definition at line 230 of file KinkFinderModule.cc.

{
  // RecoTrack (existence and fit checked before calling this function)
  RecoTrack const* const recoTrack = track->getRelated<RecoTrack>(m_arrayNameRecoTrack);
  // track fit result
  TrackFitResult const* const trackFitResult = track->getTrackFitResultWithClosestMass(Const::pion);
 
  // total number of CDC hits
  const int nCDCHits = recoTrack->getNumberOfCDCHits();
 
  // last point of the track is > precutRho and > precutZ from outer walls of CDC
  const ROOT::Math::XYZVector posLast(recoTrack->getMeasuredStateOnPlaneFromLastHit().getPos());
  if (nCDCHits && !ifInCDC(posLast)) return false;
 
  // track is not curled back to IP
  // The first layer of CDC has 16.8 cm radius; thus, the track which ends inside m_cdcInnerWallWithoutFirstLayer=17 cm
  // cylinder is either short or curler.
  // The requirement of >= 10 hits ensures that it is a curler (obtained empirically)
  if (nCDCHits >= 10 && posLast.Perp2() < m_cdcInnerWallWithoutFirstLayer * m_cdcInnerWallWithoutFirstLayer) return false;
 
  // first point of the track is inside inner layers of VXD
  // The mother candidate should start inside VXD. The radius of outer two SVD layers are 10.4 and 13.5 cm,
  // so we set m_svdBeforeOuterLayer=12 cm cut (between these layers).
  const ROOT::Math::XYZVector posFirst(recoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
  if (posFirst.Perp2() > m_svdBeforeOuterLayer * m_svdBeforeOuterLayer) return false;
 
  // impact parameter in rphi < 1 cm
  // conservative enough assuming possible bad resolution of mother track due to daughter hits assignment
  if (fabs(trackFitResult->getD0()) > 1) return false;
  return true;
}

◆ preFilterTracksToSplit()

bool preFilterTracksToSplit ( Track const *const track )

private

Check if the track can be a candidate to be split based on some simple selections.

Check if the track is a candidate for splitting based on some simple selections.

Parameters

track of the candidate

Returns: true if track pass the criteria; false otherwise

They are optimized to reduce the splitting of ordinary (non-decayed) tracks.

Definition at line 284 of file KinkFinderModule.cc.

{
  // RecoTrack (existence and fit checked before calling this function)
  RecoTrack const* const recoTrack = track->getRelated<RecoTrack>(m_arrayNameRecoTrack);
 
  if (recoTrack->getTrackFitStatus()->getPVal() > m_kinkFinderParameters->getPrecutSplitPValue()) return false;
 
  // track fit result
  TrackFitResult const* const trackFitResult = track->getTrackFitResultWithClosestMass(Const::pion);
 
  // number of fitted CDC hits
  const int nFittedCDCHits = trackFitResult->getHitPatternCDC().getNHits();
  if (nFittedCDCHits > m_kinkFinderParameters->getPrecutSplitNCDCHit()) return false;
  // more than 5 CDC hits to have enough hits for possible splitting
  if (nFittedCDCHits < 5) return false;
 
  // first point of the track is close to the inner wall of the CDC
  // we set m_cdcInnerWallWithoutFirstTwoLayers=18 cm cut to have both tracks with and without VXD hits
  const ROOT::Math::XYZVector posFirst(recoTrack->getMeasuredStateOnPlaneFromFirstHit().getPos());
  if (posFirst.Perp2() > m_cdcInnerWallWithoutFirstTwoLayers * m_cdcInnerWallWithoutFirstTwoLayers) return false;
 
  // impact parameter in rphi < 2 cm
  // Loose enough assuming possible bad resolution of track due to daughter hits assignment
  if (fabs(trackFitResult->getD0()) > 2) return false;
 
  return true;
}

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

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo	(	int	logLevel,
		unsigned int	logInfo
	)

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

◆ setLogLevel()

void setLogLevel ( int logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

◆ setName()

void setName ( const std::string & name )

inlineinherited

Set the name of the module.

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

◆ terminate()

void terminate ( void )

overridevirtual

Prints status summary.

Reimplemented from Module.

Definition at line 181 of file KinkFinderModule.cc.

{
  B2INFO("===KinkFinder summary===========================================================");
  B2INFO("In total " << m_allStored << " kinks saved. Among them");
  B2INFO("track pairs with close endpoints: " << m_f1Stored << ";");
  B2INFO("track pairs with missing layers between their endpoints (Helix extrapolation selection): " << m_f2Stored << ";");
  B2INFO("split track chosen from mother candidates: " << m_f3Stored << ";");
  B2INFO("split track chosen from daughter candidates: " << m_f4Stored << ";");
  B2INFO("split track chosen from tracks not passing mother/daughter preselection " << m_f5Stored << ".");
}

Member Data Documentation

◆ m_allStored

unsigned int m_allStored = 0

private

counter for all saved Kinks

Definition at line 188 of file KinkFinderModule.h.

◆ m_arrayNameCopiedRecoTrack

std::string m_arrayNameCopiedRecoTrack

private

StoreArray name of the RecoTrack used for creating copies.

Definition at line 167 of file KinkFinderModule.h.

◆ m_arrayNameKink

std::string m_arrayNameKink

private

StoreArray name of the Kink (Output).

Definition at line 169 of file KinkFinderModule.h.

◆ m_arrayNameRecoTrack

std::string m_arrayNameRecoTrack

private

StoreArray name of the RecoTrack (Input).

Definition at line 166 of file KinkFinderModule.h.

◆ m_arrayNameTFResult

std::string m_arrayNameTFResult

private

StoreArray name of the TrackFitResult (In- and Output).

Definition at line 168 of file KinkFinderModule.h.

◆ m_arrayNameTrack

std::string m_arrayNameTrack

private

StoreArray name of the Belle2::Track (Input).

Definition at line 162 of file KinkFinderModule.h.

◆ m_cdcBackwardBottomWall

CDCForwardBackwardWallLine m_cdcBackwardBottomWall

private

Bottom part of backward CDC wall.

Definition at line 176 of file KinkFinderModule.h.

◆ m_cdcBackwardTopWall

CDCForwardBackwardWallLine m_cdcBackwardTopWall

private

Top part of backward CDC wall.

Definition at line 177 of file KinkFinderModule.h.

◆ m_cdcForwardBottomWall

CDCForwardBackwardWallLine m_cdcForwardBottomWall

private

Bottom part of forward CDC wall.

Definition at line 174 of file KinkFinderModule.h.

◆ m_cdcForwardTopWall

CDCForwardBackwardWallLine m_cdcForwardTopWall

private

Top part of forward CDC wall.

Definition at line 175 of file KinkFinderModule.h.

◆ m_cdcInnerWallWithoutFirstLayer

constexpr double m_cdcInnerWallWithoutFirstLayer = 17

staticconstexprprivate

Bigger radius of inner CDC wall [cm].

It is taken a bit bigger to exclude the first layer of CDC (required in some preselection).

Definition at line 180 of file KinkFinderModule.h.

◆ m_cdcInnerWallWithoutFirstTwoLayers

constexpr double m_cdcInnerWallWithoutFirstTwoLayers = 18

staticconstexprprivate

Second bigger radius of inner CDC wall [cm].

It is taken a bit bigger to exclude first two layers of CDC (required in some preselection).

Definition at line 182 of file KinkFinderModule.h.

◆ m_cdcInnerWithFirstLayerWall

constexpr double m_cdcInnerWithFirstLayerWall = 15

staticconstexprprivate

Smaller radius of inner CDC wall [cm].

It is taken a bit smaller not to loose some events with the first layer of CDC.

Definition at line 178 of file KinkFinderModule.h.

◆ m_cdcOuterWall

constexpr double m_cdcOuterWall = 112

staticconstexprprivate

Radius of outer CDC wall [cm].

Definition at line 184 of file KinkFinderModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions

privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_description

std::string m_description

privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_f1Stored

unsigned int m_f1Stored = 0

private

counter for filter 1 saved Kinks

Definition at line 189 of file KinkFinderModule.h.

◆ m_f2Stored

unsigned int m_f2Stored = 0

private

counter for filter 2 saved Kinks

Definition at line 190 of file KinkFinderModule.h.

◆ m_f3Stored

unsigned int m_f3Stored = 0

private

counter for filter 3 saved Kinks

Definition at line 191 of file KinkFinderModule.h.

◆ m_f4Stored

unsigned int m_f4Stored = 0

private

counter for filter 4 saved Kinks

Definition at line 192 of file KinkFinderModule.h.

◆ m_f5Stored

unsigned int m_f5Stored = 0

private

counter for filter 5 saved Kinks

Definition at line 193 of file KinkFinderModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_kinkFinderParameters

DBObjPtr<KinkFinderParameters> m_kinkFinderParameters

private

kinkFinder parameters Database ObjPtr

Definition at line 171 of file KinkFinderModule.h.

◆ m_kinkFitter

std::unique_ptr<KinkFitter> m_kinkFitter

private

Object containing the algorithm of Kink creation.

Definition at line 165 of file KinkFinderModule.h.

◆ m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList

privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name

privateinherited

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

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package

privateinherited

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

Definition at line 510 of file Module.h.

◆ m_propertyFlags

unsigned int m_propertyFlags

privateinherited

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

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue

privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_svdBeforeOuterLayer

constexpr double m_svdBeforeOuterLayer = 12

staticconstexprprivate

Radius between two outer SVD layers (10.4 and 13.5 cm) [cm].

Definition at line 185 of file KinkFinderModule.h.

◆ m_tracks

StoreArray<Track> m_tracks

private

StoreArray of Belle2::Track.

Definition at line 163 of file KinkFinderModule.h.

◆ m_type

std::string m_type

privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

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

tracking/modules/kinkFinder/include/KinkFinderModule.h
tracking/modules/kinkFinder/src/KinkFinderModule.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ EAfterConditionPath

Member Enumeration Documentation

◆ EModulePropFlags

Constructor & Destructor Documentation

◆ KinkFinderModule()

Member Function Documentation

◆ beginRun()

◆ clone()

◆ def_beginRun()

◆ def_endRun()

◆ def_event()

◆ def_initialize()

◆ def_terminate()

◆ endRun()

◆ evalCondition()

◆ event()

◆ exposePythonAPI()

◆ fitAndStore()

◆ getAfterConditionPath()

◆ getAllConditionPaths()

◆ getAllConditions()

◆ getCondition()

◆ getConditionPath()

◆ getDescription()

◆ getFileNames()

◆ getLogConfig()

◆ getModules()

◆ getName()

◆ getPackage()

◆ getParamInfoListPython()

◆ getParamList()

◆ getPathString()

◆ getReturnValue()

◆ getType()

◆ hasCondition()

◆ hasProperties()

◆ hasReturnValue()

◆ hasUnsetForcedParams()

◆ if_false()

◆ if_true()

◆ if_value()

◆ ifInCDC()

◆ initialize()

◆ isTrackPairSelected()

◆ kinkFitterModeSplitTrack()

◆ preFilterDaughterTracks()

◆ preFilterMotherTracks()

◆ preFilterTracksToSplit()

◆ setAbortLevel()

◆ setDebugLevel()

◆ setDescription()

◆ setLogConfig()

◆ setLogInfo()

◆ setLogLevel()

◆ setName()

◆ setParamList()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ m_allStored

◆ m_arrayNameCopiedRecoTrack

◆ m_arrayNameKink

◆ m_arrayNameRecoTrack

◆ m_arrayNameTFResult

◆ m_arrayNameTrack