Belle II Software development
KLMReconstructorModule Class Reference

Create BKLMHit1ds from BKLMDigits and then create KLMHit2ds from BKLMHit1ds; create KLMHit2ds from EKLMDigits. More...

#include <KLMReconstructorModule.h>

Inheritance diagram for KLMReconstructorModule:
Module PathElement

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

 KLMReconstructorModule ()
 Constructor.
 
 ~KLMReconstructorModule ()
 Destructor.
 
void initialize () override
 Initializer.
 
void beginRun () override
 Called when entering a new run.
 
void event () override
 Called for each event.
 
void endRun () override
 Called if the current run ends.
 
void terminate () override
 Called at the end of the event processing.
 
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.
 
LogConfiggetLogConfig ()
 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 ModuleConditiongetCondition () 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< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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 reconstructBKLMHits ()
 Reconstruct BKLM 2d hits.
 
void reconstructEKLMHits ()
 Reconstruct EKLNM 2d hits.
 
bool isNormal (const KLMDigit *digit) const
 Check if channel is normal or dead.
 
void correctCableDelay (double &td, const KLMDigit *digit)
 Time correction by subtract cable delay.
 
std::list< ModulePtrgetModules () 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

double m_CoincidenceWindow
 Half-width of the time coincidence window used to create a 2D hit from 1D digits/hits.
 
double m_PromptTime
 Nominal time of prompt KLMHit2ds.
 
double m_PromptWindow
 Half-width of the time window relative to the prompt time for KLMHit2ds.
 
double m_DelayEKLMScintillators = 0.0
 Delay (ns / cm) for EKLM scintillators.
 
double m_DelayBKLMScintillators = 0.0
 Delay (ns / cm) for BKLM scintillators.
 
double m_DelayRPCPhi = 0.0
 Delay (ns / cm) for RPC phi plane.
 
double m_DelayRPCZ = 0.0
 Delay (ns / cm) for RPC Z plane.
 
bool m_TimeCableDelayCorrection
 Perform cable delay time correction (true) or not (false).
 
bool m_EventT0Correction
 Perform EventT0 correction (true) or not (false).
 
bool m_IgnoreHotChannels
 Use only normal and dead (for debugging) channels during 2d hit reconstruction.
 
double m_EventT0Value
 Value of the EventT0.
 
const KLMElementNumbersm_ElementNumbers
 KLM element numbers.
 
DBObjPtr< KLMTimeWindowm_TimeWindow
 KLM time window.
 
OptionalDBObjPtr< KLMTimeConstantsm_TimeConstants
 KLM time constants.
 
OptionalDBObjPtr< KLMTimeCableDelaym_TimeCableDelay
 KLM time cable delay.
 
OptionalDBObjPtr< KLMTimeResolutionm_TimeResolution
 KLM time resolution.
 
DBObjPtr< KLMChannelStatusm_ChannelStatus
 Channel status.
 
StoreArray< KLMDigitm_Digits
 KLM digits.
 
StoreArray< KLMHit2dm_Hit2ds
 KLM 2d hits.
 
StoreObjPtr< EventT0m_EventT0
 EventT0.
 
StoreObjPtr< EventLevelClusteringInfom_EventLevelClusteringInfo
 EventLevelClusteringInfo.
 
bklm::GeometryParm_bklmGeoPar
 BKLM GeometryPar singleton.
 
bool m_bklmIfAlign
 Perform alignment correction (true) or not (false).
 
bool m_bklmIgnoreScintillators
 Ignore scintillators (to debug their electronics mapping).
 
StoreArray< BKLMHit1dm_bklmHit1ds
 BKLM 1d hits.
 
bool m_eklmCheckSegmentIntersection
 Check if segments intersect.
 
const EKLMElementNumbersm_eklmElementNumbers
 EKLM element numbers.
 
const EKLM::GeometryDatam_eklmGeoDat
 Geometry data.
 
int m_eklmNStrip
 Number of strips.
 
EKLM::TransformDatam_eklmTransformData
 Transformation data.
 
StoreArray< EKLMAlignmentHitm_eklmAlignmentHits
 Alignment Hits.
 
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< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

Create BKLMHit1ds from BKLMDigits and then create KLMHit2ds from BKLMHit1ds; create KLMHit2ds from EKLMDigits.

Definition at line 43 of file KLMReconstructorModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

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.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ KLMReconstructorModule()

Constructor.

Definition at line 65 of file KLMReconstructorModule.cc.

65 :
66 Module(),
68 m_PromptTime(0),
72 m_bklmGeoPar(nullptr),
74 m_eklmGeoDat(nullptr),
75 m_eklmNStrip(0),
76 m_eklmTransformData{nullptr}
77{
78 setDescription("Create BKLMHit1ds from KLMDigits and then create KLMHit2ds from BKLMHit1ds; create KLMHit2ds from KLMDigits.");
80 addParam("TimeCableDelayCorrection", m_TimeCableDelayCorrection,
81 "Perform cable delay time correction (true) or not (false).", true);
82 addParam("EventT0Correction", m_EventT0Correction,
83 "Perform EventT0 correction (true) or not (false)", true);
84 addParam("IfAlign", m_bklmIfAlign,
85 "Perform alignment correction (true) or not (false).",
86 bool(true));
87 addParam("IgnoreScintillators", m_bklmIgnoreScintillators,
88 "Ignore scintillators (to debug their electronics mapping).",
89 false);
90 addParam("CheckSegmentIntersection", m_eklmCheckSegmentIntersection,
91 "Check if segments intersect.", true);
92 addParam("IgnoreHotChannels", m_IgnoreHotChannels,
93 "Use only Normal and Dead (for debugging) channels during 2d hit reconstruction",
94 true);
95}
static const EKLMElementNumbers & Instance()
Instantiation.
static const KLMElementNumbers & Instance()
Instantiation.
bool m_TimeCableDelayCorrection
Perform cable delay time correction (true) or not (false).
EKLM::TransformData * m_eklmTransformData
Transformation data.
const KLMElementNumbers * m_ElementNumbers
KLM element numbers.
bklm::GeometryPar * m_bklmGeoPar
BKLM GeometryPar singleton.
double m_CoincidenceWindow
Half-width of the time coincidence window used to create a 2D hit from 1D digits/hits.
const EKLMElementNumbers * m_eklmElementNumbers
EKLM element numbers.
bool m_bklmIfAlign
Perform alignment correction (true) or not (false).
double m_EventT0Value
Value of the EventT0.
double m_PromptTime
Nominal time of prompt KLMHit2ds.
double m_PromptWindow
Half-width of the time window relative to the prompt time for KLMHit2ds.
const EKLM::GeometryData * m_eklmGeoDat
Geometry data.
bool m_EventT0Correction
Perform EventT0 correction (true) or not (false).
bool m_bklmIgnoreScintillators
Ignore scintillators (to debug their electronics mapping).
bool m_IgnoreHotChannels
Use only normal and dead (for debugging) channels during 2d hit reconstruction.
bool m_eklmCheckSegmentIntersection
Check if segments intersect.
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Module()
Constructor.
Definition: Module.cc:30
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

◆ ~KLMReconstructorModule()

Destructor.

Definition at line 97 of file KLMReconstructorModule.cc.

98{
99}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

Called when entering a new run.

Reimplemented from Module.

Definition at line 128 of file KLMReconstructorModule.cc.

129{
131 if (!m_TimeConstants.isValid())
132 B2FATAL("KLM time constants data are not available.");
133 if (!m_TimeCableDelay.isValid())
134 B2FATAL("KLM time cable decay data are not available.");
135 if (!m_TimeResolution.isValid())
136 B2ERROR("KLM time resolution data are not available. "
137 "The error is non-fatal because the data are only used to set "
138 "chi^2 of 2d hit, which is informational only now.");
139 }
140 if (!m_ChannelStatus.isValid())
141 B2FATAL("KLM channel status data are not available.");
142 if (!m_TimeWindow.isValid())
143 B2FATAL("KLM time window data are not available.");
144 m_CoincidenceWindow = m_TimeWindow->getCoincidenceWindow();
145 m_PromptTime = m_TimeWindow->getPromptTime();
146 m_PromptWindow = m_TimeWindow->getPromptWindow();
154 }
155}
OptionalDBObjPtr< KLMTimeResolution > m_TimeResolution
KLM time resolution.
DBObjPtr< KLMChannelStatus > m_ChannelStatus
Channel status.
double m_DelayBKLMScintillators
Delay (ns / cm) for BKLM scintillators.
double m_DelayRPCPhi
Delay (ns / cm) for RPC phi plane.
OptionalDBObjPtr< KLMTimeCableDelay > m_TimeCableDelay
KLM time cable delay.
double m_DelayEKLMScintillators
Delay (ns / cm) for EKLM scintillators.
OptionalDBObjPtr< KLMTimeConstants > m_TimeConstants
KLM time constants.
double m_DelayRPCZ
Delay (ns / cm) for RPC Z plane.
DBObjPtr< KLMTimeWindow > m_TimeWindow
KLM time window.
@ c_BKLM
BKLM scintillator.
@ c_EKLM
EKLM scintillator.

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

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ correctCableDelay()

void correctCableDelay ( double &  td,
const KLMDigit digit 
)
private

Time correction by subtract cable delay.

Parameters
[in]tdOriginal time of the digit.
[in]digitKLM Digit.

Definition at line 169 of file KLMReconstructorModule.cc.

170{
171 unsigned int cID = d->getUniqueChannelID();
172 ct -= m_TimeCableDelay->getTimeDelay(cID);
173}

◆ 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(); }
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(); }
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(); }
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(); }
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(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

void endRun ( void  )
overridevirtual

Called if the current run ends.

Reimplemented from Module.

Definition at line 513 of file KLMReconstructorModule.cc.

514{
515}

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

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

Called for each event.

Reimplemented from Module.

Definition at line 157 of file KLMReconstructorModule.cc.

158{
159 m_EventT0Value = 0.;
160 if (m_EventT0.isValid())
161 if (m_EventT0->hasEventT0())
162 m_EventT0Value = m_EventT0->getEventT0();
163 if (not m_EventLevelClusteringInfo.isValid())
164 m_EventLevelClusteringInfo.construct();
167}
void reconstructEKLMHits()
Reconstruct EKLNM 2d hits.
StoreObjPtr< EventLevelClusteringInfo > m_EventLevelClusteringInfo
EventLevelClusteringInfo.
void reconstructBKLMHits()
Reconstruct BKLM 2d hits.
StoreObjPtr< EventT0 > m_EventT0
EventT0.

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 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.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 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.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "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.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

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

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

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

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

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

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

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

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

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

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

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

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

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

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

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

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ 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
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

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

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ 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
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ 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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

Initializer.

Reimplemented from Module.

Definition at line 101 of file KLMReconstructorModule.cc.

102{
103 m_Digits.isRequired();
105 m_EventT0.isRequired();
106 // This object is registered by few packages. Let's be agnostic about the
107 // execution order of the modules: the first package run registers the module
108 m_EventLevelClusteringInfo.isOptional() ? m_EventLevelClusteringInfo.isRequired() :
109 m_EventLevelClusteringInfo.registerInDataStore();
110 m_Hit2ds.registerInDataStore();
111 m_Hit2ds.registerRelationTo(m_bklmHit1ds);
112 m_Hit2ds.registerRelationTo(m_Digits);
113 /* BKLM. */
114 m_bklmHit1ds.registerInDataStore();
115 m_bklmHit1ds.registerRelationTo(m_Digits);
117 /* EKLM. */
118 m_eklmAlignmentHits.registerInDataStore();
119 m_eklmAlignmentHits.registerRelationTo(m_Hit2ds);
123 if (m_eklmGeoDat->getNPlanes() != 2)
124 B2FATAL("It is not possible to run EKLM reconstruction with 1 plane.");
126}
static constexpr int getMaximalStripGlobalNumber()
Get maximal strip global number.
int getNPlanes() const
Get number of planes.
static const GeometryData & Instance(enum DataSource dataSource=c_Database, const GearDir *gearDir=nullptr)
Instantiation.
Definition: GeometryData.cc:33
Transformation data.
Definition: TransformData.h:35
@ c_Alignment
Use alignment data (for everything else).
Definition: TransformData.h:45
StoreArray< KLMDigit > m_Digits
KLM digits.
StoreArray< EKLMAlignmentHit > m_eklmAlignmentHits
Alignment Hits.
StoreArray< BKLMHit1d > m_bklmHit1ds
BKLM 1d hits.
StoreArray< KLMHit2d > m_Hit2ds
KLM 2d hits.
static GeometryPar * instance(void)
Static method to get a reference to the singleton GeometryPar instance.
Definition: GeometryPar.cc:27

◆ isNormal()

bool isNormal ( const KLMDigit digit) const
private

Check if channel is normal or dead.

Dead channels should not contain any signal; they are allowed for debugging.

Parameters
[in]digitKLM digit.

Definition at line 193 of file KLMReconstructorModule.cc.

194{
195 int subdetector = digit->getSubdetector();
196 int section = digit->getSection();
197 int sector = digit->getSector();
198 int layer = digit->getLayer();
199 int plane = digit->getPlane();
200 int strip = digit->getStrip();
201 KLMChannelNumber channel = m_ElementNumbers->channelNumber(subdetector, section, sector, layer, plane, strip);
202 enum KLMChannelStatus::ChannelStatus status = m_ChannelStatus->getChannelStatus(channel);
203 if (status == KLMChannelStatus::c_Unknown)
204 B2FATAL("Incomplete KLM channel status data.");
205 if (status == KLMChannelStatus::c_Normal || status == KLMChannelStatus::c_Dead)
206 return true;
207 return false;
208}
ChannelStatus
Channel status.
@ c_Normal
Normally operating channel.
@ c_Dead
Dead channel (no signal).
@ c_Unknown
Unknown status (no data).
int getSubdetector() const
Get subdetector number.
Definition: KLMDigit.h:72
int getLayer() const
Get layer number.
Definition: KLMDigit.h:126
int getSection() const
Get section number.
Definition: KLMDigit.h:90
int getPlane() const
Get plane number.
Definition: KLMDigit.h:144
int getStrip() const
Get strip number.
Definition: KLMDigit.h:162
int getSector() const
Get sector number.
Definition: KLMDigit.h:108
KLMChannelNumber channelNumber(int subdetector, int section, int sector, int layer, int plane, int strip) const
Get channel number.
uint16_t KLMChannelNumber
Channel number.

◆ reconstructBKLMHits()

void reconstructBKLMHits ( )
private

Reconstruct BKLM 2d hits.

Definition at line 210 of file KLMReconstructorModule.cc.

211{
212 /* Let's count the multi-strip KLMDigits. */
213 uint16_t nKLMDigitsMultiStripBarrel{0};
214 /* Construct BKLMHit1Ds from KLMDigits. */
215 /* Sort KLMDigits by module and strip number. */
216 std::map<KLMChannelNumber, int> channelDigitMap;
217 for (int index = 0; index < m_Digits.getEntries(); ++index) {
218 const KLMDigit* digit = m_Digits[index];
220 continue;
221 if (digit->isMultiStrip()) {
222 nKLMDigitsMultiStripBarrel++;
223 }
224 if (m_bklmIgnoreScintillators && !digit->inRPC())
225 continue;
226 if (m_IgnoreHotChannels && !isNormal(digit))
227 continue;
228 if (digit->inRPC() || digit->isGood()) {
230 digit->getSection(), digit->getSector(),
231 digit->getLayer(), digit->getPlane(),
232 digit->getStrip());
233 channelDigitMap.insert(std::pair<KLMChannelNumber, int>(channel, index));
234 }
235 }
236 if (channelDigitMap.empty())
237 return;
238 std::vector<std::pair<const KLMDigit*, double>> digitCluster;
239 KLMChannelNumber previousChannel = channelDigitMap.begin()->first;
240 double averageTime = m_Digits[channelDigitMap.begin()->second]->getTime();
242 correctCableDelay(averageTime, m_Digits[channelDigitMap.begin()->second]);
243 for (std::map<KLMChannelNumber, int>::iterator it = channelDigitMap.begin(); it != channelDigitMap.end(); ++it) {
244 const KLMDigit* digit = m_Digits[it->second];
245 double digitTime = digit->getTime();
247 correctCableDelay(digitTime, digit);
248 if ((it->first > previousChannel + 1) || (std::fabs(digitTime - averageTime) > m_CoincidenceWindow)) {
249 m_bklmHit1ds.appendNew(digitCluster); // Also sets relation BKLMHit1d -> KLMDigit
250 digitCluster.clear();
251 }
252 previousChannel = it->first;
253 double n = (double)(digitCluster.size());
254 averageTime = (n * averageTime + digitTime) / (n + 1.0);
255 digitCluster.emplace_back(std::make_pair(digit, digitTime));
256 }
257 m_bklmHit1ds.appendNew(digitCluster); // Also sets relation BKLMHit1d -> KLMDigit
258
259 /* Construct BKLMHit2Ds from orthogonal same-module BKLMHit1Ds. */
260 for (int i = 0; i < m_bklmHit1ds.getEntries(); ++i) {
261 int moduleID = m_bklmHit1ds[i]->getModuleID();
262 const bklm::Module* m = m_bklmGeoPar->findModule(m_bklmHit1ds[i]->getSection(), m_bklmHit1ds[i]->getSector(),
263 m_bklmHit1ds[i]->getLayer());
264 bool isPhiReadout = m_bklmHit1ds[i]->isPhiReadout();
265 for (int j = i + 1; j < m_bklmHit1ds.getEntries(); ++j) {
267 moduleID, m_bklmHit1ds[j]->getModuleID()))
268 continue;
269 if (isPhiReadout == m_bklmHit1ds[j]->isPhiReadout())
270 continue;
271 int phiIndex = isPhiReadout ? i : j;
272 int zIndex = isPhiReadout ? j : i;
273 const BKLMHit1d* phiHit = m_bklmHit1ds[phiIndex];
274 const BKLMHit1d* zHit = m_bklmHit1ds[zIndex];
275 CLHEP::Hep3Vector local = m->getLocalPosition(phiHit->getStripAve(), zHit->getStripAve());
276 CLHEP::Hep3Vector propagationDist;
278 if (isPhiReadout) {
279 propagationDist = m->getPropagationDistance(
280 local, m_bklmHit1ds[j]->getStripMin(),
281 m_bklmHit1ds[i]->getStripMin());
282 } else {
283 propagationDist = m->getPropagationDistance(
284 local, m_bklmHit1ds[i]->getStripMin(),
285 m_bklmHit1ds[j]->getStripMin());
286 }
287 } else {
288 propagationDist = m->getPropagationTimes(local);
289 }
290 double delayPhi, delayZ;
291 if (phiHit->inRPC())
292 delayPhi = m_DelayRPCPhi;
293 else
294 delayPhi = m_DelayBKLMScintillators;
295 if (zHit->inRPC())
296 delayZ = m_DelayRPCZ;
297 else
299 double phiTime = phiHit->getTime() - propagationDist.y() * delayPhi;
300 double zTime = zHit->getTime() - propagationDist.z() * delayZ;
301 if (std::fabs(phiTime - zTime) > m_CoincidenceWindow)
302 continue;
303 // The second param in localToGlobal is whether do the alignment correction (true) or not (false)
304 CLHEP::Hep3Vector global = m->localToGlobal(local + m->getLocalReconstructionShift(), m_bklmIfAlign);
305 double time = 0.5 * (phiTime + zTime);
307 time -= m_EventT0Value;
308 KLMHit2d* hit2d = m_Hit2ds.appendNew(phiHit, zHit, global, time); // Also sets relation KLMHit2d -> BKLMHit1d
309 if (std::fabs(time - m_PromptTime) > m_PromptWindow)
310 hit2d->isOutOfTime(true);
311 }
312 }
313 m_EventLevelClusteringInfo->setNKLMDigitsMultiStripBarrel(nKLMDigitsMultiStripBarrel);
314}
static KLMChannelNumber channelNumber(int section, int sector, int layer, int plane, int strip)
Get channel number.
@ c_FirstRPCLayer
First RPC layer.
static bool hitsFromSameModule(int module1, int module2)
Check whether the hits are from the same module.
Store one reconstructed BKLM 1D hit as a ROOT object.
Definition: BKLMHit1d.h:30
bool inRPC() const
Determine whether this 1D hit is in RPC or scintillator.
Definition: BKLMHit1d.h:54
float getTime() const
Get reconstructed hit time.
Definition: BKLMHit1d.h:126
double getStripAve() const
Get average strip number.
Definition: BKLMHit1d.h:111
KLM digit (class representing a digitized hit in RPCs or scintillators).
Definition: KLMDigit.h:29
bool inRPC() const
Determine whether the hit is in RPC or scintillator.
Definition: KLMDigit.h:206
bool isGood() const
Whether hit could be used late (if it passed discriminator threshold)
Definition: KLMDigit.h:348
float getTime() const
Get hit time.
Definition: KLMDigit.h:276
bool isMultiStrip() const
Determine whether this digit is a multi-strip one or not.
Definition: KLMDigit.h:197
KLM 2d hit.
Definition: KLMHit2d.h:33
bool isOutOfTime() const
Determine whether this 2D hit is outside the trigger-coincidence window.
Definition: KLMHit2d.h:395
bool isNormal(const KLMDigit *digit) const
Check if channel is normal or dead.
void correctCableDelay(double &td, const KLMDigit *digit)
Time correction by subtract cable delay.
const Module * findModule(int section, int sector, int layer) const
Get the pointer to the definition of a module.
Definition: GeometryPar.cc:721
Define the geometry of a BKLM module Each sector [octant] contains Modules.
Definition: Module.h:76

◆ reconstructEKLMHits()

void reconstructEKLMHits ( )
private

Reconstruct EKLNM 2d hits.

Definition at line 317 of file KLMReconstructorModule.cc.

318{
319 /* Let's count the multi-strip KLMDigits. */
320 uint16_t nKLMDigitsMultiStripFWD{0};
321 uint16_t nKLMDigitsMultiStripBWD{0};
322 int i, n;
323 double d1, d2, time, t1, t2, sd;
324 std::vector<KLMDigit*> digitVector;
325 std::vector<KLMDigit*>::iterator it1, it2, it3, it4, it5, it6, it7, it8, it9;
326 n = m_Digits.getEntries();
327 for (i = 0; i < n; i++) {
328 KLMDigit* digit = m_Digits[i];
330 continue;
331 if (digit->isMultiStrip()) {
332 digit->getSection() == EKLMElementNumbers::c_BackwardSection ? nKLMDigitsMultiStripBWD++ : nKLMDigitsMultiStripFWD++;
333 }
334 if (m_IgnoreHotChannels && !isNormal(digit))
335 continue;
336 if (digit->isGood())
337 digitVector.push_back(digit);
338 }
339 KLMDigit plane1Digit; // to look for geometric intersection of a multi-strip hit
340 KLMDigit plane2Digit; // to look for geometric intersection of a multi-strip hit
341 HepGeom::Point3D<double> crossPoint(0, 0, 0); // (x,y,z) of geometric intersection
342 /* Sort by sector. */
343 sort(digitVector.begin(), digitVector.end(), compareSector);
344 it1 = digitVector.begin();
345 while (it1 != digitVector.end()) {
346 it2 = it1;
347 while (1) {
348 ++it2;
349 if (it2 == digitVector.end())
350 break;
351 if (!sameSector(*it1, *it2))
352 break;
353 }
354 /* Now it1 .. it2 - hits in a sector. Sort by plane. */
355 sort(it1, it2, comparePlane);
356 /* If all hits are form the second plane, then continue. */
357 if ((*it1)->getPlane() != 1) {
358 it1 = it2;
359 continue;
360 }
361 it3 = it1;
362 while (1) {
363 ++it3;
364 if (it3 == it2)
365 break;
366 if ((*it3)->getPlane() != (*it1)->getPlane())
367 break;
368 }
369 /*
370 * Now it1 .. it3 - hits from the first plane, it3 .. it2 - hits from the
371 * second plane. If there are no hits from the second plane, then continue.
372 */
373 if (it3 == it2) {
374 it1 = it2;
375 continue;
376 }
377 /* Sort by strip. */
378 sort(it1, it3, compareStrip);
379 sort(it3, it2, compareStrip);
380 it4 = it1;
381 while (it4 != it2) {
382 it5 = it4;
383 while (1) {
384 ++it5;
385 if (it5 == it2)
386 break;
387 /* This loop is for both planes so it is necessary to compare planes. */
388 if ((*it5)->getStrip() != (*it4)->getStrip() ||
389 (*it5)->getPlane() != (*it4)->getPlane())
390 break;
391 }
392 /* Now it4 .. it5 - hits from the same strip. Sort by time. */
393 sort(it4, it5, compareTime);
394 it4 = it5;
395 }
396 /* Strip loop. */
397 it4 = it1;
398 while (it4 != it3) {
399 it5 = it4;
400 while (1) {
401 ++it5;
402 if (it5 == it3)
403 break;
404 if ((*it5)->getStrip() != (*it4)->getStrip())
405 break;
406 }
407 it6 = it3;
408 while (it6 != it2) {
409 it7 = it6;
410 while (1) {
411 ++it7;
412 if (it7 == it2)
413 break;
414 if ((*it7)->getStrip() != (*it6)->getStrip())
415 break;
416 }
417 /*
418 * Now it4 .. it5 - hits from a single first-plane strip and
419 * it6 .. it7 - hits from a single second-plane strip.
420 */
421 for (it8 = it4; it8 != it5; ++it8) {
422 for (it9 = it6; it9 != it7; ++it9) {
423 /*
424 * Check for intersection of the two orthogonal strips. On one strip,
425 * one hit might be multi-strip and another single-strip, so the
426 * intersection check must be done here rather than before the loop.
427 */
428 bool intersect = false;
429 if ((*it8)->isMultiStrip() || (*it9)->isMultiStrip()) {
430 plane1Digit = **it8;
431 plane2Digit = **it9;
432 int s1First = plane1Digit.getStrip();
433 int s1Last = std::max(s1First, plane1Digit.getLastStrip());
434 int s2First = plane2Digit.getStrip();
435 int s2Last = std::max(s2First, plane2Digit.getLastStrip());
436 for (int s1 = s1First; s1 <= s1Last; s1++) {
437 plane1Digit.setStrip(s1);
438 for (int s2 = s2First; s2 <= s2Last; s2++) {
439 plane2Digit.setStrip(s2);
440 intersect = m_eklmTransformData->intersection(&plane1Digit, &plane2Digit, &crossPoint,
441 &d1, &d2, &sd,
443 if (intersect)
444 break;
445 }
446 if (intersect)
447 break;
448 }
449 if (intersect) {
450 // use the middle strip in the multi-strip group to get the 2D intersection point
451 plane1Digit.setStrip((s1First + s1Last) / 2);
452 plane2Digit.setStrip((s2First + s2Last) / 2);
453 intersect = m_eklmTransformData->intersection(&plane1Digit, &plane2Digit, &crossPoint,
454 &d1, &d2, &sd,
455 false); // crossPoint MIGHT be outside fiducial area
456 }
457 } else {
458 intersect = m_eklmTransformData->intersection(*it8, *it9, &crossPoint,
459 &d1, &d2, &sd,
461 }
462 if (!intersect)
463 continue;
464 t1 = (*it8)->getTime() - d1 * m_DelayEKLMScintillators
465 + 0.5 * sd / Const::speedOfLight;
466 t2 = (*it9)->getTime() - d2 * m_DelayEKLMScintillators
467 - 0.5 * sd / Const::speedOfLight;
469 correctCableDelay(t1, *it8);
470 correctCableDelay(t2, *it9);
471 }
472 if (std::fabs(t1 - t2) > m_CoincidenceWindow)
473 continue;
474 time = (t1 + t2) / 2;
476 time -= m_EventT0Value;
477 KLMHit2d* hit2d = m_Hit2ds.appendNew(*it8, *it9);
478 hit2d->setEnergyDeposit((*it8)->getEnergyDeposit() +
479 (*it9)->getEnergyDeposit());
480 hit2d->setPosition(crossPoint.x(), crossPoint.y(), crossPoint.z());
481 double timeResolution = 1.0;
482 if (m_TimeResolution.isValid()) {
483 timeResolution *= m_TimeResolution->getTimeResolution(
484 (*it8)->getUniqueChannelID());
485 timeResolution *= m_TimeResolution->getTimeResolution(
486 (*it9)->getUniqueChannelID());
487 }
488 hit2d->setChiSq((t1 - t2) * (t1 - t2) / timeResolution);
489 hit2d->setTime(time);
490 hit2d->setMCTime(((*it8)->getMCTime() + (*it9)->getMCTime()) / 2);
491 hit2d->addRelationTo(*it8);
492 hit2d->addRelationTo(*it9);
493 for (i = 0; i < 2; i++) {
494 EKLMAlignmentHit* alignmentHit = m_eklmAlignmentHits.appendNew(i);
495 alignmentHit->addRelationTo(hit2d);
496 }
497 /* Exit the loop. Equivalent to selection of the earliest hit. */
498 break;
499 }
500 /* Exit the loop. Equivalent to selection of the earliest hit. */
501 break;
502 }
503 it6 = it7;
504 }
505 it4 = it5;
506 }
507 it1 = it2;
508 }
509 m_EventLevelClusteringInfo->setNKLMDigitsMultiStripBWD(nKLMDigitsMultiStripBWD);
510 m_EventLevelClusteringInfo->setNKLMDigitsMultiStripFWD(nKLMDigitsMultiStripFWD);
511}
static const double speedOfLight
[cm/ns]
Definition: Const.h:695
This dataobject is used only for EKLM alignment.
bool intersection(KLMDigit *hit1, KLMDigit *hit2, HepGeom::Point3D< double > *cross, double *d1, double *d2, double *sd, bool segments=true) const
Check if strips intersect, and find intersection point if yes.
void setStrip(int strip)
Set strip number.
Definition: KLMDigit.h:171
int getLastStrip() const
Get last strip number (for multi-strip digits).
Definition: KLMDigit.h:180
void setEnergyDeposit(float energyDeposit)
Set energy deposit.
Definition: KLMHit2d.h:369
void setChiSq(float chisq)
Set Chi^2 of the crossing point.
Definition: KLMHit2d.h:387
void setTime(float time)
Set hit time.
Definition: KLMHit2d.h:333
void setMCTime(float t)
Set MC time.
Definition: KLMHit2d.h:342
void setPosition(float x, float y, float z)
Set hit global position.
Definition: KLMHit2d.h:277
void addRelationTo(const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
Add a relation from this object to another object (with caching).
int intersect(const TRGCDCLpar &lp1, const TRGCDCLpar &lp2, CLHEP::HepVector &v1, CLHEP::HepVector &v2)
intersection
Definition: Lpar.cc:249

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ 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
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ 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
nameThe 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
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ 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
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ 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
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ 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
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

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

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

◆ terminate()

void terminate ( void  )
overridevirtual

Called at the end of the event processing.

Reimplemented from Module.

Definition at line 517 of file KLMReconstructorModule.cc.

518{
519 delete m_eklmTransformData;
520}

Member Data Documentation

◆ m_bklmGeoPar

bklm::GeometryPar* m_bklmGeoPar
private

BKLM GeometryPar singleton.

Definition at line 187 of file KLMReconstructorModule.h.

◆ m_bklmHit1ds

StoreArray<BKLMHit1d> m_bklmHit1ds
private

BKLM 1d hits.

Definition at line 196 of file KLMReconstructorModule.h.

◆ m_bklmIfAlign

bool m_bklmIfAlign
private

Perform alignment correction (true) or not (false).

Definition at line 190 of file KLMReconstructorModule.h.

◆ m_bklmIgnoreScintillators

bool m_bklmIgnoreScintillators
private

Ignore scintillators (to debug their electronics mapping).

Definition at line 193 of file KLMReconstructorModule.h.

◆ m_ChannelStatus

DBObjPtr<KLMChannelStatus> m_ChannelStatus
private

Channel status.

Definition at line 170 of file KLMReconstructorModule.h.

◆ m_CoincidenceWindow

double m_CoincidenceWindow
private

Half-width of the time coincidence window used to create a 2D hit from 1D digits/hits.

Definition at line 116 of file KLMReconstructorModule.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_DelayBKLMScintillators

double m_DelayBKLMScintillators = 0.0
private

Delay (ns / cm) for BKLM scintillators.

Definition at line 131 of file KLMReconstructorModule.h.

◆ m_DelayEKLMScintillators

double m_DelayEKLMScintillators = 0.0
private

Delay (ns / cm) for EKLM scintillators.

Definition at line 128 of file KLMReconstructorModule.h.

◆ m_DelayRPCPhi

double m_DelayRPCPhi = 0.0
private

Delay (ns / cm) for RPC phi plane.

Definition at line 134 of file KLMReconstructorModule.h.

◆ m_DelayRPCZ

double m_DelayRPCZ = 0.0
private

Delay (ns / cm) for RPC Z plane.

Definition at line 137 of file KLMReconstructorModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_Digits

StoreArray<KLMDigit> m_Digits
private

KLM digits.

Definition at line 173 of file KLMReconstructorModule.h.

◆ m_eklmAlignmentHits

StoreArray<EKLMAlignmentHit> m_eklmAlignmentHits
private

Alignment Hits.

Definition at line 219 of file KLMReconstructorModule.h.

◆ m_eklmCheckSegmentIntersection

bool m_eklmCheckSegmentIntersection
private

Check if segments intersect.

Normally should be true, but it may be necessary to turn this check off for debugging.

Definition at line 204 of file KLMReconstructorModule.h.

◆ m_eklmElementNumbers

const EKLMElementNumbers* m_eklmElementNumbers
private

EKLM element numbers.

Definition at line 207 of file KLMReconstructorModule.h.

◆ m_eklmGeoDat

const EKLM::GeometryData* m_eklmGeoDat
private

Geometry data.

Definition at line 210 of file KLMReconstructorModule.h.

◆ m_eklmNStrip

int m_eklmNStrip
private

Number of strips.

Definition at line 213 of file KLMReconstructorModule.h.

◆ m_eklmTransformData

EKLM::TransformData* m_eklmTransformData
private

Transformation data.

Definition at line 216 of file KLMReconstructorModule.h.

◆ m_ElementNumbers

const KLMElementNumbers* m_ElementNumbers
private

KLM element numbers.

Definition at line 155 of file KLMReconstructorModule.h.

◆ m_EventLevelClusteringInfo

StoreObjPtr<EventLevelClusteringInfo> m_EventLevelClusteringInfo
private

◆ m_EventT0

StoreObjPtr<EventT0> m_EventT0
private

EventT0.

Definition at line 179 of file KLMReconstructorModule.h.

◆ m_EventT0Correction

bool m_EventT0Correction
private

Perform EventT0 correction (true) or not (false).

Definition at line 143 of file KLMReconstructorModule.h.

◆ m_EventT0Value

double m_EventT0Value
private

Value of the EventT0.

Definition at line 152 of file KLMReconstructorModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_Hit2ds

StoreArray<KLMHit2d> m_Hit2ds
private

KLM 2d hits.

Definition at line 176 of file KLMReconstructorModule.h.

◆ m_IgnoreHotChannels

bool m_IgnoreHotChannels
private

Use only normal and dead (for debugging) channels during 2d hit reconstruction.

Definition at line 149 of file KLMReconstructorModule.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_PromptTime

double m_PromptTime
private

Nominal time of prompt KLMHit2ds.

Definition at line 119 of file KLMReconstructorModule.h.

◆ m_PromptWindow

double m_PromptWindow
private

Half-width of the time window relative to the prompt time for KLMHit2ds.

Definition at line 125 of file KLMReconstructorModule.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_TimeCableDelay

OptionalDBObjPtr<KLMTimeCableDelay> m_TimeCableDelay
private

KLM time cable delay.

Definition at line 164 of file KLMReconstructorModule.h.

◆ m_TimeCableDelayCorrection

bool m_TimeCableDelayCorrection
private

Perform cable delay time correction (true) or not (false).

Definition at line 140 of file KLMReconstructorModule.h.

◆ m_TimeConstants

OptionalDBObjPtr<KLMTimeConstants> m_TimeConstants
private

KLM time constants.

Definition at line 161 of file KLMReconstructorModule.h.

◆ m_TimeResolution

OptionalDBObjPtr<KLMTimeResolution> m_TimeResolution
private

KLM time resolution.

Definition at line 167 of file KLMReconstructorModule.h.

◆ m_TimeWindow

DBObjPtr<KLMTimeWindow> m_TimeWindow
private

KLM time window.

Definition at line 158 of file KLMReconstructorModule.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: