Belle II Software prerelease-10-00-00a
SVDUnpackerModule Class Reference

SVDUnpackerModule: The SVD Raw Hits Decoder. More...

#include <SVDUnpackerModule.h>

Inheritance diagram for SVDUnpackerModule:
Collaboration diagram for SVDUnpackerModule:

Classes

struct  APVHeader
 implementation of APV Header More...
 
struct  data_A
 implementation of the first data word More...
 
struct  data_B
 implementation of the second data word More...
 
struct  FADCTrailer
 implementation of FADC Trailer More...
 
struct  FTBHeader
 implementation of FTB Header More...
 
struct  FTBTrailer
 implementation of FTB Trailer More...
 
struct  MainHeader
 implementation of FADC Header More...
 

Public Types

enum  EModulePropFlags {
  c_Input = 1 ,
  c_Output = 2 ,
  c_ParallelProcessingCertified = 4 ,
  c_HistogramManager = 8 ,
  c_InternalSerializer = 16 ,
  c_TerminateInAllProcesses = 32 ,
  c_DontCollectStatistics = 64
}
 Each module can be tagged with property flags, which indicate certain features of the module. More...
 
typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
 Forward the EAfterConditionPath definition from the ModuleCondition.
 

Public Member Functions

 SVDUnpackerModule ()
 Constructor of the module.
 
virtual ~SVDUnpackerModule ()
 Destructor of the module.
 
virtual void initialize () override
 Initializes the Module.
 
virtual void beginRun () override
 begin run
 
virtual void event () override
 event
 
virtual void endRun () override
 end run
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
virtual void terminate ()
 This method is called at the end of the event processing.
 
const std::string & getName () const
 Returns the name of the module.
 
const std::string & getType () const
 Returns the type of the module (i.e.
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module.
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties.
 
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.
 

Public Attributes

std::string m_rawSVDListName
 RawSVD StoreArray name.
 
std::string m_svdShaperDigitListName
 SVDShaperDigit StoreArray name.
 
std::string m_svdDAQDiagnosticsListName
 SVDDAQDiagnostic StoreArray name.
 
std::string m_svdEventInfoName
 SVDEventInfo name.
 
int m_wrongFTBcrc
 FTB CRC no-Match counter.
 

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 printB2Debug (uint32_t *data32, uint32_t *data32_min, uint32_t *data32_max, int nWords)
 additional function that prints raw data words
 
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

unsigned short nFADCboards
 how many FADCs we have
 
std::unordered_multimap< unsigned char, unsigned char > * APVmap
 pointer to APVforFADCmap filled by mapping procedure
 
std::unique_ptr< SVDOnlineToOfflineMapm_map
 Pointer to online-to-offline map.
 
DBObjPtr< PayloadFilem_mapping
 pointer to the payload with the mapping
 
SVDModeByte m_SVDModeByte
 instance of SVDModeByte for the event
 
DBObjPtr< HardwareClockSettingsm_hwClock
 system clock
 
union { 
 
   uint32_t   m_data32 
 Input 32-bit data word. More...
 
   FTBHeader   m_FTBHeader 
 Implementation of FTB Header. More...
 
   MainHeader   m_MainHeader 
 Implementation of FADC Header. More...
 
   APVHeader   m_APVHeader 
 Implementation of APV Header. More...
 
   data_A   m_data_A 
 Implementation of 1st data word. More...
 
   data_B   m_data_B 
 Implementation of 2nd data word. More...
 
   FADCTrailer   m_FADCTrailer 
 Implementation of FADC Trailer. More...
 
   FTBTrailer   m_FTBTrailer 
 Implementation of FTB Trailer. More...
 
};  
 
StoreObjPtr< EventMetaDatam_eventMetaDataPtr
 Required input for EventMetaData.
 
StoreObjPtr< SVDEventInfom_svdEventInfoPtr
 SVDEventInfo output per event.
 
SVDTriggerType m_SVDTriggerType
 SVDTriggerType object.
 
StoreArray< RawSVDm_rawSVD
 output for RawSVD
 
StoreArray< SVDDAQDiagnosticm_storeDAQDiagnostics
 SVDDAQDiagnostic array.
 
StoreArray< SVDShaperDigitm_storeShaperDigits
 SVDShaperDigit array.
 
int m_shutUpFTBError
 regulates the number of "Event number mismatch" errors reported
 
int m_FADCTriggerNumberOffset
 FADC Trigger Offset.
 
bool m_emulatePipelineAddress = false
 Software emulation of pipeline address This is a replacement of hardware pipeline address emulation.
 
bool m_killUpsetDigits = false
 Optionally, we can kill digits coming from upset APVs right in the unpacker.
 
bool m_silentAppend = false
 Silently append new SVDShaperDigits to a pre-existing non-empty SVDShaperDigits storeArray.
 
bool m_badMappingFatal = false
 Optionally we can stop the unpacking if there is a missing APV/FADC combination in the mapping -> wrong payload is identified.
 
bool m_printRaw
 Optionally we can get printout of Raw Data words.
 
int m_errorRate {1000}
 The parameter that indicates what fraction of B2ERRORs messages should be suppressed to not overload HLT while data taking.
 
unsigned short seenHeadersAndTrailers: 4
 this 4-bits value should be 1111 if no headers/trailers are missing
 
int nTriggerMatchErrors
 counters for specific ERRORS produced by the Unpacker
 
int nEventMatchErrors
 counter of Event match errors
 
int nUpsetAPVsErrors
 counter of upset APV errors
 
int nSEURecoveryCase
 counter of SEU Special Recovery data cases
 
int nErrorFieldErrors
 counter of event mismatch errors in FTB's ErrorField
 
int nMissingAPVsErrors
 counter of missing APVs errors
 
int nFADCMatchErrors
 counter of FADC boards =/= n of RawData objects errors
 
int nAPVErrors
 counter of APV errors
 
int nFTBFlagsErrors
 counter of errors in FTBFlags variable
 
int nEventInfoMatchErrors
 counter of inconsistencies in SVDEventInfo within an event
 
std::map< std::pair< unsigned short, unsigned short >, std::pair< std::size_t, std::size_t > > m_missingAPVs
 Map to store a list of missing APVs.
 
std::map< std::pair< unsigned short, unsigned short >, std::pair< std::size_t, std::size_t > > m_upsetAPVs
 Map to store a list of upset APVs.
 
std::map< std::pair< unsigned short, unsigned short >, std::pair< std::size_t, std::size_t > > m_seuRecMap
 Map to store a list of APVs for special data for SEU recovery.
 
int m_relativeTimeShift
 latency difference between the 3- and 6-sample acquired events in usint of APV clock / 4, read from SVDGlobalConfigParameters and filled into SVDEventInfo
 
DBObjPtr< SVDGlobalConfigParametersm_svdGlobalConfig
 SVDGlobal Configuration payload.
 
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 std::string m_xmlFileName = std::string("SVDChannelMapping.xml")
 XML filename.
 

Detailed Description

SVDUnpackerModule: The SVD Raw Hits Decoder.

This module produces SVDShaperDigits from the Copper

Definition at line 42 of file SVDUnpackerModule.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

◆ SVDUnpackerModule()

Constructor of the module.

Definition at line 45 of file SVDUnpackerModule.cc.

45 : Module(),
49{
50 //Set module properties
51 setDescription("Produce SVDShaperDigits from RawSVD. NOTE: only zero-suppressed mode is currently supported!");
53
54 addParam("SVDEventInfo", m_svdEventInfoName, "Name of the SVDEventInfo object", string(""));
55 addParam("rawSVDListName", m_rawSVDListName, "Name of the raw SVD List", string(""));
56 addParam("svdShaperDigitListName", m_svdShaperDigitListName, "Name of the SVDShaperDigits list", string(""));
57 addParam("shutUpFTBError", m_shutUpFTBError,
58 "if >0 is the number of reported FTB header ERRORs before quiet operations. If <0 full log produced.", -1);
59 addParam("FADCTriggerNumberOffset", m_FADCTriggerNumberOffset,
60 "number to be added to the FADC trigger number to match the main trigger number", 0);
61 addParam("svdDAQDiagnosticsListName", m_svdDAQDiagnosticsListName, "Name of the DAQDiagnostics list", string(""));
62 addParam("softwarePipelineAddressEmulation", m_emulatePipelineAddress, "Estimate emulated pipeline address", bool(true));
63 addParam("killDigitsFromUpsetAPVs", m_killUpsetDigits, "Delete digits from upset APVs", bool(false));
64 addParam("silentlyAppend", m_silentAppend, "Append digits to a pre-existing non-empty storeArray", bool(false));
65 addParam("badMappingFatal", m_badMappingFatal, "Throw B2FATAL if there's a wrong payload in the database", bool(false));
66 addParam("UnpackerErrorRate", m_errorRate, "Unpacker will print one error every UnpackerErrorRate", int(1000));
67 addParam("PrintRawData", m_printRaw, "Printing Raw data words for debugging", bool(false));
68}
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_shutUpFTBError
regulates the number of "Event number mismatch" errors reported
std::string m_rawSVDListName
RawSVD StoreArray name.
DBObjPtr< PayloadFile > m_mapping
pointer to the payload with the mapping
bool m_killUpsetDigits
Optionally, we can kill digits coming from upset APVs right in the unpacker.
int m_FADCTriggerNumberOffset
FADC Trigger Offset.
static std::string m_xmlFileName
XML filename.
int m_errorRate
The parameter that indicates what fraction of B2ERRORs messages should be suppressed to not overload ...
std::string m_svdShaperDigitListName
SVDShaperDigit StoreArray name.
std::string m_svdEventInfoName
SVDEventInfo name.
bool m_printRaw
Optionally we can get printout of Raw Data words.
bool m_badMappingFatal
Optionally we can stop the unpacking if there is a missing APV/FADC combination in the mapping -> wro...
bool m_silentAppend
Silently append new SVDShaperDigits to a pre-existing non-empty SVDShaperDigits storeArray.
bool m_emulatePipelineAddress
Software emulation of pipeline address This is a replacement of hardware pipeline address emulation.
std::string m_svdDAQDiagnosticsListName
SVDDAQDiagnostic StoreArray name.
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

◆ ~SVDUnpackerModule()

~SVDUnpackerModule ( )
virtual

Destructor of the module.

Definition at line 70 of file SVDUnpackerModule.cc.

71{
72}

Member Function Documentation

◆ beginRun()

void beginRun ( void )
overridevirtual

begin run

Reimplemented from Module.

Definition at line 91 of file SVDUnpackerModule.cc.

92{
93 if (!m_mapping.isValid())
94 B2FATAL("no valid SVD Channel Mapping. We stop here.");
95
96 m_wrongFTBcrc = 0;
97 if (m_mapping.hasChanged()) { m_map = std::make_unique<SVDOnlineToOfflineMap>(m_mapping->getFileName()); }
98
99 if (! m_map) { //give up
100 B2ERROR("SVD xml map not loaded." << std::endl <<
101 "No SVDShaperDigit will be produced for this run!");
102 return;
103 }
104
105 //number of FADC boards
106 nFADCboards = m_map->getFADCboardsNumber();
107
108 //passing APV<->FADC mapping from SVDOnlineToOfflineMap object
109 APVmap = &(m_map->APVforFADCmap);
110
111 //setting UnpackerErrorRate factor to use it for BadMapping error suppression
112 m_map->setErrorRate(m_errorRate);
113
116 nUpsetAPVsErrors = -1;
117 nSEURecoveryCase = -1;
120 nFADCMatchErrors = -1;
121 nAPVErrors = -1;
122 nFTBFlagsErrors = -1;
124
126
127 //get the relative time shift
128 if (!m_svdGlobalConfig.isValid())
129 B2FATAL("SVDGlobalConfigParameters not valid!!");
130
131 m_relativeTimeShift = m_svdGlobalConfig->getRelativeTimeShift();
132
133}
int m_wrongFTBcrc
FTB CRC no-Match counter.
unsigned short seenHeadersAndTrailers
this 4-bits value should be 1111 if no headers/trailers are missing
int nAPVErrors
counter of APV errors
int nFADCMatchErrors
counter of FADC boards =/= n of RawData objects errors
int nMissingAPVsErrors
counter of missing APVs errors
int nEventMatchErrors
counter of Event match errors
int nUpsetAPVsErrors
counter of upset APV errors
DBObjPtr< SVDGlobalConfigParameters > m_svdGlobalConfig
SVDGlobal Configuration payload.
int nEventInfoMatchErrors
counter of inconsistencies in SVDEventInfo within an event
int nErrorFieldErrors
counter of event mismatch errors in FTB's ErrorField
std::unordered_multimap< unsigned char, unsigned char > * APVmap
pointer to APVforFADCmap filled by mapping procedure
std::unique_ptr< SVDOnlineToOfflineMap > m_map
Pointer to online-to-offline map.
int m_relativeTimeShift
latency difference between the 3- and 6-sample acquired events in usint of APV clock / 4,...
int nFTBFlagsErrors
counter of errors in FTBFlags variable
int nSEURecoveryCase
counter of SEU Special Recovery data cases
int nTriggerMatchErrors
counters for specific ERRORS produced by the Unpacker
unsigned short nFADCboards
how many FADCs we have

◆ 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

end run

Reimplemented from Module.

Definition at line 688 of file SVDUnpackerModule.cc.

689{
690
691 // Summary report on missing APVs
692 if (m_missingAPVs.size() > 0) {
693 B2WARNING("SVDUnpacker summary 1: Missing APVs");
694 for (const auto& miss : m_missingAPVs)
695 B2WARNING(LogVar("Missing APV", miss.first.second) << LogVar("FADC", miss.first.first) << LogVar("since event",
696 miss.second.first) << LogVar("to event", miss.second.second));
697 }
698 if (m_upsetAPVs.size() > 0) {
699 B2WARNING("SVDUnpacker summary 2: Upset APVs");
700 for (const auto& upst : m_upsetAPVs)
701 B2WARNING(LogVar("Upset APV", upst.first.second) << LogVar("FADC", upst.first.first) <<
702 LogVar("since event", upst.second.first) << LogVar("to event", upst.second.second));
703 }
704
705 if (m_seuRecMap.size() > 0) {
706 B2WARNING("SVDUnpacker summary 2: Special SEU Recovery Data");
707 for (const auto& seu : m_seuRecMap)
708 B2WARNING(LogVar("SEU recovery data: APV", seu.first.second) << LogVar("FADC", seu.first.first) <<
709 LogVar("since event", seu.second.first) << LogVar("to event", seu.second.second));
710 }
711
712}
std::map< std::pair< unsigned short, unsigned short >, std::pair< std::size_t, std::size_t > > m_missingAPVs
Map to store a list of missing APVs.
std::map< std::pair< unsigned short, unsigned short >, std::pair< std::size_t, std::size_t > > m_seuRecMap
Map to store a list of APVs for special data for SEU recovery.
std::map< std::pair< unsigned short, unsigned short >, std::pair< std::size_t, std::size_t > > m_upsetAPVs
Map to store a list of upset APVs.

◆ 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

event

Reimplemented from Module.

Definition at line 139 of file SVDUnpackerModule.cc.

140{
141 if (!m_rawSVD || !m_rawSVD.getEntries())
142 return;
143
145 B2WARNING("Unpacking SVDShaperDigits to a non-empty pre-existing \n"
146 << "StoreArray. This can lead to undesired behaviour. At least\n"
147 << "remember to use SVDShaperDigitSorter in your path and \n"
148 << "set the silentlyAppend parameter of SVDUnpacker to true.");
149
150 SVDDAQDiagnostic* currentDAQDiagnostic;
151 vector<SVDDAQDiagnostic*> vDiagnostic_ptr;
152
153 map<SVDShaperDigit, SVDDAQDiagnostic*> diagnosticMap;
154 // Store encountered pipeline addresses with APVs in which they were observed
155 map<unsigned short, set<pair<unsigned short, unsigned short> > > apvsByPipeline;
156
157 if (!m_eventMetaDataPtr.isValid()) { // give up...
158 B2ERROR("Missing valid EventMetaData." << std::endl << "No SVDShaperDigit produced for this event!");
159 return;
160 }
161
162 bool nAPVmatch = true;
163 bool badMapping = false;
164 bool badHeader = false;
165 bool badTrailer = false;
166 bool missedHeader = false;
167 bool missedTrailer = false;
168
169 // flag to set SVDEventInfo once per event
170 bool isSetEventInfo = false;
171
172 //flag to set nAPVsamples in SVDEventInfo once per event
173 bool isSetNAPVsamples = false;
174
175 unsigned short nAPVheaders = 999;
176 set<short> seenAPVHeaders = {};
177
178 unsigned short nEntries_rawSVD = m_rawSVD.getEntries();
179 auto eventNo = m_eventMetaDataPtr->getEvent();
180
181 short fadc = 255, apv = 63;
182
183 unsigned short cntFADCboards = 0;
184 for (unsigned int i = 0; i < nEntries_rawSVD; i++) {
185
186 unsigned int numEntries_rawSVD = m_rawSVD[ i ]->GetNumEntries();
187 for (unsigned int j = 0; j < numEntries_rawSVD; j++) {
188
189 const unsigned short maxNumOfCh = m_rawSVD[i]->GetMaxNumOfCh(j);
190
191 std::vector<unsigned short> nWords;
192 nWords.reserve(maxNumOfCh);
193 std::vector<uint32_t*> data32tab(maxNumOfCh); //vector of pointers
194 for (unsigned int k = 0; k < maxNumOfCh; k++) {
195 nWords.push_back(m_rawSVD[i]->GetDetectorNwords(j, k));
196 data32tab[k] = (uint32_t*)m_rawSVD[i]->GetDetectorBuffer(j, k); // points at the beginning of the 1st buffer
197 }
198
199 unsigned short ftbError = 0;
200 unsigned short trgType = 0;
201 unsigned short trgNumber = 0;
202 unsigned short daqMode = -1;
203 unsigned short daqType = 0;
204 unsigned short cmc1;
205 unsigned short cmc2;
206 unsigned short apvErrors;
207 unsigned short pipAddr;
208 unsigned short ftbFlags = 0;
209 unsigned short apvErrorsOR = 0;
210
211 bool is3sampleData = false;
212 bool is6sampleData = false;
213
214 for (unsigned int buf = 0; buf < maxNumOfCh; buf++) { // loop over 4(COPPER) or 48(PCIe40) buffers
215
216 if (data32tab[buf] == nullptr || nWords.at(buf) == 0) {
217 if (data32tab[buf] != nullptr || nWords.at(buf) != 0) {
218 B2WARNING("Invalid combination of buffer pointer and nWords:" <<
219 LogVar("COPPER/PCIe40 ID", i) <<
220 LogVar("COPPER/PCIe40 Entry", j) <<
221 LogVar("COPPER/PCIe40 Channel", buf) <<
222 LogVar("data32tab[buf]", data32tab[buf]) <<
223 LogVar("nWords[buf]", nWords.at(buf)));
224 }
225 continue;
226 }
227 if (m_printRaw) printB2Debug(data32tab[buf], data32tab[buf], &data32tab[buf][nWords.at(buf) - 1], nWords.at(buf));
228
229 cntFADCboards++;
230
231 missedHeader = false;
232 missedTrailer = false;
233
234 uint32_t* data32_it = data32tab[buf];
235 short strip, sample[6];
236 vector<uint32_t> crc16vec;
237
238 //reset value for headers and trailers check
240
241 for (; data32_it != &data32tab[buf][nWords.at(buf)]; data32_it++) {
242 m_data32 = *data32_it; //put current 32-bit frame to union
243
244 if (m_data32 == 0xffaa0000) { // first part of FTB header
245 crc16vec.clear(); // clear the input container for crc16 calculation
246 crc16vec.push_back(m_data32);
247
248 seenHeadersAndTrailers |= 0x1; // we found FTB header
249
250 data32_it++; // go to 2nd part of FTB header
251 crc16vec.push_back(*data32_it);
252
253 m_data32 = *data32_it; //put the second 32-bit frame to union
254
255 ftbError = m_FTBHeader.errorsField;
256
257 if (ftbError != 240) {
259
261 switch (ftbError - 240) {
262 case 3:
263 B2ERROR("FADC Event Number is different from (FTB & TTD) Event Numbers");
264 break;
265 case 5:
266 B2ERROR("TTD Event Number is different from (FTB & FADC) Event Numbers");
267 break;
268 case 6:
269 B2ERROR("FTB Event Number is different from (TTD & FADC) Event Numbers");
270 break;
271 case 7:
272 B2ERROR("(FTB, TTD & FADC) Event Numbers are different from each other");
273 break;
274 default:
275 B2ERROR("Problem with errorsField variable in FTB Header" << LogVar("abnormal value", ftbError));
276 }
277 }
278 }
279
280 if (m_FTBHeader.eventNumber !=
281 (eventNo & 0xFFFFFF)) {
284 m_shutUpFTBError -= 1;
285 B2ERROR("Event number mismatch detected! The event number given by EventMetaData object is different from the one in the FTB Header."
286 << LogVar("Expected event number & 0xFFFFFF",
287 (eventNo & 0xFFFFFF)) << LogVar("Event number in the FTB", m_FTBHeader.eventNumber));
288 }
289 }
290
291 continue;
292 } // is FTB Header
293
294 crc16vec.push_back(m_data32);
295
296 if (m_MainHeader.check == 6) { // FADC header
297
298 seenHeadersAndTrailers |= 0x2; //we found FADC Header
299
300 fadc = m_MainHeader.FADCnum;
301 trgType = m_MainHeader.trgType;
302 trgNumber = m_MainHeader.trgNumber;
303 daqMode = m_MainHeader.DAQMode;
304 daqType = m_MainHeader.DAQType;
305
306 //Let's add run-dependent info: daqMode="11" in case of 3-mixed-6 sample acquisition mode.
307 if (daqType) daqMode = 3;
308
309 nAPVheaders = 0; // start counting APV headers for this FADC
310 nAPVmatch = true; //assume correct # of APV headers
311 badMapping = false; //assume correct mapping
312 badHeader = false;
313 badTrailer = false;
314
315 is3sampleData = false;
316 is6sampleData = false;
317
318 if (daqMode == 0) B2ERROR("SVDDataFormatCheck: the event " << eventNo <<
319 " is apparently taken with 1-sample mode, this is not expected.");
320 if (daqMode == 1) is3sampleData = true;
321 if (daqMode == 2) is6sampleData = true;
322
323 if (
324 m_MainHeader.trgNumber !=
325 ((eventNo - m_FADCTriggerNumberOffset) & 0xFF)) {
326
329 B2ERROR("Event number mismatch detected! The event number given by EventMetaData object is different from the one in the FADC Header. "
330 << LogVar("Event number", eventNo) << LogVar("FADC", fadc) << LogVar("Trigger number LSByte reported by the FADC",
331 m_MainHeader.trgNumber) << LogVar("+ offset", m_FADCTriggerNumberOffset) << LogVar("expected", (eventNo & 0xFF)));
332 badHeader = true;
333 }
334
335 // create SVDModeByte object from MainHeader vars
336 m_SVDModeByte = SVDModeByte(m_MainHeader.runType, 0, daqMode, m_MainHeader.trgTiming);
337
338 // create SVDEventInfo and fill it with SVDModeByte & SVDTriggerType objects
339 if (!isSetEventInfo) {
340 m_SVDTriggerType = SVDTriggerType(trgType);
341 m_svdEventInfoPtr.create();
342 m_svdEventInfoPtr->setModeByte(m_SVDModeByte);
343 m_svdEventInfoPtr->setTriggerType(m_SVDTriggerType);
344 m_svdEventInfoPtr->setAPVClock(m_hwClock);
345
346 //set relative time shift
347 m_svdEventInfoPtr->setRelativeShift(m_relativeTimeShift);
348 // set X-talk info online from Raw Data
349 m_svdEventInfoPtr->setCrossTalk(m_MainHeader.xTalk);
350
351 isSetEventInfo = true;
352 } else { // let's check if the current SVDModeByte and SVDTriggerType are consistent with the one stored in SVDEventInfo
353 if (m_SVDModeByte != m_svdEventInfoPtr->getModeByte()) {m_svdEventInfoPtr->setMatchModeByte(false); badHeader = true; nEventInfoMatchErrors++;}
354 if (trgType != (m_svdEventInfoPtr->getTriggerType()).getType()) { m_svdEventInfoPtr->setMatchTriggerType(false); badHeader = true; nEventInfoMatchErrors++;}
355 }
356 } // is FADC header
357
358 if (m_APVHeader.check == 2) { // APV header
359
360 nAPVheaders++;
361 apv = m_APVHeader.APVnum;
362 seenAPVHeaders.insert(apv);
363
364 cmc1 = m_APVHeader.CMC1;
365 cmc2 = m_APVHeader.CMC2;
366 apvErrors = m_APVHeader.apvErr;
367 pipAddr = m_APVHeader.pipelineAddr;
368
369 if (apvErrors != 0) {
370 nAPVErrors++;
371 if (!(nAPVErrors % m_errorRate)
372 or nAPVErrors < 100) B2ERROR("APV error has been detected." << LogVar("FADC", fadc) << LogVar("APV", apv) << LogVar("Error value",
373 apvErrors));
374 }
375 // temporary SVDDAQDiagnostic object (no info from trailers and APVmatch code)
376 currentDAQDiagnostic = m_storeDAQDiagnostics.appendNew(trgNumber, trgType, pipAddr, cmc1, cmc2, apvErrors, ftbError, true,
377 nAPVmatch,
378 badHeader, missedHeader, missedTrailer,
379 fadc, apv);
380 vDiagnostic_ptr.push_back(currentDAQDiagnostic);
381
382 apvsByPipeline[pipAddr].insert(make_pair(fadc, apv));
383
384 // Let's check if the data frame does not come after APV header with piplAddr = 255 (special SEU recovery pseudo-data)
385 if (pipAddr == 255) {
386 data32_it++;
387 m_data32 = *data32_it;
388 if (m_data_A.check == 0) B2ERROR("The strip data frame is detected for the special SEU recovery mode. " << LogVar("pipline address",
389 pipAddr) << "This is unexpected!");
390 data32_it--;
391 m_data32 = *data32_it;
392 }
393
394 } //is APV Header
395
396 if (m_data_A.check == 0) { // data
397 strip = m_data_A.stripNum;
398
399 sample[0] = m_data_A.sample1;
400 sample[1] = m_data_A.sample2;
401 sample[2] = m_data_A.sample3;
402
403 sample[3] = 0;
404 sample[4] = 0;
405 sample[5] = 0;
406
407 // Let's check the next rawdata word to determine if we acquired 3 or 6 sample
408 data32_it++;
409 m_data32 = *data32_it;
410
411 if (m_data_B.check == 0 && strip == m_data_B.stripNum) { // 2nd data frame with the same strip number -> six samples
412
413 if (!isSetNAPVsamples) {
414 m_svdEventInfoPtr->setNSamples(6);
415 isSetNAPVsamples = true;
416 } else {
417 if (is3sampleData)
418 B2ERROR("DAQMode value (indicating 3-sample acquisition mode) doesn't correspond to the actual number of samples (6) in the data! The data might be corrupted!");
419 }
420
421 crc16vec.push_back(m_data32);
422
423 sample[3] = m_data_B.sample4;
424 sample[4] = m_data_B.sample5;
425 sample[5] = m_data_B.sample6;
426 }
427
428 else { // three samples
429 data32_it--;
430 m_data32 = *data32_it;
431
432 if (!isSetNAPVsamples) {
433 m_svdEventInfoPtr->setNSamples(3);
434 isSetNAPVsamples = true;
435 } else {
436 if (is6sampleData)
437 B2ERROR("DAQMode value (indicating 6-sample acquisition mode) doesn't correspond to the actual number of samples (3) in the data! The data might be corrupted!");
438 }
439 }
440
441 // Generating SVDShaperDigit object
442 SVDShaperDigit* newShaperDigit = m_map->NewShaperDigit(fadc, apv, strip, sample, 0.0);
443 if (newShaperDigit) {
444 diagnosticMap.insert(make_pair(*newShaperDigit, currentDAQDiagnostic));
445 delete newShaperDigit;
446 } else if (m_badMappingFatal) {
447 B2FATAL("Respective FADC/APV combination not found -->> incorrect payload in the database! ");
448 } else {
449 badMapping = true;
450 }
451
452 } //is data frame
453
454
455 if (m_FADCTrailer.check == 14) { // FADC trailer
456
457 seenHeadersAndTrailers |= 0x4; // we found FADC trailer
458
459 //additional check if we have a faulty/fake FADC that is not in the map
460 if (APVmap->find(fadc) == APVmap->end()) badMapping = true;
461
462 //comparing number of APV chips and the number of APV headers, for the current FADC
463 unsigned short nAPVs = APVmap->count(fadc);
464
465 if (nAPVheaders == 0) {
466 currentDAQDiagnostic = m_storeDAQDiagnostics.appendNew(0, 0, 0, 0, 0, 0, ftbError, true, nAPVmatch, badHeader, 0, 0, fadc, 0);
467 vDiagnostic_ptr.push_back(currentDAQDiagnostic);
468 }
469
470 if (nAPVs != nAPVheaders) {
471 // There is an APV missing, detect which it is.
472 for (const auto& fadcApv : *APVmap) {
473 if (fadcApv.first != fadc) continue;
474 if (seenAPVHeaders.find(fadcApv.second) == seenAPVHeaders.end()) {
475 // We have a missing APV. Look if it is a known one.
476 auto missingRec = m_missingAPVs.find(make_pair(fadcApv.first, fadcApv.second));
477 if (missingRec != m_missingAPVs.end()) {
478 // This is known to be missing, so keep quiet and just update event counters
479 if (missingRec->second.first > eventNo)
480 missingRec->second.first = eventNo;
481 if (missingRec->second.second < eventNo)
482 missingRec->second.second = eventNo;
483 } else {
484 // We haven't seen this previously.
486 m_missingAPVs.insert(make_pair(
487 make_pair(fadcApv.first, fadcApv.second),
488 make_pair(eventNo, eventNo)
489 ));
490 if (!(nMissingAPVsErrors % m_errorRate)) B2ERROR("missing APV header! " << LogVar("Event number", eventNo) << LogVar("APV",
491 int(fadcApv.second)) << LogVar("FADC",
492 int(fadcApv.first)));
493 }
494 }
495 }
496 nAPVmatch = false;
497 } // is nAPVs != nAPVheaders
498
499 seenAPVHeaders.clear();
500
501 ftbFlags = m_FADCTrailer.FTBFlags;
502 if ((ftbFlags >> 5) != 0) badTrailer = true;
503 if (ftbFlags != 0) {
505 if (!(nFTBFlagsErrors % m_errorRate) or nFTBFlagsErrors < 100) {
506 B2ERROR(" FTB Flags variable has an active error bit(s)" << LogVar("on FADC number", fadc));
507
508 if (ftbFlags & 16) B2ERROR("----> CRC error has been detected. Data might be corrupted!");
509 if (ftbFlags & 8) B2ERROR("----> Bad Event indication has been detected. Data might be corrupted!");
510 if (ftbFlags & 4) B2ERROR("----> Double Header has been detected. Data might be corrupted!");
511 if (ftbFlags & 2) B2ERROR("----> Time Out has been detected. Data might be corrupted!");
512 if (ftbFlags & 1) B2ERROR("----> Event Too Long! Data might be corrupted!");
513 }
514 }
515
516 apvErrorsOR = m_FADCTrailer.apvErrOR;
517
518
519 }// is FADC trailer
520
521 if (m_FTBTrailer.controlWord == 0xff55) {// FTB trailer
522
523 seenHeadersAndTrailers |= 0x8; // we found FTB trailer
524
525 //check CRC16
526 crc16vec.pop_back();
527 unsigned short iCRC = crc16vec.size();
528 std::vector<uint32_t> crc16input;
529 crc16input.reserve(iCRC);
530
531 for (unsigned short icrc = 0; icrc < iCRC; icrc++)
532 crc16input.push_back(htonl(crc16vec.at(icrc)));
533
534 //verify CRC16
535 boost::crc_basic<16> bcrc(0x8005, 0xffff, 0, false, false);
536 bcrc.process_bytes(crc16input.data(), crc16input.size() * sizeof(uint32_t));
537 unsigned int checkCRC = bcrc.checksum();
538
539 if (checkCRC != m_FTBTrailer.crc16) {
540 B2WARNING("FTB CRC16 checksum DOES NOT MATCH" << LogVar("for FADC no.", fadc));
542 }
543
544 } // is FTB trailer
545
546 } // end loop over 32-bit frames in each buffer
547
548 //Let's check if all the headers and trailers were in place in the last frame
549 if (seenHeadersAndTrailers != 0xf) {
550 if (!(seenHeadersAndTrailers & 1)) {B2ERROR("Missing FTB Header is detected. SVD data might be corrupted!" << LogVar("Event number", eventNo) << LogVar("FADC", fadc)); missedHeader = true;}
551 if (!(seenHeadersAndTrailers & 2)) {B2ERROR("Missing FADC Header is detected -> related FADC number couldn't be retrieved. SVD data might be corrupted! " << LogVar("Event number", eventNo) << LogVar("previous FADC", fadc)); missedHeader = true;}
552 if (!(seenHeadersAndTrailers & 4)) {B2ERROR("Missing FADC Trailer is detected. SVD data might be corrupted!" << LogVar("Event number", eventNo) << LogVar("FADC", fadc)); missedTrailer = true;}
553 if (!(seenHeadersAndTrailers & 8)) {B2ERROR("Missing FTB Trailer is detected. SVD data might be corrupted!" << LogVar("Event number", eventNo) << LogVar("FADC", fadc)); missedTrailer = true;}
554 }
555
556 for (auto p : vDiagnostic_ptr) {
557 // adding remaining info to Diagnostic object
558 p->setFTBFlags(ftbFlags);
559 p->setApvErrorOR(apvErrorsOR);
560 p->setAPVMatch(nAPVmatch);
561 p->setBadMapping(badMapping);
562 p->setBadTrailer(badTrailer);
563 p->setMissedHeader(missedHeader);
564 p->setMissedTrailer(missedTrailer);
565 }
566
567 vDiagnostic_ptr.clear();
568
569 } // end iteration on 4(COPPER)/48(PCIe40) data buffers
570
571 } // end event loop
572
573 }// end loop over RawSVD objects
574
575 // Check the number of FADC boards
576 if (cntFADCboards != nFADCboards) { // nFADCboards=52
578 if (!(nFADCMatchErrors % m_errorRate)) B2ERROR("Number of data objects in rawSVD do not match the number of FADC boards" <<
579 LogVar("# of data objects in rawSVD",
580 cntFADCboards) << LogVar("# of FADCs", nFADCboards) << LogVar("Event number", eventNo));
581
582 // We override all FADCMatch fields in diagnostics and set it to false.
583 for (auto& p : m_storeDAQDiagnostics) {
584 p.setFADCMatch(false);
585 }
586 }
587
588
589 // Check if we have special data for SEU recovery mode (pipAddr = 0xFF)
590 // If so, let's monitor affected FADC/APV's and the event range with seuRecMap
591 auto itPtr = apvsByPipeline.find(255);
592 if (itPtr != apvsByPipeline.end()) {
593 for (const auto& fadcApv : itPtr->second) {
594
595 auto seuRec = m_seuRecMap.find(make_pair(fadcApv.first, fadcApv.second));
596 if (seuRec != m_seuRecMap.end()) {
597 if (seuRec->second.first > eventNo)
598 seuRec->second.first = eventNo;
599 if (seuRec->second.second < eventNo)
600 seuRec->second.second = eventNo;
601 } else {
603 m_seuRecMap.insert(make_pair(
604 make_pair(fadcApv.first, fadcApv.second),
605 make_pair(eventNo, eventNo)
606 ));
608 B2ERROR("Special Recovery Data (Dummy APV Header) found due to the detection of Single Event Upset (SEU)!!!" << LogVar("APV",
609 int(fadcApv.second)) << LogVar("FADC", int(fadcApv.first)) << LogVar("Event number", eventNo));
610
611 }
612 for (auto& pp : m_storeDAQDiagnostics) {
613 if (pp.getFADCNumber() == fadcApv.first and pp.getAPVNumber() == fadcApv.second)
614 pp.setSEURecoData(true);
615 }
616 }
617 }
618
619
620 // Detect upset APVs and report/treat
621 auto majorAPV = max_element(apvsByPipeline.begin(), apvsByPipeline.end(),
622 [](const decltype(apvsByPipeline)::value_type & p1,
623 const decltype(apvsByPipeline)::value_type & p2) -> bool
624 { return p1.second.size() < p2.second.size(); }
625 );
626 // We set emuPipelineAddress fields in diagnostics to this.
628 for (auto& p : m_storeDAQDiagnostics)
629 p.setEmuPipelineAddress(majorAPV->first);
630
631 unsigned short apvsByPipelineSize = apvsByPipeline.size();
632 if (majorAPV->first == 255) apvsByPipelineSize = 1;
633
634 // And report any upset apvs or update records
635 if (apvsByPipelineSize > 1)
636 for (const auto& p : apvsByPipeline) {
637 if (p.first == majorAPV->first or p.first == 255) continue;
638 for (const auto& fadcApv : p.second) {
639 // We have an upset APV. Look if it is a known one.
640 auto upsetRec = m_upsetAPVs.find(make_pair(fadcApv.first, fadcApv.second));
641 if (upsetRec != m_upsetAPVs.end()) {
642 // This is known to be upset, so keep quiet and update event counters
643 if (upsetRec->second.first > eventNo)
644 upsetRec->second.first = eventNo;
645 if (upsetRec->second.second < eventNo)
646 upsetRec->second.second = eventNo;
647 } else {
648 // We haven't seen this one previously.
650 m_upsetAPVs.insert(make_pair(
651 make_pair(fadcApv.first, fadcApv.second),
652 make_pair(eventNo, eventNo)
653 ));
654
655 if (!(nUpsetAPVsErrors % m_errorRate)) B2ERROR("Upset APV detected!!!" << LogVar("APV", int(fadcApv.second)) << LogVar("FADC",
656 int(fadcApv.first)) << LogVar("Event number", eventNo));
657 }
658
659 for (auto& pp : m_storeDAQDiagnostics) {
660
661 if (pp.getFADCNumber() == fadcApv.first and pp.getAPVNumber() == fadcApv.second)
662 pp.setUpsetAPV(true);
663 }
664
665 }
666 }
667
668 // Here we can delete digits coming from upset APVs. We detect them by comparing
669 // actual and emulated pipeline address fields in DAQDiagnostics.
670 for (auto& p : diagnosticMap) {
671
672 if ((m_killUpsetDigits && p.second->getPipelineAddress() != p.second->getEmuPipelineAddress()) || p.second->getFTBError() != 240
673 || p.second->getFTBFlags() || p.second->getAPVError() || !(p.second->getAPVMatch()) || !(p.second->getFADCMatch())
674 || p.second->getBadHeader()
675 || p.second->getBadMapping() || p.second->getUpsetAPV() || p.second->getMissedHeader() || p.second->getMissedTrailer()) continue;
676 m_storeShaperDigits.appendNew(p.first);
677 }
678
679 if (!m_svdEventInfoPtr->getMatchTriggerType()) {if (!(nEventInfoMatchErrors % m_errorRate) or nEventInfoMatchErrors < 200) B2WARNING("Inconsistent SVD Trigger Type value for: " << LogVar("Event number", eventNo));}
680 if (!m_svdEventInfoPtr->getMatchModeByte()) {if (!(nEventInfoMatchErrors % m_errorRate) or nEventInfoMatchErrors < 200) B2WARNING("Inconsistent SVD ModeByte object for: " << LogVar("Event number", eventNo));}
681
682
683} //end event function
StoreArray< SVDDAQDiagnostic > m_storeDAQDiagnostics
SVDDAQDiagnostic array.
MainHeader m_MainHeader
Implementation of FADC Header.
StoreArray< RawSVD > m_rawSVD
output for RawSVD
FADCTrailer m_FADCTrailer
Implementation of FADC Trailer.
StoreObjPtr< SVDEventInfo > m_svdEventInfoPtr
SVDEventInfo output per event.
StoreArray< SVDShaperDigit > m_storeShaperDigits
SVDShaperDigit array.
FTBHeader m_FTBHeader
Implementation of FTB Header.
data_B m_data_B
Implementation of 2nd data word.
FTBTrailer m_FTBTrailer
Implementation of FTB Trailer.
APVHeader m_APVHeader
Implementation of APV Header.
void printB2Debug(uint32_t *data32, uint32_t *data32_min, uint32_t *data32_max, int nWords)
additional function that prints raw data words
DBObjPtr< HardwareClockSettings > m_hwClock
system clock
data_A m_data_A
Implementation of 1st data word.
uint32_t m_data32
Input 32-bit data word.
StoreObjPtr< EventMetaData > m_eventMetaDataPtr
Required input for EventMetaData.
SVDTriggerType m_SVDTriggerType
SVDTriggerType object.
SVDModeByte m_SVDModeByte
instance of SVDModeByte for the event

◆ 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

Initializes the Module.

initialize

Reimplemented from Module.

Definition at line 74 of file SVDUnpackerModule.cc.

75{
76 m_eventMetaDataPtr.isRequired();
77 // Don't panic if no SVD data.
78 m_rawSVD.isOptional(m_rawSVDListName);
79
80 // Register default SVDEventInfo for unpacking Raw Data
82
85
88
89}
@ c_ErrorIfAlreadyRegistered
If the object/array was already registered, produce an error (aborting initialisation).
Definition DataStore.h:72

◆ printB2Debug()

void printB2Debug ( uint32_t * data32,
uint32_t * data32_min,
uint32_t * data32_max,
int nWords )
private

additional function that prints raw data words

Definition at line 716 of file SVDUnpackerModule.cc.

717{
718
719 uint32_t* min = std::max((data32 - nWords), data32_min);
720 uint32_t* max = std::min((data32 + nWords), data32_max);
721
722 size_t counter{0};
723 std::stringstream os;
724 os << std::hex << std::setfill('0');
725 for (uint32_t* ptr = min; ptr <= max; ++ptr) {
726 os << std::setw(8) << *ptr;
727 if (++counter % 10 == 0) os << std::endl;
728 else os << " ";
729 }
730
731 os << std::endl;
732 B2INFO(os.str());
733 return;
734
735}

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

virtual void terminate ( void )
inlinevirtualinherited

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

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

This method can be implemented by subclasses.

Reimplemented in AafhInputModule, AnalysisPhase1StudyModule, ARICHBackgroundModule, arichBtestModule, ARICHNtupleModule, arichToNtupleModule, AsyncWrapper, AWESOMEBasicModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMCParticlesMonitorModule, B2BIIMdstInputModule, BabayagaNLOInputModule, BBBremInputModule, BeamabortModule, BeamabortStudyModule, BeamDigitizerModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BeamSpotMonitorModule, BelleMCOutputModule, BgoDigitizerModule, BgoModule, BgoStudyModule, BGOverlayInputModule, BHWideInputModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, CalibrationCollectorModule, CaveModule, CDCCosmicAnalysisModule, CDCCRTestModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, CDCCrossTalkAdderModule, CDCDedxCorrectionModule, CDCDedxDQMModule, CDCDedxPIDModule, CDCDedxScanModule, CDCDedxSkimCDSTModule, CDCDedxSkimModule, CDCDedxValidationModule, CDCDigitizerModule, cdcDQM7Module, CDCDQMModule, CDCInitialT0DeterminationModule, CDCTrigger2DFinderModule, CDCTriggerHoughETFModule, CDCTriggerNDFinderModule, CDCTriggerNeuroDataModule, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNeuroIDHistModule, CDCTriggerTSFFirmwareModule, CDCTriggerTSFModule, CDCTriggerUnpackerModule, CertifyParallelModule, CheckErrorEventModule, Chi2MCTrackMatcherModule, ClawDigitizerModule, ClawModule, ClawStudyModule, ClawsDigitizerModule, CLAWSModule, ClawsStudyModule, CollectorTestModule, Convert2RawDetModule, CosmicsAlignmentValidationModule, CRYInputModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, CurlingTrackCandSplitterModule, CurlTaggerModule, DAQPerfModule, DataWriterModule, DeSerializerModule, DeSerializerPXDModule, DisplayModule, DosiDigitizerModule, DosiModule, DosiStudyModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisExampleModule, DQMHistAnalysisHLTModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGEFFModule, DQMHistAnalysisTRGGDLModule, DQMHistAnalysisTRGModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DqmHistoManagerModule, DQMHistOutputToEPICSModule, DQMHistReferenceModule, DQMHistSnapshotsModule, Ds2RawFileModule, Ds2RawModule, Ds2RbufModule, Ds2SampleModule, ECLLOMModule, ECLBackgroundModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDModule, ECLClusterPSDModule, ECLCompressBGOverlayModule, ECLCovarianceMatrixModule, EclCovMatrixNtupleModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigiStudyModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMEXTENDEDModule, ECLDQMModule, ECLExpertModule, ECLFillCellIdMappingModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLMatchingPerformanceExpertModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLTrackClusterMatchingModule, ECLTrackClusterMatchingParametrizationExpertModule, ECLTrackClusterMatchingPerformanceModule, ECLTRGInformationModule, ECLTrimShowersAndDigitsModule, ECLUnpackerModule, eclWaveformCalibCollectorModule, ECLWaveformFitModule, EffPlotsModule, EKLMDataCheckerModule, ElapsedTimeModule, EventKinematicsModule, EvReductionModule, EvtGenDecayModule, ExtModule, FANGSDigitizerModule, FANGSModule, FANGSStudyModule, FastBDTClassifierAnalyzerModule, FastBDTClassifierTrainingModule, FastRbuf2DsModule, FillTrackFitNtupleModule, FlavorTaggerInfoFillerModule, FragmentationModule, FullSimModule, FullSimTimingModule, TRGGDLUnpackerModule, GeneratedVertexDisplacerModule, GeneratorPreselectionModule, GenfitVisModule, GenRawSendModule, GeometryModule, GetEventFromSocketModule, GFTC2SPTCConverterModule, GRLNeuroModule, GRLNeuroTrainerModule, He3DigitizerModule, He3tubeModule, He3tubeStudyModule, HepevtOutputModule, HepMCInputModule, HepMCOutputModule, HistoManagerModule, HistoModule, HitLevelInfoWriterModule, HitXPModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, KinkFinderModule, KKGenInputModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQM2Module, KLMDQMModule, KLMExpertModule, KLMMuonIDDNNExpertModule, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMTrackingModule, KLMTriggerModule, KLMUnpackerModule, KlongValidationModule, KoralWInputModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, MasterClassModule, MCMatcherTRGECLModule, MCTrackCandClassifierModule, MCV0MatcherModule, MergeDataStoreModule, MicrotpcModule, MicrotpcStudyModule, TpcDigitizerModule, MLSegmentNetworkProducerModule, MonitorDataModule, MuidModule, MVAExpertModule, MVAMultipleExpertsModule, NoKickCutsEvalModule, NtuplePhase1_v6Module, ParticleKinematicFitterModule, OverrideGenerationFlagsModule, PartialSeqRootReaderModule, ParticleLoaderModule, ParticleMassHypothesesUpdaterModule, ParticleMassUpdaterModule, ParticleMCDecayStringModule, ParticleMomentumUpdaterModule, ParticleStatsModule, ParticleWeightingLookUpCreatorModule, Ph1bpipeModule, Ph1sustrModule, PhaseSpaceAnalysisModule, PhokharaInputModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, PIDNtupleModule, PinDigitizerModule, PindiodeModule, PindiodeStudyModule, PlumeDigitizerModule, PlumeModule, ProfileModule, ProgressBarModule, PXDBackgroundModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PXDPackerErrModule, PXDPackerModule, PXDReadRawBonnDAQMatchedModule, PXDReadRawBonnDAQModule, PXDReadRawONSENModule, PXDUnpackerModule, PXDUnpackerOldModule, PXDUnpackerOTModule, PXDClustersFromTracksModule, PXDDQMEfficiencyNtupleModule, PXDDQMEfficiencyNtupleSelftrackModule, PXDDQMTrackRawNtupleModule, PXDPerformanceModule, PXDROIFinderAnalysisModule, PXDSpacePointCreatorModule, PyModule, QcsmonitorDigitizerModule, QcsmonitorModule, QcsmonitorStudyModule, RandomBarrierModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, ReceiveEventModule, RemoveMCParticlesModule, RemoveParticlesNotInListsModule, ReprocessorModule, ROIDQMModule, ROIReadTestModule, ROISenderModule, Root2BinaryModule, Root2RawModule, RootInputModule, RootOutputModule, RT2SPTCConverterModule, RxModule, RxSocketModule, ScanCDCGeoModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, SegmentNetworkAnalyzerModule, SeqRootInputModule, SeqRootMergerModule, SeqRootOutputModule, SerializerModule, SkimFilterModule, SoftwareTriggerModule, SoftwareTriggerResultPrinterModule, SpacePoint2TrueHitConnectorModule, SpacePointCreatorTestModule, SPTC2GFTCConverterModule, SPTC2RTConverterModule, SPTCRefereeModule, SrsensorModule, StandardTrackingPerformanceModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, StudyMaterialEffectsModule, SubEventModule, SVD3SamplesEmulatorModule, SVDBackgroundModule, SVDDigitizerModule, SVDPackerModule, SVDVariablesToStorageModule, SVDChannelMappingModule, SVDChargeSharingAnalysisModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDClusterQualityEstimatorCalibrationModule, SVDClusterQualityEstimatorModule, SVDCoGTimeEstimatorModule, SVDCrossTalkFinderModule, SVDDataFormatCheckModule, SVDDQMClustersOnTrackModule, SVDDQMExpressRecoModule, svdDumpModule, SVDEventT0PerformanceTTreeModule, SVDHotStripFinderModule, SVDMaxStripTTreeModule, SVDPerformanceTTreeModule, SVDROIFinderAnalysisDataModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SVDShaperDigitsFromTracksModule, SVDSpacePointCreatorModule, SVDSpacePointQICalibrationModule, SVDTriggerQualityGeneratorModule, SwitchDataStoreModule, TCConvertersTestModule, TeeggInputModule, TOPAlignerModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelT0CalibratorModule, TOPChannelT0MCModule, TOPCommonT0CalibratorModule, TOPCosmicT0FinderModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPLaserHitSelectorModule, TOPLLScannerModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPPDFCheckerModule, TOPRawDigitConverterModule, TOPRingPlotterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTriggerDigitizerModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, TrackAnaModule, TrackFilterModule, FindletModule< AFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< AxialTrackFinderLegendre >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< FacetCreator >, FindletModule< FacetCreator >, FindletModule< HitBasedT0Extractor >, FindletModule< HitBasedT0Extractor >, FindletModule< HitReclaimer >, FindletModule< HitReclaimer >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackExporter >, FindletModule< TrackFinder >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFindingCDC::FindletStoreArrayInput< BaseEventTimeExtractorModuleFindlet< AFindlet > > >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< TrackRejecter >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, FindletModule< WireHitPreparer >, TrackFinderVXDAnalizerModule, TrackingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, TreeFitterModule, TrepsInputModule, TRGCDCETFUnpackerModule, TRGCDCModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSStreamModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLFAMModule, TRGECLModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGEFFDQMModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLModule, TRGGDLSummaryModule, TRGGRLDQMModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLUnpackerModule, TRGRAWDATAModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TxModule, TxSocketModule, V0FinderModule, V0findingPerformanceEvaluationModule, VariablesToEventBasedTreeModule, VariablesToHistogramModule, VariablesToNtupleModule, VXDMisalignmentModule, VXDDedxPIDModule, VXDQETrainingDataCollectorModule, VXDTFTrainingDataCollectorModule, ZMQRxOutputModule, ZMQRxWorkerModule, ZMQTxInputModule, and ZMQTxWorkerModule.

Definition at line 175 of file Module.h.

175{};

Member Data Documentation

◆ APVmap

std::unordered_multimap<unsigned char, unsigned char>* APVmap
private

pointer to APVforFADCmap filled by mapping procedure

Definition at line 77 of file SVDUnpackerModule.h.

◆ m_APVHeader

APVHeader m_APVHeader

Implementation of APV Header.

Definition at line 169 of file SVDUnpackerModule.h.

◆ m_badMappingFatal

bool m_badMappingFatal = false
private

Optionally we can stop the unpacking if there is a missing APV/FADC combination in the mapping -> wrong payload is identified.

Definition at line 211 of file SVDUnpackerModule.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_data32

uint32_t m_data32

Input 32-bit data word.

Definition at line 166 of file SVDUnpackerModule.h.

◆ m_data_A

data_A m_data_A

Implementation of 1st data word.

Definition at line 170 of file SVDUnpackerModule.h.

◆ m_data_B

data_B m_data_B

Implementation of 2nd data word.

Definition at line 171 of file SVDUnpackerModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_emulatePipelineAddress

bool m_emulatePipelineAddress = false
private

Software emulation of pipeline address This is a replacement of hardware pipeline address emulation.

Pipeline address is emulated by major vote from working APVs. Can be turned off once hardware emulation works.

Definition at line 192 of file SVDUnpackerModule.h.

◆ m_errorRate

int m_errorRate {1000}
private

The parameter that indicates what fraction of B2ERRORs messages should be suppressed to not overload HLT while data taking.

Definition at line 219 of file SVDUnpackerModule.h.

219{1000};

◆ m_eventMetaDataPtr

StoreObjPtr<EventMetaData> m_eventMetaDataPtr
private

Required input for EventMetaData.

Definition at line 176 of file SVDUnpackerModule.h.

◆ m_FADCTrailer

FADCTrailer m_FADCTrailer

Implementation of FADC Trailer.

Definition at line 172 of file SVDUnpackerModule.h.

◆ m_FADCTriggerNumberOffset

int m_FADCTriggerNumberOffset
private

FADC Trigger Offset.

Definition at line 185 of file SVDUnpackerModule.h.

◆ m_FTBHeader

FTBHeader m_FTBHeader

Implementation of FTB Header.

Definition at line 167 of file SVDUnpackerModule.h.

◆ m_FTBTrailer

FTBTrailer m_FTBTrailer

Implementation of FTB Trailer.

Definition at line 173 of file SVDUnpackerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_hwClock

DBObjPtr<HardwareClockSettings> m_hwClock
private

system clock

Definition at line 92 of file SVDUnpackerModule.h.

◆ m_killUpsetDigits

bool m_killUpsetDigits = false
private

Optionally, we can kill digits coming from upset APVs right in the unpacker.

Definition at line 197 of file SVDUnpackerModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_MainHeader

MainHeader m_MainHeader

Implementation of FADC Header.

Definition at line 168 of file SVDUnpackerModule.h.

◆ m_map

std::unique_ptr<SVDOnlineToOfflineMap> m_map
private

Pointer to online-to-offline map.

Definition at line 80 of file SVDUnpackerModule.h.

◆ m_mapping

DBObjPtr<PayloadFile> m_mapping
private

pointer to the payload with the mapping

Definition at line 86 of file SVDUnpackerModule.h.

◆ m_missingAPVs

std::map<std::pair<unsigned short, unsigned short>, std::pair<std::size_t, std::size_t> > m_missingAPVs
private

Map to store a list of missing APVs.

Definition at line 237 of file SVDUnpackerModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 507 of file Module.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 509 of file Module.h.

◆ m_printRaw

bool m_printRaw
private

Optionally we can get printout of Raw Data words.

Definition at line 214 of file SVDUnpackerModule.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_rawSVD

StoreArray<RawSVD> m_rawSVD
private

output for RawSVD

Definition at line 180 of file SVDUnpackerModule.h.

◆ m_rawSVDListName

std::string m_rawSVDListName

RawSVD StoreArray name.

Definition at line 63 of file SVDUnpackerModule.h.

◆ m_relativeTimeShift

int m_relativeTimeShift
private

latency difference between the 3- and 6-sample acquired events in usint of APV clock / 4, read from SVDGlobalConfigParameters and filled into SVDEventInfo

Definition at line 247 of file SVDUnpackerModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_seuRecMap

std::map<std::pair<unsigned short, unsigned short>, std::pair<std::size_t, std::size_t> > m_seuRecMap
private

Map to store a list of APVs for special data for SEU recovery.

Definition at line 242 of file SVDUnpackerModule.h.

◆ m_shutUpFTBError

int m_shutUpFTBError
private

regulates the number of "Event number mismatch" errors reported

Definition at line 184 of file SVDUnpackerModule.h.

◆ m_silentAppend

bool m_silentAppend = false
private

Silently append new SVDShaperDigits to a pre-existing non-empty SVDShaperDigits storeArray.

If false, a pre-exsiting non-empty output StoreArray will cause a FATAL error to remind the users that they may be mixing data inadvertently, and that they need to plug in a digit sorter in the module path.

Definition at line 206 of file SVDUnpackerModule.h.

◆ m_storeDAQDiagnostics

StoreArray<SVDDAQDiagnostic> m_storeDAQDiagnostics
private

SVDDAQDiagnostic array.

Definition at line 181 of file SVDUnpackerModule.h.

◆ m_storeShaperDigits

StoreArray<SVDShaperDigit> m_storeShaperDigits
private

SVDShaperDigit array.

Definition at line 182 of file SVDUnpackerModule.h.

◆ m_svdDAQDiagnosticsListName

std::string m_svdDAQDiagnosticsListName

SVDDAQDiagnostic StoreArray name.

Definition at line 65 of file SVDUnpackerModule.h.

◆ m_svdEventInfoName

std::string m_svdEventInfoName

SVDEventInfo name.

Definition at line 66 of file SVDUnpackerModule.h.

◆ m_svdEventInfoPtr

StoreObjPtr<SVDEventInfo> m_svdEventInfoPtr
private

SVDEventInfo output per event.

Definition at line 177 of file SVDUnpackerModule.h.

◆ m_svdGlobalConfig

DBObjPtr<SVDGlobalConfigParameters> m_svdGlobalConfig
private

SVDGlobal Configuration payload.

Definition at line 249 of file SVDUnpackerModule.h.

◆ m_SVDModeByte

SVDModeByte m_SVDModeByte
private

instance of SVDModeByte for the event

Definition at line 89 of file SVDUnpackerModule.h.

◆ m_svdShaperDigitListName

std::string m_svdShaperDigitListName

SVDShaperDigit StoreArray name.

Definition at line 64 of file SVDUnpackerModule.h.

◆ m_SVDTriggerType

SVDTriggerType m_SVDTriggerType
private

SVDTriggerType object.

Definition at line 178 of file SVDUnpackerModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ m_upsetAPVs

std::map<std::pair<unsigned short, unsigned short>, std::pair<std::size_t, std::size_t> > m_upsetAPVs
private

Map to store a list of upset APVs.

Definition at line 240 of file SVDUnpackerModule.h.

◆ m_wrongFTBcrc

int m_wrongFTBcrc

FTB CRC no-Match counter.

Definition at line 68 of file SVDUnpackerModule.h.

◆ m_xmlFileName

std::string m_xmlFileName = std::string("SVDChannelMapping.xml")
staticprivate

XML filename.

Definition at line 83 of file SVDUnpackerModule.h.

◆ nAPVErrors

int nAPVErrors
private

counter of APV errors

Definition at line 232 of file SVDUnpackerModule.h.

◆ nErrorFieldErrors

int nErrorFieldErrors
private

counter of event mismatch errors in FTB's ErrorField

Definition at line 229 of file SVDUnpackerModule.h.

◆ nEventInfoMatchErrors

int nEventInfoMatchErrors
private

counter of inconsistencies in SVDEventInfo within an event

Definition at line 234 of file SVDUnpackerModule.h.

◆ nEventMatchErrors

int nEventMatchErrors
private

counter of Event match errors

Definition at line 226 of file SVDUnpackerModule.h.

◆ nFADCboards

unsigned short nFADCboards
private

how many FADCs we have

Definition at line 74 of file SVDUnpackerModule.h.

◆ nFADCMatchErrors

int nFADCMatchErrors
private

counter of FADC boards =/= n of RawData objects errors

Definition at line 231 of file SVDUnpackerModule.h.

◆ nFTBFlagsErrors

int nFTBFlagsErrors
private

counter of errors in FTBFlags variable

Definition at line 233 of file SVDUnpackerModule.h.

◆ nMissingAPVsErrors

int nMissingAPVsErrors
private

counter of missing APVs errors

Definition at line 230 of file SVDUnpackerModule.h.

◆ nSEURecoveryCase

int nSEURecoveryCase
private

counter of SEU Special Recovery data cases

Definition at line 228 of file SVDUnpackerModule.h.

◆ nTriggerMatchErrors

int nTriggerMatchErrors
private

counters for specific ERRORS produced by the Unpacker

counter of Trigger match errors

Definition at line 225 of file SVDUnpackerModule.h.

◆ nUpsetAPVsErrors

int nUpsetAPVsErrors
private

counter of upset APV errors

Definition at line 227 of file SVDUnpackerModule.h.

◆ seenHeadersAndTrailers

unsigned short seenHeadersAndTrailers
private

this 4-bits value should be 1111 if no headers/trailers are missing

Definition at line 222 of file SVDUnpackerModule.h.


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