BKLMTrackingModule Class Reference

This module perform straight line track finding and fitting for BKLM. More...

#include <BKLMTrackingModule.h>

Inheritance diagram for BKLMTrackingModule:

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
	BKLMTrackingModule ()
	Constructor.
	~BKLMTrackingModule ()
	Destructor.
void	initialize () override
	Initialize at start of job.
void	beginRun () override
	begin run stuff
void	event () override
	Unpack one event and create digits.
void	endRun () override
	end run stuff
void	terminate () override
	Terminate at the end of job.
bool	sameSector (KLMHit2d *hit1, KLMHit2d *hit2)
	Judge if two hits come from the same sector.
bool	findClosestRecoTrack (BKLMTrack *bklmTrk, RecoTrack *&closestTrack)
	find the closest RecoTrack, match BKLMTrack to RecoTrack, if the matched RecoTrack is found, return true
virtual std::vector< std::string >	getFileNames (bool outputFiles)
	Return a list of output filenames for this modules.
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.

Protected Attributes
bool	m_studyEffi
	option for efficiency study mode, in this mode, the layer under study should not be used in tracking
bool	m_MatchToRecoTrack
	whether match BKLMTrack to RecoTrack
double	m_maxAngleRequired = 10
	angle required between RecoTrack and BKLMTrack, if openangle is larger than m_maxAngleRequired, they don't match
double	m_maxDistance = 10
	maximum distance required between track and KLMHit2d to be accepted for efficiency calculation
double	m_maxSigma = 5
	maximum sigma for hit acceptance during efficiency calculation
unsigned int	m_minHitList = 2
	minimum number of hits in sector for track finder to run (-2 from initial seed)
unsigned int	m_maxHitList = 60
	max number of hits in sector for track finder to run
bool	m_globalFit
	do the BKLMTrack fitting in global system (multi-sectors track) or local system (sector by sector)
std::string	m_outPath = "bklmEffi.root"
	output file name containing efficiencies plots

Private Member Functions
void	runTracking (int mode, int section, int sector, int layer)
	run the track finding and fitting
void	generateEffi (int section, int sector, int layer)
	calculate efficiency
bool	isLayerUnderStudy (int section, int iSector, int iLayer, KLMHit2d *hit)
	judge whether the current layer is understudy
bool	isSectorUnderStudy (int section, int iSector, KLMHit2d *hit)
	judge whether the hits come from the sctor understudy
double	distanceToHit (BKLMTrack *track, KLMHit2d *hit, double &error, double &sigma)
	calculate distance from track to hit
std::list< ModulePtr >	getModules () const override
	no submodules, return empty list
std::string	getPathString () const override
	return the module name.
void	setParamPython (const std::string &name, const boost::python::object &pyObj)
	Implements a method for setting boost::python objects.
void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary.

Static Private Member Functions
static bool	sortByLayer (KLMHit2d *hit1, KLMHit2d *hit2)
	my defined sort function using layer number

Private Attributes
bklm::GeometryPar *	m_GeoPar = nullptr
	bklm GeometryPar
TFile *	m_file = nullptr
	TFile that store efficiency plots.
TH1F *	m_total [2][8]
	Denominator of each layer.
TH1F *	m_pass [2][8]
	Numerator of each layer.
TEfficiency *	m_effiVsLayer [2][8]
	Efficiency of each layer.
TH2F *	m_effiYX
	Efficiency at global position Y vs X.
TH2F *	m_effiYZ
	Efficiency at global position Y vs Z.
TH2F *	m_passYX
	passed event at global position Y vs X
TH2F *	m_totalYX
	total event at global position Y vs X
TH2F *	m_passYZ
	passed event at global position Y vs Z
TH2F *	m_totalYZ
	total event at global position Y vs Z
StoreArray< BKLMTrack >	m_storeTracks
	BKLMTrack StoreArray.
StoreArray< KLMHit2d >	hits2D
	KLMHit2d StoreArray.
StoreArray< RecoTrack >	recoTracks
	RecoTrack StoreArray.
StoreArray< RecoHitInformation >	recoHitInformation
	RecoHitInformation StoreArray.
std::vector< int >	m_runNumber
	run number
int	m_runTotalEvents
	total number of processed events in the run
std::vector< int >	m_totalEvents
	total number of processed events
int	m_runTotalEventsWithTracks
	total number of processed events in the run with at lease one BKLMTrack
std::vector< int >	m_totalEventsWithTracks
	total number of processed events with at least one BKLMTrack
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

This module perform straight line track finding and fitting for BKLM.

Definition at line 34 of file BKLMTrackingModule.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

BKLMTrackingModule()

BKLMTrackingModule

(

)

Constructor.

Definition at line 27 of file BKLMTrackingModule.cc.

                                       : Module(),
  m_effiYX(nullptr),
  m_effiYZ(nullptr),
  m_passYX(nullptr),
  m_totalYX(nullptr),
  m_passYZ(nullptr),
  m_totalYZ(nullptr),
  m_runTotalEvents(0),
  m_runTotalEventsWithTracks(0)
{
  for (int i = 0; i < 8; ++i) {
    m_total[0][i] = nullptr;
    m_total[1][i] = nullptr;
    m_pass[0][i] = nullptr;
    m_pass[1][i] = nullptr;
    m_effiVsLayer[0][i] = nullptr;
    m_effiVsLayer[1][i] = nullptr;
  }
  setDescription("Perform standard-alone straight line tracking for BKLM");
  addParam("MatchToRecoTrack", m_MatchToRecoTrack, "[bool], whether match BKLMTrack to RecoTrack; (default is false)", false);
  addParam("MaxAngleRequired", m_maxAngleRequired,
           "[degree], match BKLMTrack to RecoTrack; angle between them is required to be smaller than (default 10)", double(10.0));
  addParam("MaxDistance", m_maxDistance,
           "[cm], During efficiency calculation, distance between track and 2dhit must be smaller than (default 10)", double(10.0));
  addParam("MaxSigma", m_maxSigma,
           "[sigma], During efficiency calculation, uncertainty of 2dhit must be smaller than (default 5); ", double(5));
  addParam("MinHitList", m_minHitList,
           ", During track finding, a good track after initial seed hits must be larger than is (default 2); ", unsigned(2));
  addParam("MaxHitList", m_maxHitList,
           ", During track finding, a good track after initial seed hits must be smaller than is (default 60); ", unsigned(60));
  addParam("fitGlobalBKLMTrack", m_globalFit,
           "[bool], do the BKLMTrack fitting in global system (multi-sectors track) or local system (sector by sector) (default is false, local sys.)",
           false);
  addParam("StudyEffiMode", m_studyEffi, "[bool], run in efficiency study mode (default is false)", false);
  addParam("outputName", m_outPath, "[string],  output file name containing efficiencies plots ", std::string("bklmEffi.root"));
}

~BKLMTrackingModule()

~BKLMTrackingModule

(

)

Destructor.

Definition at line 64 of file BKLMTrackingModule.cc.

{
 
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

begin run stuff

Reimplemented from Module.

Definition at line 113 of file BKLMTrackingModule.cc.

{
  StoreObjPtr<EventMetaData> eventMetaData("EventMetaData", DataStore::c_Event);
  m_runNumber.push_back((int)eventMetaData->getRun());
  m_runTotalEvents = 0;
  m_runTotalEventsWithTracks = 0;
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

distanceToHit()

double distanceToHit ( BKLMTrack *  track, KLMHit2d *  hit, double &  error, double &  sigma  )

private

calculate distance from track to hit

Definition at line 558 of file BKLMTrackingModule.cc.

{
 
  double x, y, z, dy, dz;
 
  error = DBL_MAX;
  sigma = DBL_MAX;
 
  TVectorD m_SectorPar = track->getLocalTrackParam();
 
  m_GeoPar = GeometryPar::instance();
  const Belle2::bklm::Module* refMod = m_GeoPar->findModule(hit->getSection(), hit->getSector(), 1);
  const Belle2::bklm::Module* corMod = m_GeoPar->findModule(hit->getSection(), hit->getSector(), hit->getLayer());
 
  CLHEP::Hep3Vector globalPos(hit->getPositionX(), hit->getPositionY(),
                              hit->getPositionZ());
  CLHEP::Hep3Vector local = refMod->globalToLocal(globalPos);
 
  x = local[0] ;
 
  y = m_SectorPar[ 0 ] + x * m_SectorPar[ 1 ];
  z = m_SectorPar[ 2 ] + x * m_SectorPar[ 3 ];
 
  dy = y - local[1];
  dz = z - local[2];
 
  double distance = sqrt(dy * dy + dz * dz);
 
  double hit_localPhiErr = corMod->getPhiStripWidth() / sqrt(12);
  double hit_localZErr = corMod->getZStripWidth() / sqrt(12);
 
  //error from tracking is ignored here
  error = sqrt(pow(hit_localPhiErr, 2) +
               pow(hit_localZErr, 2));
 
  if (error != 0.0) {
    sigma = distance / error;
  } else {
    sigma = DBL_MAX;
  }
 
  return (distance);
 
}

endRun()

void endRun ( void  )

overridevirtual

end run stuff

Reimplemented from Module.

Definition at line 272 of file BKLMTrackingModule.cc.

{
  m_totalEvents.push_back(m_runTotalEvents);
  m_totalEventsWithTracks.push_back(m_runTotalEventsWithTracks);
}

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

Unpack one event and create digits.

Reimplemented from Module.

Definition at line 121 of file BKLMTrackingModule.cc.

{
  m_storeTracks.clear();
  bool thereIsATrack = false;
 
  if (!m_studyEffi) {
    runTracking(0, -1, -1, -1);
    if (m_storeTracks.getEntries() > 0)
      thereIsATrack = true;
  } else {
    for (int iSection = 0; iSection < 2; iSection++) {
      for (int iSector = 0; iSector < 8; iSector++) {
        for (int iLayer = 0; iLayer < 15; iLayer++) {
          runTracking(1, iSection, iSector, iLayer);
          if (m_storeTracks.getEntries() > 0)
            thereIsATrack = true;
          generateEffi(iSection, iSector, iLayer);
          //clear tracks so prepare for the next layer efficiency study
          m_storeTracks.clear();
        }
      }
    }
  }
 
  m_runTotalEvents++;
  if (thereIsATrack)
    m_runTotalEventsWithTracks++;
}

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://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)

findClosestRecoTrack()

bool findClosestRecoTrack	(	BKLMTrack *	bklmTrk,
		RecoTrack *&	closestTrack
	)

find the closest RecoTrack, match BKLMTrack to RecoTrack, if the matched RecoTrack is found, return true

Translates MeasuredStateOnPlane into 3D position, momentum and 6x6 covariance.

Definition at line 336 of file BKLMTrackingModule.cc.

{
 
  //StoreArray<RecoTrack> recoTracks;
  RelationVector<KLMHit2d> bklmHits = bklmTrk->getRelationsTo<KLMHit2d> ();
 
  if (bklmHits.size() < 1) {
    B2INFO("BKLMTrackingModule::something is wrong! there is BKLMTrack but no bklmHits");
    return false;
  }
  if (recoTracks.getEntries() < 1) {
    B2INFO("BKLMTrackingModule::there is no recoTrack");
    return false;
  }
  double oldDistanceSq = INFINITY;
  double oldAngle = INFINITY;
  closestTrack = nullptr;
  //bklmHits are already sorted by layer
  //possible two hits in one layer?
  //genfit requires TVector3 rather than XYZVector
  TVector3 firstBKLMHitPosition(bklmHits[0]->getPosition().X(),
                                bklmHits[0]->getPosition().Y(),
                                bklmHits[0]->getPosition().Z());
 
  // To get direction (angle) below, we have two points on the bklmTrk:
  //     (x1, TrackParam[0]+TrackParam[1]*x1, TrackParam[2]+TrackParam[3]*x1)
  //     (x2, TrackParam[0]+TrackParam[1]*x2, TrackParam[2]+TrackParam[3]*x2)
  // the difference vector is
  //     (x2-x1, TrackParam[1]*(x2-x1), TrackParam[3]*(x2-x1))
  // which is proportional to
  //     (1, TrackParam[1], TrackParam[3]).
  TVector3 bklmTrkVec(1.0,  bklmTrk->getTrackParam()[1], bklmTrk->getTrackParam()[3]);
 
  TMatrixDSym cov(6);
  TVector3 pos; // initializes to (0,0,0)
  TVector3 mom; // initializes to (0,0,0)
 
  for (RecoTrack& track : recoTracks) {
    try {
      genfit::MeasuredStateOnPlane state = track.getMeasuredStateOnPlaneFromLastHit();
      state.getPosMomCov(pos, mom, cov);
      if (mom.Y() * pos.Y() < 0) {
        state = track.getMeasuredStateOnPlaneFromFirstHit();
      }
      const TVector3& distanceVec = firstBKLMHitPosition - pos;
      state.extrapolateToPoint(firstBKLMHitPosition);
      double newDistanceSq = distanceVec.Mag2();
      double angle = bklmTrkVec.Angle(mom);
      // choose closest distance or minimum open angle ?
      // overwrite old distance
      if (newDistanceSq < oldDistanceSq) {
        oldDistanceSq = newDistanceSq;
        closestTrack = &track;
        oldAngle = angle;
      }
 
      /* if(angle<oldAngle)
      {
      oldAngle=angle;
      closestTrack = &track;
      }
      */
    } catch (genfit::Exception& e) {
    }// try
  }
 
  // can not find matched RecoTrack
  // problem here is the errors of the track parameters are not considered!
  // best way is the position or vector direction are required within 5/10 sigma ?
  if (oldAngle > m_maxAngleRequired)
    return false;
  // found matched RecoTrack
  else return true;
}

generateEffi()

void generateEffi ( int  section, int  sector, int  layer  )

private

calculate efficiency

Definition at line 412 of file BKLMTrackingModule.cc.

{
 
  std::set<int> m_pointUsed;
  m_pointUsed.clear();
  if (m_storeTracks.getEntries() < 1)
    return;
 
  for (int it = 0; it < m_storeTracks.getEntries(); it++) {
    //if(m_storeTracks[it]->getTrackChi2()>10) continue;
    //if(m_storeTracks[it]->getNumHitOnTrack()<6) continue;
    int cnt1 = 0;
    int cnt2 = 0;
 
    RelationVector<KLMHit2d> relatedHit2D = m_storeTracks[it]->getRelationsTo<KLMHit2d>();
    for (const KLMHit2d& hit2D : relatedHit2D) {
      if (hit2D.getLayer() > iLayer + 1)
        cnt1++;
      if (hit2D.getLayer() < iLayer + 1)
        cnt2++;
    }
 
    if (iLayer != 0 && cnt2 < 1)
      return;
    if (iLayer != 14 && cnt1 < 1)
      return;
    m_GeoPar = GeometryPar::instance();
    const bklm::Module* module = m_GeoPar->findModule(iSection, iSector + 1, iLayer + 1);
    int minPhiStrip = module->getPhiStripMin();
    int maxPhiStrip = module->getPhiStripMax();
    int minZStrip = module->getZStripMin();
    int maxZStrip = module->getZStripMax();
 
    CLHEP::Hep3Vector local = module->getLocalPosition(minPhiStrip, minZStrip);
    CLHEP::Hep3Vector local2 = module->getLocalPosition(maxPhiStrip, maxZStrip);
    float minLocalY, maxLocalY;
    float minLocalZ, maxLocalZ;
    if (local[1] > local2[1]) {
      maxLocalY = local[1];
      minLocalY = local2[1];
    } else {
      maxLocalY = local2[1];
      minLocalY = local[1];
    }
    if (local[2] > local2[2]) {
      maxLocalZ = local[2];
      minLocalZ = local2[2];
    } else {
      maxLocalZ = local2[2];
      minLocalZ = local[2];
    }
 
    TVectorD trkPar = m_storeTracks[it]->getLocalTrackParam();
 
    //first layer is the reference layer
    //if (iSection == 1 && (iSector + 1 ) == 5)
    //  cout<<" local X "<<m_GeoPar->getActiveMiddleRadius(iSection, iSector + 1, iLayer + 1) - m_GeoPar->getActiveMiddleRadius(iSection, iSector + 1, 1) << endl;
    float reflocalX = fabs(m_GeoPar->getActiveMiddleRadius(iSection, iSector + 1,
                                                           iLayer + 1) - m_GeoPar->getActiveMiddleRadius(iSection, iSector + 1, 1));
    //if (iSection == 1 && (iSector + 1 ) == 5)
    //  cout<<" local X "<<m_GeoPar->getActiveMiddleRadius(iSection, iSector + 1, iLayer + 1) - m_GeoPar->getActiveMiddleRadius(iSection, iSector + 1, 1) << endl;
 
    float reflocalY = trkPar[0] + trkPar[1] * reflocalX;
    float reflocalZ = trkPar[2] + trkPar[3] * reflocalX;
 
    //reference module is the first layer
    //module = m_GeoPar->findModule(iSection, iSector + 1, 1);
    reflocalX = 0.0;
    Hep3Vector reflocal(reflocalX, reflocalY, reflocalZ);
    //Hep3Vector global(localX, localY, localZ);
    Hep3Vector global(0, 0, 0);
    module = m_GeoPar->findModule(iSection, iSector + 1, iLayer + 1);
    global = module->localToGlobal(reflocal);
    //float localX = module->globalToLocal(global)[0];
    float localY = module->globalToLocal(global)[1];
    float localZ = module->globalToLocal(global)[2];
 
 
    //geometry cut
    if (localY > minLocalY && localY < maxLocalY && localZ > minLocalZ && localZ < maxLocalZ) {
 
      bool m_iffound = false;
      m_total[iSection][iSector]->Fill(iLayer + 1);
      m_totalYX->Fill(global[0], global[1]);
      m_totalYZ->Fill(global[2], global[1]);
 
      for (int he = 0; he < hits2D.getEntries(); ++he) {
        if (!isLayerUnderStudy(iSection, iSector, iLayer, hits2D[he]))
          continue;
        if (hits2D[he]->isOutOfTime())
          continue;
        //if already used, skip
        if (m_pointUsed.find(he) != m_pointUsed.end())
          continue;
 
        double error, sigma;
        float distance = distanceToHit(m_storeTracks[it], hits2D[he], error, sigma);
 
        if (distance < m_maxDistance && sigma < m_maxSigma)
          m_iffound = true;
        if (m_iffound) {
          m_pointUsed.insert(he);
          //global[0] = hits2D[he]->getPosition()[0];
          //global[1] = hits2D[he]->getPosition()[1];
          //global[2] = hits2D[he]->getPosition()[2];
          m_pass[iSection][iSector]->Fill(iLayer + 1);
          m_passYX->Fill(global[0], global[1]);
          m_passYZ->Fill(global[2], global[1]);
          break;
        }
      }
 
      m_effiVsLayer[iSection][iSector]->Fill(m_iffound, iLayer + 1);
      //cout<<" global "<<global[0]<<", "<< global[1]<<" "<<global[2]<<endl;
      //m_effiYX->Fill(m_iffound, global[1], global[0]);
      //m_effiYZ->Fill(m_iffound, global[1], global[2]);
      //m_effiYX->SetPassedHistogram(*m_passYX);
      //m_effiYX->SetTotalHistogram(*m_totalYX);
      //m_effiYZ->SetPassedHistogram(*m_passYZ);
      //m_effiYZ->SetTotalHistogram(*m_totalYZ);
    }
  }//end of loop tracks
 
}

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.

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

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

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

See https://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 at start of job.

Reimplemented from Module.

Definition at line 69 of file BKLMTrackingModule.cc.

{
 
  hits2D.isRequired();
  m_storeTracks.registerInDataStore();
  m_storeTracks.registerRelationTo(hits2D);
  m_storeTracks.registerRelationTo(recoTracks);
  recoHitInformation.registerRelationTo(hits2D);
  hits2D.registerRelationTo(recoTracks);
 
  if (m_studyEffi)
    B2INFO("BKLMTrackingModule:: this module is running in efficiency study mode!");
 
  m_file = new TFile(m_outPath.c_str(), "recreate");
  TString hname;
  std::string labelFB[2] = {"BB", "BF"};
  int Nbin = 16;
  float gmin = -350;
  float gmax = 350;
  int gNbin = 150;
 
  m_totalYX  = new TH2F("totalYX", " denominator Y vs. X", gNbin, gmin, gmax, gNbin, gmin, gmax);
  m_passYX  = new TH2F("passYX", " numerator Y vs. X", gNbin, gmin, gmax, gNbin, gmin, gmax);
  m_totalYZ  = new TH2F("totalYZ", " denominator Y vs. Z", gNbin, gmin, gmax, gNbin, gmin, gmax);
  m_passYZ  = new TH2F("passYZ", " numerator Y vs. Z", gNbin, gmin, gmax, gNbin, gmin, gmax);
  m_effiYX  = new TH2F("effiYX", " effi. Y vs. X", gNbin, gmin, gmax, gNbin, gmin, gmax);
  m_effiYZ  = new TH2F("effiYZ", " effi. Y vs. X", gNbin, gmin, gmax, gNbin, gmin, gmax);
  m_effiYX->GetXaxis()->SetTitle("x (cm)");
  m_effiYX->GetYaxis()->SetTitle("y (cm)");
  m_effiYZ->GetXaxis()->SetTitle("z (cm)");
  m_effiYZ->GetYaxis()->SetTitle("y (cm)");
  for (int iF = 0; iF < 2; iF++) {
    for (int iS = 0; iS < 8; iS++) {
      hname.Form("effi_%s%i", labelFB[iF].c_str(), iS);
      m_effiVsLayer[iF][iS]  = new TEfficiency(hname, hname, Nbin, 0, 16);
      hname.Form("total_%s%i", labelFB[iF].c_str(), iS);
      m_total[iF][iS] = new TH1F(hname, hname, Nbin, 0, 16);
      hname.Form("pass_%s%i", labelFB[iF].c_str(), iS);
      m_pass[iF][iS] = new TH1F(hname, hname, Nbin, 0, 16);
    }
  }
 
}

isLayerUnderStudy()

bool isLayerUnderStudy ( int  section, int  iSector, int  iLayer, KLMHit2d *  hit  )

private

judge whether the current layer is understudy

Definition at line 544 of file BKLMTrackingModule.cc.

{
  if (hit->getSection() == section && hit->getSector() == iSector + 1 &&  hit->getLayer() == iLayer + 1)
    return true;
  else return false;
}

isSectorUnderStudy()

bool isSectorUnderStudy ( int  section, int  iSector, KLMHit2d *  hit  )

private

judge whether the hits come from the sctor understudy

Definition at line 551 of file BKLMTrackingModule.cc.

{
  if (hit->getSection() == section && hit->getSector() == iSector + 1)
    return true;
  else return false;
}

runTracking()

void runTracking ( int  mode, int  section, int  sector, int  layer  )

private

run the track finding and fitting

Definition at line 150 of file BKLMTrackingModule.cc.

{
  m_storeTracks.clear();
  //std::list<BKLMTrack*> tracks;
  //tracks.clear();
 
  BKLMTrackFitter* m_fitter = new BKLMTrackFitter();
  BKLMTrackFinder*  m_finder = new BKLMTrackFinder();
  m_finder->setGlobalFit(m_globalFit);
  if (mode == 1)
    m_finder->setGlobalFit(false);
  m_finder->registerFitter(m_fitter);
 
  if (hits2D.getEntries() < 1)
    return;
  if (mode == 1) { //efficiency study
    for (int j = 0; j < hits2D.getEntries(); j++) {
      if (hits2D[j]->getSubdetector() != KLMElementNumbers::c_BKLM)
        continue;
      hits2D[j]->isOnStaTrack(false);
    }
  }
 
  for (int hi = 0; hi < hits2D.getEntries() - 1; ++hi) {
    if (hits2D[hi]->getSubdetector() != KLMElementNumbers::c_BKLM)
      continue;
 
    if (mode == 1 && isLayerUnderStudy(iSection, iSector, iLayer, hits2D[hi]))
      continue;
    if (mode == 1 && !isSectorUnderStudy(iSection, iSector, hits2D[hi]))
      continue;
    if (hits2D[hi]->isOnStaTrack())
      continue;
    if (hits2D[hi]->isOutOfTime())
      continue;
    for (int hj = hi + 1; hj < hits2D.getEntries(); ++hj) {
 
      if (hits2D[hj]->isOnStaTrack())
        continue;
      if (hits2D[hj]->isOutOfTime())
        continue;
      if (!m_globalFit && !sameSector(hits2D[hi], hits2D[hj]))
        continue;
      if (sameSector(hits2D[hi], hits2D[hj]) &&
          std::abs(hits2D[hi]->getLayer() - hits2D[hj]->getLayer()) < 3)
        continue;
 
      std::list<KLMHit2d*> sectorHitList;
      //sectorHitList.push_back(hits2D[hi]);
      //sectorHitList.push_back(hits2D[hj]);
 
      std::list<KLMHit2d*> seed;
      seed.push_back(hits2D[hi]);
      seed.push_back(hits2D[hj]);
 
      for (int ho = 0; ho < hits2D.getEntries(); ++ho) {
 
        // Exclude seed hits.
        if (ho == hi || ho == hj)
          continue;
        if (mode == 1 && isLayerUnderStudy(iSection, iSector, iLayer, hits2D[hj]))
          continue;
        if (mode == 1 && !isSectorUnderStudy(iSection, iSector, hits2D[hj]))
          continue;
        if (hits2D[ho]->isOnStaTrack())
          continue;
        if (!m_globalFit && !sameSector(hits2D[ho], hits2D[hi]))
          continue;
        // if (hits2D[ho]->getLayer() == hits2D[hi]->getLayer() || hits2D[ho]->getLayer() == hits2D[hj]->getLayer())
        //   continue;
        if (hits2D[ho]->isOutOfTime())
          continue;
        sectorHitList.push_back(hits2D[ho]);
      }
 
      /* Require at least four hits (minimum for good track, already two as seed, so here we require 2) but
       * no more than 60 (most likely noise, 60 would be four good tracks).
       */
      if (sectorHitList.size() < m_minHitList || sectorHitList.size() > m_maxHitList)
        continue;
 
      std::list<KLMHit2d*> m_hits;
      if (m_finder->filter(seed, sectorHitList, m_hits)) {
        BKLMTrack* m_track = m_storeTracks.appendNew();
        m_track->setTrackParam(m_fitter->getTrackParam());
        m_track->setTrackParamErr(m_fitter->getTrackParamErr());
        m_track->setLocalTrackParam(m_fitter->getTrackParamSector());
        m_track->setLocalTrackParamErr(m_fitter->getTrackParamSectorErr());
        m_track->setTrackChi2(m_fitter->getChi2());
        m_track->setNumHitOnTrack(m_fitter->getNumHit());
        m_track->setIsValid(m_fitter->isValid());
        m_track->setIsGood(m_fitter->isGood());
        m_hits.sort(sortByLayer);
        for (KLMHit2d* hit2d : m_hits) {
          hit2d->isOnStaTrack(true);
          m_track->addRelationTo(hit2d);
        }
        //tracks.push_back(m_track);
        //m_track->getTrackParam().Print();
        //m_track->getTrackParamErr().Print();
        //match BKLMTrack to RecoTrack
        if (mode == 0) {
          RecoTrack* closestTrack = nullptr;
          if (m_MatchToRecoTrack) {
            if (findClosestRecoTrack(m_track, closestTrack)) {
              m_track->addRelationTo(closestTrack);
              for (KLMHit2d* hit2d : m_hits) {
                unsigned int sortingParameter = closestTrack->getNumberOfTotalHits();
                closestTrack->addBKLMHit(hit2d, sortingParameter, RecoHitInformation::OriginTrackFinder::c_LocalTrackFinder);
              }
            }
          }//end match
        }
      }
    }
  }
 
  delete m_fitter;
  delete m_finder;
 
}

sameSector()

bool sameSector	(	KLMHit2d *	hit1,
		KLMHit2d *	hit2
	)

Judge if two hits come from the same sector.

Definition at line 328 of file BKLMTrackingModule.cc.

{
  if (hit1->getSection() == hit2->getSection() && hit1->getSector() == hit2->getSector())
    return true;
  else return false;
}

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.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

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

sortByLayer()

bool sortByLayer ( KLMHit2d *  hit1, KLMHit2d *  hit2  )

staticprivate

my defined sort function using layer number

Definition at line 537 of file BKLMTrackingModule.cc.

{
 
  return hit1->getLayer() < hit2->getLayer();
 
}

terminate()

void terminate ( void  )

overridevirtual

Terminate at the end of job.

Reimplemented from Module.

Definition at line 278 of file BKLMTrackingModule.cc.

{
  for (long unsigned int i = 0; i < m_runNumber.size(); i++) {
    float ratio = (float)m_totalEventsWithTracks.at(i) / (float)m_totalEvents.at(i);
    B2INFO("BKLMTrackingModule:: run " << m_runNumber.at(i) << " --> " << ratio * 100 << "% of events has 1+ BKLMTracks");
  }
 
  m_file->cd();
  for (int iF = 0; iF < 2; iF++) {
    for (int iS = 0; iS < 8; iS++) {
      m_effiVsLayer[iF][iS]->Write();
      m_total[iF][iS]->Write();
      m_pass[iF][iS]->Write();
    }
  }
 
  for (int i = 0; i < m_totalYX->GetNbinsX(); i++) {
    for (int j = 0; j < m_totalYX->GetNbinsY(); j++) {
      float num = m_passYX->GetBinContent(i + 1, j + 1);
      float denom = m_totalYX->GetBinContent(i + 1, j + 1);
      if (num > 0) {
        m_effiYX->SetBinContent(i + 1, j + 1, num / denom);
        m_effiYX->SetBinError(i + 1, j + 1, sqrt(num * (denom - num) / (denom * denom * denom)));
      } else {
        m_effiYX->SetBinContent(i + 1, j + 1, 0);
        m_effiYX->SetBinError(i + 1, j + 1, 0);
      }
 
      num = m_passYZ->GetBinContent(i + 1, j + 1);
      denom = m_totalYZ->GetBinContent(i + 1, j + 1);
      if (num > 0) {
        m_effiYZ->SetBinContent(i + 1, j + 1, num / denom);
        m_effiYZ->SetBinError(i + 1, j + 1, sqrt(num * (denom - num) / (denom * denom * denom)));
      } else {
        m_effiYZ->SetBinContent(i + 1, j + 1, 0);
        m_effiYZ->SetBinError(i + 1, j + 1, 0);
      }
    }
  }
 
  m_totalYX->Write();
  m_passYX->Write();
  m_totalYZ->Write();
  m_passYZ->Write();
  m_effiYX->Write();
  m_effiYZ->Write();
  m_file->Close();
 
}

Member Data Documentation

hits2D

StoreArray<KLMHit2d> hits2D

private

KLMHit2d StoreArray.

Definition at line 135 of file BKLMTrackingModule.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_effiVsLayer

TEfficiency* m_effiVsLayer[2][8]

private

Efficiency of each layer.

Definition at line 110 of file BKLMTrackingModule.h.

m_effiYX

TH2F* m_effiYX

private

Efficiency at global position Y vs X.

Definition at line 114 of file BKLMTrackingModule.h.

m_effiYZ

TH2F* m_effiYZ

private

Efficiency at global position Y vs Z.

Definition at line 118 of file BKLMTrackingModule.h.

m_file

TFile* m_file = nullptr

private

TFile that store efficiency plots.

Definition at line 101 of file BKLMTrackingModule.h.

m_GeoPar

bklm::GeometryPar* m_GeoPar = nullptr

private

bklm GeometryPar

Definition at line 98 of file BKLMTrackingModule.h.

m_globalFit

bool m_globalFit

protected

do the BKLMTrack fitting in global system (multi-sectors track) or local system (sector by sector)

Definition at line 90 of file BKLMTrackingModule.h.

m_hasReturnValue

bool m_hasReturnValue

privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

m_logConfig

LogConfig m_logConfig

privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

m_MatchToRecoTrack

bool m_MatchToRecoTrack

protected

whether match BKLMTrack to RecoTrack

Definition at line 72 of file BKLMTrackingModule.h.

m_maxAngleRequired

double m_maxAngleRequired = 10

protected

angle required between RecoTrack and BKLMTrack, if openangle is larger than m_maxAngleRequired, they don't match

Definition at line 75 of file BKLMTrackingModule.h.

m_maxDistance

double m_maxDistance = 10

protected

maximum distance required between track and KLMHit2d to be accepted for efficiency calculation

Definition at line 78 of file BKLMTrackingModule.h.

m_maxHitList

unsigned int m_maxHitList = 60

protected

max number of hits in sector for track finder to run

Definition at line 87 of file BKLMTrackingModule.h.

m_maxSigma

double m_maxSigma = 5

protected

maximum sigma for hit acceptance during efficiency calculation

Definition at line 81 of file BKLMTrackingModule.h.

m_minHitList

unsigned int m_minHitList = 2

protected

minimum number of hits in sector for track finder to run (-2 from initial seed)

Definition at line 84 of file BKLMTrackingModule.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_outPath

std::string m_outPath = "bklmEffi.root"

protected

output file name containing efficiencies plots

Definition at line 93 of file BKLMTrackingModule.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_pass

TH1F* m_pass[2][8]

private

Numerator of each layer.

Definition at line 107 of file BKLMTrackingModule.h.

m_passYX

TH2F* m_passYX

private

passed event at global position Y vs X

Definition at line 121 of file BKLMTrackingModule.h.

m_passYZ

TH2F* m_passYZ

private

passed event at global position Y vs Z

Definition at line 127 of file BKLMTrackingModule.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_runNumber

std::vector<int> m_runNumber

private

run number

Definition at line 164 of file BKLMTrackingModule.h.

m_runTotalEvents

int m_runTotalEvents

private

total number of processed events in the run

Definition at line 167 of file BKLMTrackingModule.h.

m_runTotalEventsWithTracks

int m_runTotalEventsWithTracks

private

total number of processed events in the run with at lease one BKLMTrack

Definition at line 173 of file BKLMTrackingModule.h.

m_storeTracks

StoreArray<BKLMTrack> m_storeTracks

private

BKLMTrack StoreArray.

Definition at line 132 of file BKLMTrackingModule.h.

m_studyEffi

bool m_studyEffi

protected

option for efficiency study mode, in this mode, the layer under study should not be used in tracking

Definition at line 69 of file BKLMTrackingModule.h.

m_total

TH1F* m_total[2][8]

private

Denominator of each layer.

Definition at line 104 of file BKLMTrackingModule.h.

m_totalEvents

std::vector<int> m_totalEvents

private

total number of processed events

Definition at line 170 of file BKLMTrackingModule.h.

m_totalEventsWithTracks

std::vector<int> m_totalEventsWithTracks

private

total number of processed events with at least one BKLMTrack

Definition at line 176 of file BKLMTrackingModule.h.

m_totalYX

TH2F* m_totalYX

private

total event at global position Y vs X

Definition at line 124 of file BKLMTrackingModule.h.

m_totalYZ

TH2F* m_totalYZ

private

total event at global position Y vs Z

Definition at line 130 of file BKLMTrackingModule.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.

recoHitInformation

StoreArray<RecoHitInformation> recoHitInformation

private

RecoHitInformation StoreArray.

Definition at line 141 of file BKLMTrackingModule.h.

recoTracks

StoreArray<RecoTrack> recoTracks

private

RecoTrack StoreArray.

Definition at line 138 of file BKLMTrackingModule.h.

---

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

• klm/bklm/modules/bklmTracking/include/BKLMTrackingModule.h
• klm/bklm/modules/bklmTracking/src/BKLMTrackingModule.cc