Belle II Software development
TRGTOPUnpackerModule Class Reference

TRG TOP Unpacker. More...

#include <trgtopUnpackerModule.h>

Inheritance diagram for TRGTOPUnpackerModule:
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

 TRGTOPUnpackerModule ()
 Constructor: Sets the description, the properties and the parameters of the module.
 
virtual void initialize () override
 Initialize the Module.
 
virtual void beginRun () override
 Called when entering a new run.
 
virtual void event () override
 This method is the core of the module.
 
virtual void endRun () override
 This method is called if the current run ends.
 
virtual void terminate () override
 This method is called at the end of the event processing.
 
std::string version () const
 returns version of TRGGDLUnpackerModule.
 
virtual void readDAQEvent (RawTRG *, int, int)
 Read data from TRG DAQ.
 
virtual void unpackT0Decisions (int *, int)
 Unpacker main function.
 
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.
 

Static Public Attributes

static constexpr double clkTo1ns = 0.5 / 0.508877
 

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

int m_eventNumber
 Event number (according to L1/global)
 
int m_trigType
 Trigger type.
 
int m_nodeId
 Our read-out ID.
 
int m_nWords
 N words in raw data.
 
bool m_pciedata
 PCIe40 data or copper data.
 
bool m_reportedAlreadyRun_1
 
bool m_reportedAlreadyRun_2
 
bool m_overrideControlBits
 

Private Member Functions

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

StoreArray< TRGTOPCombinedT0Decisionm_TRGTOPCombinedT0DecisionArray
 
StoreArray< TRGTOPSlotTimingm_TRGTOPSlotTimingArray
 
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.
 

Static Private Attributes

static constexpr int s_revoToNS = 1280 * 8
 time period of revo strobe in "ns" (assuming the clock of "125MHz")
 

Detailed Description

TRG TOP Unpacker.

TOP trigger unpacker

Definition at line 35 of file trgtopUnpackerModule.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,
80 c_ParallelProcessingCertified = 4,
81 c_HistogramManager = 8,
82 c_InternalSerializer = 16,
83 c_TerminateInAllProcesses = 32,
84 c_DontCollectStatistics = 64,
85 };
@ c_Output
Output Process.
Definition ProcHelper.h:19
@ c_Input
Input Process.
Definition ProcHelper.h:17

Constructor & Destructor Documentation

◆ TRGTOPUnpackerModule()

Constructor: Sets the description, the properties and the parameters of the module.

Definition at line 40 of file trgtopUnpackerModule.cc.

41 : Module::Module(), m_eventNumber(0), m_trigType(0), m_nodeId(0), m_nWords(0), m_reportedAlreadyRun_1(false),
42 m_reportedAlreadyRun_2(false)
43{
44 // Set module properties
45
46
47 std::string desc = "TRGTOPUnpackerModule(" + version() + ")";
48 setDescription(desc);
50
51 B2DEBUG(20, "TRGTOPUnpacker: Constructor done.");
52
53
54 // Parameter definitions
55 addParam("overrideControlBits", m_overrideControlBits,
56 "Override control bits in data",
57 true);
58 // false);
59
60}
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
@ 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
int m_nWords
N words in raw data.
int m_eventNumber
Event number (according to L1/global)
std::string version() const
returns version of TRGGDLUnpackerModule.
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:559

◆ ~TRGTOPUnpackerModule()

~TRGTOPUnpackerModule ( )
overridevirtual

Definition at line 62 of file trgtopUnpackerModule.cc.

63{
64}

Member Function Documentation

◆ beginRun()

void beginRun ( void )
overridevirtual

Called when entering a new run.

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

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 79 of file trgtopUnpackerModule.cc.

80{
81 m_reportedAlreadyRun_1 = false;
82 m_reportedAlreadyRun_2 = false;
83}

◆ 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{
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.
void setParameters(const ModuleParamList &params)
Set values for parameters from other parameter list.
const ModuleParamList & getParamList() const
Return module param list.
Definition Module.h:362
const std::string & getName() const
Returns the name of the module.
Definition Module.h:186
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:511
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition Module.h:515
void setName(const std::string &name)
Set the name of the module.
Definition Module.h:213
LogConfig m_logConfig
The log system configuration of the module.
Definition Module.h:513
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition Module.h:520
std::string m_package
Package this module is found in (may be empty).
Definition Module.h:509
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

425{ beginRun(); }

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 438 of file Module.h.

438{ endRun(); }

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 431 of file Module.h.

431{ event(); }

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 419 of file Module.h.

419{ initialize(); }

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

444{ terminate(); }

◆ endRun()

void endRun ( void )
overridevirtual

This method is called if the current run ends.

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

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 703 of file trgtopUnpackerModule.cc.

704{
705}

◆ 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:518
bool m_hasReturnValue
True, if the return value is set.
Definition Module.h:517

◆ event()

void event ( void )
overridevirtual

This method is the core of the module.

This method is called for each event. All processing of the event has to take place in this method.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 85 of file trgtopUnpackerModule.cc.

86{
87
88 StoreArray<RawTRG> raw_trgarray;
89
90 for (int i = 0; i < raw_trgarray.getEntries(); i++) {
91
92 // Check PCIe40 data or Copper data
93 if (raw_trgarray[i]->GetMaxNumOfCh(0) == 48) { m_pciedata = true; }
94 else if (raw_trgarray[i]->GetMaxNumOfCh(0) == 4) { m_pciedata = false; }
95 else { B2FATAL("TRGTOPUnpackerModule: Invalid value of GetMaxNumOfCh from raw data: " << LogVar("Number of ch: ", raw_trgarray[i]->GetMaxNumOfCh(0))); }
96
97 int node_id = 0;
98 int ch_id_1 = 0;
99 int ch_id_2 = 1;
100 if (m_pciedata) {
101 node_id = 0x10000001;
102 ch_id_1 = 23;
103 ch_id_2 = 24;
104 } else {
105 node_id = 0x12000001;
106 ch_id_1 = 0;
107 ch_id_2 = 1;
108 }
109
110 for (int j = 0; j < raw_trgarray[i]->GetNumEntries(); j++) {
111
112 m_nodeId = raw_trgarray[i]->GetNodeID(j);
113
114 if (m_nodeId == node_id) {
115
116 int numberOfChannels = raw_trgarray[i]->GetMaxNumOfCh(i);
117
118 // B2INFO("raw_trgarray.GetMaxNumOfCh() = " << numberOfChannels);
119
120 for (int channel = 0; channel < numberOfChannels; channel++) {
121
122 if (channel != ch_id_1 && channel != ch_id_2) continue;
123
124 m_nWords = raw_trgarray[i]->GetDetectorNwords(j, channel);
125
126 // B2INFO("raw_trgarray[" << i << "]->GetDetectorNwords(" << j << ", " << channel << ") = " << m_nWords);
127
128 // if ( m_nWords > 3 ) { ////general header is 3 words long
129 if (m_nWords > 0) {
130
131 m_eventNumber = raw_trgarray[i]->GetEveNo(j);
132 m_trigType = raw_trgarray[i]->GetTRGType(j);
133
134 // B2INFO("raw_trgarray.getEntries() = " << raw_trgarray.getEntries());
135 // B2INFO("raw_trgarray[i]->GetNumEntries() = " << raw_trgarray[i]->GetNumEntries());
136 // B2INFO("raw_trgarray[]->GetEveNo(j) = " << raw_trgarray[i]->GetEveNo(j));
137 // B2INFO("raw_trgarray[]->GetNodeID(j) = " << std::hex << raw_trgarray[i]->GetNodeID(j) << std::dec);
138 // B2INFO("raw_trgarray[]->GetDetectorNwords(j,0) = " << m_nWords);
139
140 readDAQEvent(raw_trgarray[i], j, channel);
141
142 }
143 }
144 }
145 }
146 }
147}
int getEntries() const
Get the number of objects in the array.
Definition StoreArray.h:216
virtual void readDAQEvent(RawTRG *, int, int)
Read data from TRG DAQ.
bool m_pciedata
PCIe40 data or copper data.

◆ 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 paths */
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://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
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>()),
491 &Module::setLogConfig)
@ 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: "<".
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
@ 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_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
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
ModuleCondition::EAfterConditionPath EAfterConditionPath
Forward the EAfterConditionPath definition from the ModuleCondition.
Definition Module.h:88

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

324 {
325 return m_conditions;
326 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 313 of file Module.h.

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

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

201{return m_description;}

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, RootOutputModule, and StorageRootOutputModule.

Definition at line 133 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 186 of file Module.h.

186{return m_name;}

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

196{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

380{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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:508

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 310 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int propertyFlags) const
inherited

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

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

377{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

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

Initialize the Module.

This method is called once before the actual event processing starts. Use this method to initialize variables, open files etc.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 66 of file trgtopUnpackerModule.cc.

67{
68
69 m_TRGTOPCombinedT0DecisionArray.registerInDataStore();
70 // m_TRGTOPCombinedTimingArray.registerInDataStore();
71 m_TRGTOPSlotTimingArray.registerInDataStore();
72
73 // m_TRGTOPCombinedTimingArray.registerRelationTo(m_TRGTOPSlotTimingArray);
74 // m_TRGTOPSlotTimingArray.registerRelationTo(m_TRGTOPCombinedTimingArray);
75
76}

◆ readDAQEvent()

void readDAQEvent ( RawTRG * raw_daq,
int j,
int channel )
virtual

Read data from TRG DAQ.

Definition at line 149 of file trgtopUnpackerModule.cc.

150{
151 // if (raw_daq->GetDetectorNwords(j, channel) > 3) { ///general header is 3 words long
152 if (raw_daq->GetDetectorNwords(j, channel) > 0) {
153 unpackT0Decisions(raw_daq->GetDetectorBuffer(j, channel), channel);
154 }
155}
virtual void unpackT0Decisions(int *, int)
Unpacker main function.
int GetDetectorNwords(int n, int finesse_num)
get Detector buffer length
Definition RawCOPPER.h:657
int * GetDetectorBuffer(int n, int finesse_num)
get Detector buffer
Definition RawCOPPER.h:681

◆ 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}
std::string m_description
The description of the module.
Definition Module.h:510

◆ setLogConfig()

void setLogConfig ( const LogConfig & logConfig)
inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

229{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int logLevel,
unsigned int logInfo )
inherited

Configure the printed log information for the given level.

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

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList & params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

Parameters
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}
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:200
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition LogSystem.cc:28
LogConfig & getLogConfig()
Returns the log system configuration.
Definition Module.h:224
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition Module.h:507
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

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

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

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 707 of file trgtopUnpackerModule.cc.

708{
709}

◆ unpackT0Decisions()

void unpackT0Decisions ( int * rdat,
int channel )
virtual

Unpacker main function.

L1 timestamp (11 bits)

20 LSBs of eventNumberL1 (sequential trigger number)

Definition at line 157 of file trgtopUnpackerModule.cc.

158{
159
160 // B2INFO("channel, data size (32bit words) = " << channel << ", " << m_nWords);
161
162 // Information for each data window
163
164 // rvc from the header of the buffer
165 int rvcL1 = rdat[2] & 0x7ff;
166
167 // L1 event number
168 int eventNumberL1 = (rdat[2] >> 12) & 0xfffff;
169
170 // B2INFO("l1_rvc from header = " << rvcL1);
171 // B2INFO("eventNumberL1 (evt) from buffer header = " << eventNumberL1);
172
173 bool dataFormatKnown = false;
174
175 int windowSize = -1;
176 int numberOfWindows = -1;
177
178 int dataFormatVersionExpected = -1;
179 // cppcheck-suppress variableScope
180 int revoClockDeltaExpected = 4;
181 // cppcheck-suppress variableScope
182 int cntr127DeltaExpected = 4;
183
184 // 3 = 3: header only
185 // 1875 = 3 + 48*39: format used starting ~June 30 2019 and until Oct. 1, 2019 (until Receive FW version 0x02067301)
186 // 771 = 3 + 24*32: format used starting ~Oct. 1, 2019 (Receive FW version 0x02067301 and newer)
187 // 1539 = 3 + 48*32: format used starting ~Mar. 25, 2021 (Receive FW version 0x03020003 and newer)
188 // 3075 = 3 + 96*32: format used starting ~Mar. 25, 2021 (Receive FW version 0x03020003 and newer)
189
190 // m_nWords==3 means only a header
191 if (m_nWords == 3) {
192 windowSize = 0;
193 numberOfWindows = 0;
194 dataFormatKnown = true;
195 dataFormatVersionExpected = 0;
196 } else if (m_nWords == 771) {
197 windowSize = 32;
198 numberOfWindows = 24;
199 dataFormatKnown = true;
200 dataFormatVersionExpected = 2;
201 } else if (m_nWords == 1875) {
202 windowSize = 39;
203 numberOfWindows = 48;
204 dataFormatKnown = true;
205 dataFormatVersionExpected = 1;
206 } else if (m_nWords == 1539) {
207 windowSize = 32;
208 numberOfWindows = 48;
209 dataFormatKnown = true;
210 dataFormatVersionExpected = 4;
211 } else if (m_nWords == 3075) {
212 windowSize = 32;
213 numberOfWindows = 96;
214 dataFormatKnown = true;
215 dataFormatVersionExpected = 5;
216 }
217
218 if (!dataFormatKnown) {
219 if (!m_reportedAlreadyRun_1) {
220 B2INFO("Unknown data format / error / exiting. This condition is reported only once per run.");
221 m_reportedAlreadyRun_1 = true;
222 }
223 return;
224 }
225
226 // FTSW / rvc / the difference is 1280 (expected)
227 // int revoClockDeltaJump1 = -92;
228 // int revoClockDeltaJump2 = 1188;
229
230 // VME / 16bit counter
231 // int cntr127DeltaJump1 = -92;
232 // int cntr127DeltaJump2 = -65532;
233
234 // if ( dataFormatVersionExpected > 0 ) B2INFO("---------------------------------------------------------------------------------------------------------------");
235
236 // B2INFO("Data format version (as expected according to data size) = " << dataFormatVersionExpected);
237
238 // if ( numberOfWindows != 0 ) {
239 // B2INFO("Number of 32bit words in TOP L1 data buffer = " << m_nWords);
240 // B2INFO("Number of windows = " << numberOfWindows);
241 // B2INFO("Window size in 32bit words = " << windowSize);
242 // }
243
244 // various test patterns will be used to check the data
245 unsigned int testPattern;
246
247 int revoClockLast = -1;
248 int cntr127Last = -1;
249
250 bool performBufferAnalysis = true;
251 bool reportAllErrors = true;
252 // bool reportSummaryErrors = true;
253
254 // check if this event's buffer is a dummy buffer
255 int counterDummyWindows = 0;
256 unsigned int testPatternDummyEvent = 0xbbbb;
257 for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
258 int index = iWindow * windowSize + 3;
259 testPattern = (rdat[index] >> 16) & 0xffff;
260 if (testPattern == testPatternDummyEvent) {
261 counterDummyWindows++;
262 }
263 // March 30, 2022: need to be able to override the settings in data
264 if (!m_overrideControlBits) {
265 // Oct. 31, 2020: three most significant bits are now used to control unpacker from FW
266 // Note that setting either flag for any of the windows changes it for all windows here
267 testPattern = (rdat[index + 2] >> 29) & 0x7;
268 if (testPattern & 0x1) performBufferAnalysis = false;
269 if (testPattern & 0x2) reportAllErrors = false;
270 // if (testPattern & 0x4) reportSummaryErrors = false;
271 }
272 }
273
274 // note that events with empty buffer have numberOfWindows=0
275 if (counterDummyWindows == numberOfWindows) {
276 performBufferAnalysis = false;
277 } else {
278 if (counterDummyWindows != 0) {
279 if (reportAllErrors) B2ERROR("Corrupted data? numberOfWindows = " << numberOfWindows << ", counterDummyWindows = " <<
280 counterDummyWindows);
281 performBufferAnalysis = false;
282 }
283 }
284
285 /*
286 int numberRvcJumps = 0;
287 int numberCntr127Jumps = 0;
288 int windowRvcJumpFirst = -1;
289 int windowCntr127JumpFirst = -1;
290 int clocksRvcJumpFirst = -1;
291 int clocksCntr127JumpFirst = -1;
292
293 if (performBufferAnalysis) {
294 for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
295 int index = iWindow * windowSize + 3;
296
297 // revoclk (comes from b2tt) has the range between 0 and 1279 @127MHz => 1279*7.8ns ~10us = 1 revolution (11bits are used)
298 int revoClockNow = rdat[index] & 0x7ff;
299 // B2INFO("rvc now = " << revoClockNow);
300 // first need to know max revoClock (1279)
301 if (revoClockLast != -1) {
302 // if (revoClockLast != -1 && revoClockNow > revoClockLast) {
303 int revoClockDeltaNow = revoClockNow - revoClockLast;
304 if (revoClockDeltaNow != revoClockDeltaExpected) {
305 // -1276 is simply going to the next cycle of rvc counting, but 1188 or -92 means that there was one frame missing in data / corrupted data
306 if (revoClockDeltaNow != -1276) {
307 if (reportAllErrors) B2INFO("rvc changed by an unexpected number of units (1): " << revoClockDeltaNow << ", last rvc = " <<
308 revoClockLast <<
309 ", current rvc = " << revoClockNow << ", window " << iWindow << ", index = " << index);
310 numberRvcJumps++;
311 if (windowRvcJumpFirst < 0) {
312 windowRvcJumpFirst = iWindow;
313 clocksRvcJumpFirst = revoClockDeltaNow;
314 }
315 }
316 }
317 }
318 revoClockLast = revoClockNow;
319
320 int cntr127Now = (rdat[index + 1] >> 16) & 0xffff;
321 // B2INFO("cntr127 now = " << cntr127Now);
322 // first need to know max cntr127
323 if (cntr127Last != -1) {
324 // if (cntr127Last != -1 && cntr127Now > cntr127Last) {
325 int cntr127DeltaNow = cntr127Now - cntr127Last;
326 if (cntr127DeltaNow != cntr127DeltaExpected) {
327 // 65444 is the value of the difference in cntr127 (VME counter) because we use 16 bits of 64 bit-long counter
328 if (cntr127DeltaNow != 65444) {
329 if (reportAllErrors) B2INFO("cntr127 changed by an unexpected number of units (1): " << cntr127DeltaNow << ", cntr127 last = " <<
330 cntr127Last <<
331 ", cntr127 now = " << cntr127Now << ", window " << iWindow << ", index = " << index + 1);
332 numberCntr127Jumps++;
333 if (windowCntr127JumpFirst < 0) {
334 windowCntr127JumpFirst = iWindow;
335 clocksCntr127JumpFirst = cntr127DeltaNow;
336 }
337 }
338 }
339 }
340 cntr127Last = cntr127Now;
341 }
342 }
343 */
344
345 /*
346 if (numberRvcJumps > 0) {
347 B2INFO("The number of rvc jumps = " << numberRvcJumps);
348 B2INFO("The window of the first rvc jump = " << windowRvcJumpFirst);
349 B2INFO("The number of clock cycles associated with the first rvc jump = " << clocksRvcJumpFirst);
350 }
351
352 if (numberCntr127Jumps > 0) {
353 B2INFO("The number of cntr127 jumps = " << numberCntr127Jumps);
354 B2INFO("The window of the first cntr127 jump = " << windowCntr127JumpFirst);
355 B2INFO("The number of clock cycles associated with the first cntr127 jump = " << clocksCntr127JumpFirst);
356 }
357 */
358
359 // debugging: report everything from every single window when we are seeing unexpected jumps in either of the two counters
360 /*
361 if (numberRvcJumps > 0 || numberCntr127Jumps > 0) {
362 B2INFO("===========================================================================================================");
363 B2INFO("l1_rvc from header = " << rvcL1);
364 B2INFO("eventNumberL1 (evt) from buffer header = " << eventNumberL1);
365 B2INFO("Reporting the entire data buffer");
366 B2INFO("Header 0 = : " << std::hex << rdat[0] << std::dec);
367 B2INFO("Header 1 = : " << std::hex << rdat[1] << std::dec);
368 B2INFO("Header 2 = : " << std::hex << rdat[2] << std::dec);
369 for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
370 int index = iWindow * windowSize + 3;
371
372 B2INFO("---------------------------------------------------------------------------------");
373 int revoClockNow = rdat[index] & 0x7ff;
374 B2INFO("w rvc ---------------------------- = " << iWindow << " " << revoClockNow);
375
376 int cntr127Now = (rdat[index + 1] >> 16) & 0xffff;
377 B2INFO("w cntr127 ---------------------------- = " << iWindow << " " << cntr127Now);
378
379 for (int i = 0; i < 24; i++) {
380 B2INFO("w i = : " << iWindow << " " << i << " " << std::hex << rdat[index+i] << std::dec);
381 }
382 }
383 }
384 */
385
386 // reset "most recent" rvc and cntr127
387 revoClockLast = -1;
388 cntr127Last = -1;
389
390 // events with no buffer (i.e. no payload), empty (i.e. dummy) windows and presumably corrupted events are NOT analyzed
391 if (performBufferAnalysis) {
392
393 int slotT0Last[8];
394 int slotNHitLast[8];
395 int slotSegmentLast[8];
396
397 int otherInformationLast[8];
398
399 int combinedT0Last;
400 int combinedT0RVC2GDLLast;
401
402 // Loop over windows in B2L buffer and locate all unique slot-level TOP L1 decisions
403 for (int iWindow = 0; iWindow < numberOfWindows; iWindow++) {
404
405 // B2INFO("REAL DEBUG: window number = " << iWindow);
406
407 int clockCycle = iWindow * 4;
408
409 // error counters for possible data corruption in the current window
410 unsigned int errorCountWindow = 0;
411
412 // a pointer-like variable for accessing the data in the buffer sequentially
413 int index = iWindow * windowSize + 3;
414
415 unsigned int testPatternExpected = 0;
416 if (dataFormatVersionExpected == 1) testPatternExpected = 0xbbba;
417 else if (dataFormatVersionExpected >= 2) testPatternExpected = 0xdddd;
418
419 testPattern = (rdat[index] >> 16) & 0xffff;
420 // B2INFO("testPattern = " << std::hex << testPattern << std::dec);
421 if (testPattern != testPatternExpected) {
422 if (reportAllErrors) B2ERROR("An unexpected test pattern: " << std::hex << testPattern << std::dec << ", window " << iWindow <<
423 ", index = " << index);
424 errorCountWindow++;
425 }
426
427 int dataFormatVersionNow = (rdat[index] >> 11) & 0x1f;
428 // B2INFO("dataFormatVersionNow = " << dataFormatVersionNow);
429 if (dataFormatVersionNow == 3 && dataFormatVersionExpected == 2) {
430 dataFormatVersionExpected = 3;
431 }
432 if (dataFormatVersionNow == 4 && dataFormatVersionExpected == 2) {
433 dataFormatVersionExpected = 4;
434 }
435 if (dataFormatVersionNow == 5) {
436 dataFormatVersionExpected = 5;
437 }
438
439 if (dataFormatVersionNow != dataFormatVersionExpected) {
440 if (reportAllErrors) {
441 if (!m_reportedAlreadyRun_2) {
442 B2ERROR("An unexpected data format version: " << dataFormatVersionNow << ", window " << iWindow << ", index = " <<
443 index);
444 m_reportedAlreadyRun_2 = true;
445 }
446 }
447 errorCountWindow++;
448 }
449
450 // revoclk (comes from b2tt) has the range between 0 and 1279 @127MHz => 1279*7.8ns ~10us = 1 revolution (11bits are used)
451 int revoClockNow = rdat[index] & 0x7ff;
452 // B2INFO("window = " << iWindow << ", rvc now = " << revoClockNow);
453 // first need to know max revoClock (1279)
454 if (revoClockLast != -1) {
455 // if (revoClockLast != -1 && revoClockNow > revoClockLast) {
456 int revoClockDeltaNow = revoClockNow - revoClockLast;
457 if (revoClockDeltaNow != revoClockDeltaExpected) {
458 if (revoClockDeltaNow != -1276) {
459 if (reportAllErrors) B2INFO("rvc changed by an unexpected number of units (2): " << revoClockDeltaNow << ", last rvc = " <<
460 revoClockLast <<
461 ", current rvc = " << revoClockNow << ", window " << iWindow << ", index = " << index);
462 // errorCountWindow++;
463 }
464 }
465 }
466 if (revoClockNow > 1279) {
467 if (reportAllErrors) B2ERROR("An unexpected rvc value = " << revoClockNow << ", window " << iWindow << ", index = " << index);
468 errorCountWindow++;
469 }
470 revoClockLast = revoClockNow;
471
472 int cntr127Now = (rdat[index + 1] >> 16) & 0xffff;
473 // B2INFO("cntr127 now = " << cntr127Now);
474 // first need to know max cntr127
475 if (cntr127Last != -1) {
476 // if (cntr127Last != -1 && cntr127Now > cntr127Last) {
477 int cntr127DeltaNow = cntr127Now - cntr127Last;
478 if (cntr127DeltaNow != cntr127DeltaExpected) {
479 // 65444 is the value of the difference in cntr127 (VME counter) because we use 16 bits of 64 bit-long counter
480 if (cntr127DeltaNow != 65444 && cntr127DeltaNow != -65532) {
481 if (reportAllErrors) B2INFO("cntr127 changed by an unexpected number of units (2): " << cntr127DeltaNow << ", cntr127 last = " <<
482 cntr127Last <<
483 ", cntr127 now = " << cntr127Now << ", window " << iWindow << ", index = " << index + 1);
484 errorCountWindow++;
485 }
486 }
487 }
488 cntr127Last = cntr127Now;
489
490 //
491
492 int slotT0[8];
493 int slotNHit[8];
494 int slotSegment[8];
495
496 int otherInformation[8];
497
498 // int versionFW = rdat[index + 3];
499
500 int combinedT0 = rdat[index + 2] & 0x3ffff;
501 int combinedT0RVC2GDL = (rdat[index + 2] >> 18) & 0x7ff;
502 int combinedT0ClockCycle = clockCycle;
503
504 slotT0[0] = (rdat[index + 4] >> 16) & 0xffff;
505 slotT0[1] = (rdat[index + 4]) & 0xffff;
506 slotT0[2] = (rdat[index + 5] >> 16) & 0xffff;
507 slotT0[3] = (rdat[index + 5]) & 0xffff;
508 slotT0[4] = (rdat[index + 6] >> 16) & 0xffff;
509 slotT0[5] = (rdat[index + 6]) & 0xffff;
510 slotT0[6] = (rdat[index + 7] >> 16) & 0xffff;
511 slotT0[7] = (rdat[index + 7]) & 0xffff;
512
513 slotNHit[0] = (rdat[index + 8] >> 20) & 0x3ff;
514 slotNHit[1] = (rdat[index + 8] >> 10) & 0x3ff;
515 slotNHit[2] = (rdat[index + 8]) & 0x3ff;
516
517 slotNHit[3] = (rdat[index + 9] >> 20) & 0x3ff;
518 slotNHit[4] = (rdat[index + 9] >> 10) & 0x3ff;
519 slotNHit[5] = (rdat[index + 9]) & 0x3ff;
520
521 slotNHit[6] = (rdat[index + 10] >> 10) & 0x3ff;
522 slotNHit[7] = (rdat[index + 10]) & 0x3ff;
523
524 slotSegment[0] = (rdat[index + 11] >> 28) & 0xf;
525 slotSegment[1] = (rdat[index + 11] >> 24) & 0xf;
526 slotSegment[2] = (rdat[index + 11] >> 20) & 0xf;
527 slotSegment[3] = (rdat[index + 11] >> 16) & 0xf;
528 slotSegment[4] = (rdat[index + 11] >> 12) & 0xf;
529 slotSegment[5] = (rdat[index + 11] >> 8) & 0xf;
530 slotSegment[6] = (rdat[index + 11] >> 4) & 0xf;
531 slotSegment[7] = (rdat[index + 11] >> 0) & 0xf;
532
533 // the following information is board-dependent
534 otherInformation[0] = (rdat[index + 12] >> 16) & 0xffff;
535 otherInformation[1] = (rdat[index + 12]) & 0xffff;
536 otherInformation[2] = (rdat[index + 13] >> 16) & 0xffff;
537 otherInformation[3] = (rdat[index + 13]) & 0xffff;
538 otherInformation[4] = (rdat[index + 14] >> 16) & 0xffff;
539 otherInformation[5] = (rdat[index + 14]) & 0xffff;
540 otherInformation[6] = (rdat[index + 15] >> 16) & 0xffff;
541 otherInformation[7] = (rdat[index + 15]) & 0xffff;
542
543 if (iWindow != 0) {
544
545 // try to retrieve combined t0 decisions (limited info)
546 if (channel == 0) {
547 if (combinedT0 != combinedT0Last ||
548 combinedT0RVC2GDL != combinedT0RVC2GDLLast
549 ) {
550
551 // int toptrgT0_revoToNS = combinedT0%s_revoToNS;
552 // int rvcL1_NS = rvcL1 * 8;
553 // int deltaT0 = rvcL1_NS >= toptrgT0_revoToNS ? rvcL1_NS - toptrgT0_revoToNS : rvcL1_NS - toptrgT0_revoToNS + s_revoToNS;
554 // int latencyL12TOPTRG = revoClockNow >= rvcL1 ? revoClockNow - rvcL1 : revoClockNow - rvcL1 + 1280;
555
556 TRGTOPCombinedT0Decision combinedT0Decision(combinedT0,
557 revoClockNow,
558 combinedT0ClockCycle,
559 combinedT0RVC2GDL,
560 eventNumberL1,
561 rvcL1
562 );
563
564 m_TRGTOPCombinedT0DecisionArray.appendNew(combinedT0Decision);
565
566 /*
567 cout << "-DEBUG- new combined decision: t0 (2ns), eventNumberL1, rvc2GDL, clock cycle, rvcNOW, rvcL1, latency, deltaT0 (ns) = "
568 << combinedT0/2 << ", "
569 << eventNumberL1 << ", "
570 << combinedT0RVC2GDL << ", "
571 << combinedT0ClockCycle << ", "
572 << revoClockNow << ", "
573 << rvcL1 << ", "
574 << latencyL12TOPTRG << ", "
575 << deltaT0
576 << endl;
577 */
578
579 combinedT0Last = combinedT0;
580 combinedT0RVC2GDLLast = combinedT0RVC2GDL;
581 }
582
583 // retrieve slot-level decisions (limited info) for slots 1 through 8 as observed on the board used for slots 9 through 16
584 for (int i = 0; i < 8; i++) {
585
586 if (otherInformation[i] != otherInformationLast[i]) {
587
588 int slotOther = i + 1;
589
590 TRGTOPSlotTiming slotTiming(slotOther,
591 2 * otherInformation[i],
592 0,
593 0,
594 0,
595 clockCycle,
596 errorCountWindow,
597 0,
598 -1
599 );
600
601 // auto* thisSlotTiming = m_TRGTOPSlotTimingArray.appendNew(slotTiming);
602 m_TRGTOPSlotTimingArray.appendNew(slotTiming);
603
604 otherInformationLast[i] = otherInformation[i];
605
606 }
607 }
608 }
609
610 // retrieve slot-level decisions (complete info) for the currently-processed readout board
611
612 int slotNow = 1;
613 if (channel == 0) slotNow = 9;
614
615 for (int i = 0; i < 8; i++) {
616
617 if (slotT0[i] != slotT0Last[i] ||
618 slotNHit[i] != slotNHitLast[i] ||
619 slotSegment[i] != slotSegmentLast[i]) {
620
621 /*
622 cout << "-DEBUG- slot, index, clockCycle = " << slotNow << ", " << index << ", " << clockCycle
623 << ", combT0 = " << combT0
624 <<", rvcL1 from header = " << rvcL1
625 << ", eventNumberL1 (evt) = " << eventNumberL1
626 << ", FW version = " << std::hex << versionFW << std::dec
627 << ", slot T0 = " << slotT0[i]
628 << ", NHit = " << slotNHit[i]
629 << ", Segment = " << slotSegment[i]
630 << ", other information = " << otherInformation[i]
631 << endl;
632 */
633
634 // TRGTOPSlotTiming* thisSlotTiming(NULL);
635
636 // logL is currently not available (use nHit in lieu of that), so set to 0
637 // firstTS info is only available for slots 1 through 8 (channel == 1)
638 // -1 for firstTS means no info
639 // 1 as the next to the last parameter means "information from the board being read-out"
640
641 if (channel == 1) {
642
643 TRGTOPSlotTiming slotTiming(slotNow,
644 2 * slotT0[i],
645 slotSegment[i],
646 slotNHit[i],
647 0,
648 clockCycle,
649 errorCountWindow,
650 1,
651 otherInformation[i]
652 );
653 // thisSlotTiming = m_TRGTOPSlotTimingArray.appendNew(slotTiming);
654 m_TRGTOPSlotTimingArray.appendNew(slotTiming);
655 } else {
656
657 TRGTOPSlotTiming slotTiming(slotNow,
658 2 * slotT0[i],
659 slotSegment[i],
660 slotNHit[i],
661 0,
662 clockCycle,
663 errorCountWindow,
664 1,
665 -1
666 );
667 // thisSlotTiming = m_TRGTOPSlotTimingArray.appendNew(slotTiming);
668 m_TRGTOPSlotTimingArray.appendNew(slotTiming);
669 }
670
671 // slot-level decisions are not currently related to combined decisions
672 // thisSlotTiming->addRelationTo(thisCombinedTiming);
673 // thisCombinedTiming->addRelationTo(thisSlotTiming);
674
675 slotT0Last[i] = slotT0[i];
676 slotNHitLast[i] = slotNHit[i];
677 slotSegmentLast[i] = slotSegment[i];
678
679 }
680
681 slotNow++;
682
683 }
684 } else {
685
686 combinedT0Last = combinedT0;
687 for (int i = 0; i < 8; i++) {
688 slotT0Last[i] = slotT0[i];
689 slotNHitLast[i] = slotNHit[i];
690 slotSegmentLast[i] = slotSegment[i];
691 otherInformationLast[i] = otherInformation[i];
692
693 combinedT0Last = combinedT0;
694 combinedT0RVC2GDLLast = combinedT0RVC2GDL;
695 }
696 }
697 }
698 }
699
700}

◆ version()

std::string version ( ) const

returns version of TRGGDLUnpackerModule.

Definition at line 31 of file trgtopUnpackerModule.cc.

32{
33 return std::string("1.00");
34}

Member Data Documentation

◆ clkTo1ns

double clkTo1ns = 0.5 / 0.508877
staticconstexpr

Definition at line 39 of file trgtopUnpackerModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_eventNumber

int m_eventNumber
protected

Event number (according to L1/global)

Definition at line 75 of file trgtopUnpackerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 507 of file Module.h.

◆ m_nodeId

int m_nodeId
protected

Our read-out ID.

Definition at line 77 of file trgtopUnpackerModule.h.

◆ m_nWords

int m_nWords
protected

N words in raw data.

Definition at line 78 of file trgtopUnpackerModule.h.

◆ m_overrideControlBits

bool m_overrideControlBits
protected

Definition at line 84 of file trgtopUnpackerModule.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 509 of file Module.h.

◆ m_pciedata

bool m_pciedata
protected

PCIe40 data or copper data.

Definition at line 79 of file trgtopUnpackerModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

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

Definition at line 511 of file Module.h.

◆ m_reportedAlreadyRun_1

bool m_reportedAlreadyRun_1
protected

Definition at line 81 of file trgtopUnpackerModule.h.

◆ m_reportedAlreadyRun_2

bool m_reportedAlreadyRun_2
protected

Definition at line 82 of file trgtopUnpackerModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_TRGTOPCombinedT0DecisionArray

StoreArray<TRGTOPCombinedT0Decision> m_TRGTOPCombinedT0DecisionArray
private

Definition at line 91 of file trgtopUnpackerModule.h.

◆ m_TRGTOPSlotTimingArray

StoreArray<TRGTOPSlotTiming> m_TRGTOPSlotTimingArray
private

Definition at line 92 of file trgtopUnpackerModule.h.

◆ m_trigType

int m_trigType
protected

Trigger type.

Definition at line 76 of file trgtopUnpackerModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ s_revoToNS

int s_revoToNS = 1280 * 8
staticconstexprprivate

time period of revo strobe in "ns" (assuming the clock of "125MHz")

Definition at line 89 of file trgtopUnpackerModule.h.


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