Belle II Software development
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
SVDUnpackerModule Class Reference

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

#include <SVDUnpackerModule.h>

Inheritance diagram for SVDUnpackerModule:
Module PathElement

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.
 
LogConfig & getLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level.
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module.
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module.
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module.
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleCondition * getCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
 
std::shared_ptr< Path > getConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished.
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module.
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamList & getParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter.
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module.
 
std::shared_ptr< PathElement > clone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

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.
 
uint32_t m_data32
 Input 32-bit data word.
 
FTBHeader m_FTBHeader
 Implementation of FTB Header.
 
MainHeader m_MainHeader
 Implementation of FADC Header.
 
APVHeader m_APVHeader
 Implementation of APV Header.
 
data_A m_data_A
 Implementation of 1st data word.
 
data_B m_data_B
 Implementation of 2nd data word.
 
FADCTrailer m_FADCTrailer
 Implementation of FADC Trailer.
 
FTBTrailer m_FTBTrailer
 Implementation of FTB Trailer.
 

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< ModulePtr > getModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

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< SVDOnlineToOfflineMap > m_map
 Pointer to online-to-offline map.
 
DBObjPtr< PayloadFile > m_mapping
 pointer to the payload with the mapping
 
SVDModeByte m_SVDModeByte
 instance of SVDModeByte for the event
 
DBObjPtr< HardwareClockSettings > m_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< EventMetaData > m_eventMetaDataPtr
 Required input for EventMetaData.
 
StoreObjPtr< SVDEventInfo > m_svdEventInfoPtr
 SVDEventInfo output per event.
 
SVDTriggerType m_SVDTriggerType
 SVDTriggerType object.
 
StoreArray< RawSVD > m_rawSVD
 output for RawSVD
 
StoreArray< SVDDAQDiagnostic > m_storeDAQDiagnostics
 SVDDAQDiagnostic array.
 
StoreArray< SVDShaperDigit > m_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 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.
 
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< SVDGlobalConfigParameters > m_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< ModuleCondition > m_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 39 of file SVDUnpackerModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
inherited

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

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 };
Belle2::Module::c_HistogramManager
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
Belle2::Module::c_Input
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
Belle2::Module::c_DontCollectStatistics
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
Belle2::Module::c_ParallelProcessingCertified
@ 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
Belle2::Module::c_InternalSerializer
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
Belle2::Module::c_Output
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
Belle2::Module::c_TerminateInAllProcesses
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ SVDUnpackerModule()

SVDUnpackerModule ( )

Constructor of the module.

Definition at line 45 of file SVDUnpackerModule.cc.

45 : Module(),
46 m_mapping(m_xmlFileName),
47 m_shutUpFTBError(0),
48 m_FADCTriggerNumberOffset(0)
49{
50 //Set module properties
51 setDescription("Produce SVDShaperDigits from RawSVD. NOTE: only zero-suppressed mode is currently supported!");
52 setPropertyFlags(c_ParallelProcessingCertified);
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}
Belle2::Module::setDescription
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
Belle2::Module::setPropertyFlags
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Belle2::Module::Module
Module()
Constructor.
Definition: Module.cc:30
Belle2::SVD::SVDUnpackerModule::m_shutUpFTBError
int m_shutUpFTBError
regulates the number of "Event number mismatch" errors reported
Definition: SVDUnpackerModule.h:178
Belle2::SVD::SVDUnpackerModule::m_rawSVDListName
std::string m_rawSVDListName
RawSVD StoreArray name.
Definition: SVDUnpackerModule.h:60
Belle2::SVD::SVDUnpackerModule::m_mapping
DBObjPtr< PayloadFile > m_mapping
pointer to the payload with the mapping
Definition: SVDUnpackerModule.h:83
Belle2::SVD::SVDUnpackerModule::m_killUpsetDigits
bool m_killUpsetDigits
Optionally, we can kill digits coming from upset APVs right in the unpacker.
Definition: SVDUnpackerModule.h:191
Belle2::SVD::SVDUnpackerModule::m_FADCTriggerNumberOffset
int m_FADCTriggerNumberOffset
FADC Trigger Offset.
Definition: SVDUnpackerModule.h:179
Belle2::SVD::SVDUnpackerModule::m_xmlFileName
static std::string m_xmlFileName
XML filename.
Definition: SVDUnpackerModule.h:80
Belle2::SVD::SVDUnpackerModule::m_errorRate
int m_errorRate
The parameter that indicates what fraction of B2ERRORs messages should be suppressed to not overload ...
Definition: SVDUnpackerModule.h:213
Belle2::SVD::SVDUnpackerModule::m_svdShaperDigitListName
std::string m_svdShaperDigitListName
SVDShaperDigit StoreArray name.
Definition: SVDUnpackerModule.h:61
Belle2::SVD::SVDUnpackerModule::m_svdEventInfoName
std::string m_svdEventInfoName
SVDEventInfo name.
Definition: SVDUnpackerModule.h:63
Belle2::SVD::SVDUnpackerModule::m_printRaw
bool m_printRaw
Optionally we can get printout of Raw Data words.
Definition: SVDUnpackerModule.h:208
Belle2::SVD::SVDUnpackerModule::m_badMappingFatal
bool m_badMappingFatal
Optionally we can stop the unpacking if there is a missing APV/FADC combination in the mapping -> wro...
Definition: SVDUnpackerModule.h:205
Belle2::SVD::SVDUnpackerModule::m_silentAppend
bool m_silentAppend
Silently append new SVDShaperDigits to a pre-existing non-empty SVDShaperDigits storeArray.
Definition: SVDUnpackerModule.h:200
Belle2::SVD::SVDUnpackerModule::m_emulatePipelineAddress
bool m_emulatePipelineAddress
Software emulation of pipeline address This is a replacement of hardware pipeline address emulation.
Definition: SVDUnpackerModule.h:186
Belle2::SVD::SVDUnpackerModule::m_svdDAQDiagnosticsListName
std::string m_svdDAQDiagnosticsListName
SVDDAQDiagnostic StoreArray name.
Definition: SVDUnpackerModule.h:62
Belle2::Module::addParam
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

◆ ~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
114 nTriggerMatchErrors = -1;
115 nEventMatchErrors = -1;
116 nUpsetAPVsErrors = -1;
117 nErrorFieldErrors = -1;
118 nMissingAPVsErrors = -1;
119 nFADCMatchErrors = -1;
120 nAPVErrors = -1;
121 nFTBFlagsErrors = -1;
122 nEventInfoMatchErrors = -1;
123
124 seenHeadersAndTrailers = 0;
125
126 //get the relative time shift
127 if (!m_svdGlobalConfig.isValid())
128 B2FATAL("SVDGlobalConfigParameters not valid!!");
129
130 m_relativeTimeShift = m_svdGlobalConfig->getRelativeTimeShift();
131
132}
Belle2::DBAccessorBase::hasChanged
bool hasChanged()
Check whether the object has changed since the last call to hasChanged of the accessor).
Definition: DBAccessorBase.h:89
Belle2::DBObjPtr< PayloadFile >::isValid
bool isValid() const
isValid is always true if we have a filename
Definition: PayloadFile.h:64
Belle2::PayloadFile::getFileName
std::string getFileName() const
Get the name of the downloaded payload file.
Definition: PayloadFile.h:35
Belle2::SVD::SVDUnpackerModule::m_wrongFTBcrc
int m_wrongFTBcrc
FTB CRC no-Match counter.
Definition: SVDUnpackerModule.h:65
Belle2::SVD::SVDUnpackerModule::seenHeadersAndTrailers
unsigned short seenHeadersAndTrailers
this 4-bits value should be 1111 if no headers/trailers are missing
Definition: SVDUnpackerModule.h:216
Belle2::SVD::SVDUnpackerModule::nAPVErrors
int nAPVErrors
counter of APV errors
Definition: SVDUnpackerModule.h:225
Belle2::SVD::SVDUnpackerModule::nFADCMatchErrors
int nFADCMatchErrors
counter of FADC boards =/= n of RawData objects errors
Definition: SVDUnpackerModule.h:224
Belle2::SVD::SVDUnpackerModule::nMissingAPVsErrors
int nMissingAPVsErrors
counter of missing APVs errors
Definition: SVDUnpackerModule.h:223
Belle2::SVD::SVDUnpackerModule::nEventMatchErrors
int nEventMatchErrors
counter of Event match errors
Definition: SVDUnpackerModule.h:220
Belle2::SVD::SVDUnpackerModule::nUpsetAPVsErrors
int nUpsetAPVsErrors
counter of upset APV errors
Definition: SVDUnpackerModule.h:221
Belle2::SVD::SVDUnpackerModule::m_svdGlobalConfig
DBObjPtr< SVDGlobalConfigParameters > m_svdGlobalConfig
SVDGlobal Configuration payload.
Definition: SVDUnpackerModule.h:237
Belle2::SVD::SVDUnpackerModule::nEventInfoMatchErrors
int nEventInfoMatchErrors
counter of inconsistencies in SVDEventInfo within an event
Definition: SVDUnpackerModule.h:227
Belle2::SVD::SVDUnpackerModule::nErrorFieldErrors
int nErrorFieldErrors
counter of event mismatch errors in FTB's ErrorField
Definition: SVDUnpackerModule.h:222
Belle2::SVD::SVDUnpackerModule::APVmap
std::unordered_multimap< unsigned char, unsigned char > * APVmap
pointer to APVforFADCmap filled by mapping procedure
Definition: SVDUnpackerModule.h:74
Belle2::SVD::SVDUnpackerModule::m_map
std::unique_ptr< SVDOnlineToOfflineMap > m_map
Pointer to online-to-offline map.
Definition: SVDUnpackerModule.h:77
Belle2::SVD::SVDUnpackerModule::m_relativeTimeShift
int m_relativeTimeShift
latency difference between the 3- and 6-sample acquired events in usint of APV clock / 4,...
Definition: SVDUnpackerModule.h:235
Belle2::SVD::SVDUnpackerModule::nFTBFlagsErrors
int nFTBFlagsErrors
counter of errors in FTBFlags variable
Definition: SVDUnpackerModule.h:226
Belle2::SVD::SVDUnpackerModule::nTriggerMatchErrors
int nTriggerMatchErrors
counters for specific ERRORS produced by the Unpacker
Definition: SVDUnpackerModule.h:219
Belle2::SVD::SVDUnpackerModule::nFADCboards
unsigned short nFADCboards
how many FADCs we have
Definition: SVDUnpackerModule.h:71

◆ 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{
181 ModulePtr newModule = ModuleManager::Instance().registerModule(getType());
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
Belle2::ModuleManager::registerModule
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.
Definition: ModuleManager.cc:80
Belle2::ModuleManager::Instance
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
Definition: ModuleManager.cc:24
Belle2::Module::getParamList
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
Belle2::Module::getName
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
Belle2::Module::getType
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
Belle2::Module::m_propertyFlags
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
Belle2::Module::m_logConfig
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
Belle2::Module::m_conditions
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
Belle2::Module::m_package
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
Belle2::ModulePtr
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 426 of file Module.h.

426{ beginRun(); }
Belle2::Module::beginRun
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }
Belle2::Module::endRun
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }
Belle2::Module::event
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }
Belle2::Module::initialize
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }
Belle2::Module::terminate
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ endRun()

void endRun ( void  )
overridevirtual

end run

Reimplemented from Module.

Definition at line 637 of file SVDUnpackerModule.cc.

638{
639 // Summary report on missing APVs
640 if (m_missingAPVs.size() > 0) {
641 B2WARNING("SVDUnpacker summary 1: Missing APVs");
642 for (const auto& miss : m_missingAPVs)
643 B2WARNING(LogVar("Missing APV", miss.first.second) << LogVar("FADC", miss.first.first) << LogVar("since event",
644 miss.second.first) << LogVar("to event", miss.second.second));
645 }
646 if (m_upsetAPVs.size() > 0) {
647 B2WARNING("SVDUnpacker summary 2: Upset APVs");
648 for (const auto& upst : m_upsetAPVs)
649 B2WARNING(LogVar("Upset APV", upst.first.second) << LogVar("FADC", upst.first.first) <<
650 LogVar("since event", upst.second.first) << LogVar("to event", upst.second.second));
651 }
652}
Belle2::SVD::SVDUnpackerModule::m_missingAPVs
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.
Definition: SVDUnpackerModule.h:230
Belle2::SVD::SVDUnpackerModule::m_upsetAPVs
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.
Definition: SVDUnpackerModule.h:233
LogVar
Class to store variables with their name which were sent to the logging service.
Definition: LogVariableStream.h:24

◆ 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}
Belle2::Module::m_returnValue
int m_returnValue
The return value.
Definition: Module.h:519
Belle2::Module::m_hasReturnValue
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

event

Reimplemented from Module.

Definition at line 138 of file SVDUnpackerModule.cc.

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

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 314 of file Module.h.

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

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

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


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
Belle2::Module::m_description
std::string m_description
The description of the module.
Definition: Module.h:511

◆ getFileNames()

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

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

187{return m_name;}
Belle2::Module::m_name
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 311 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

167{
168 auto missing = m_moduleParamList.getUnsetForcedParams();
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}
Belle2::ModuleParamList::getUnsetForcedParams
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.
Definition: ModuleParamList.cc:54

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

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

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

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

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
81 m_svdEventInfoPtr.registerInDataStore(m_svdEventInfoName, DataStore::c_ErrorIfAlreadyRegistered);
82
83 m_storeDAQDiagnostics.registerInDataStore(m_svdDAQDiagnosticsListName);
84 m_svdDAQDiagnosticsListName = m_storeDAQDiagnostics.getName();
85
86 m_storeShaperDigits.registerInDataStore(m_svdShaperDigitListName);
87 m_svdShaperDigitListName = m_storeShaperDigits.getName();
88
89}
Belle2::DataStore::c_ErrorIfAlreadyRegistered
@ 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 656 of file SVDUnpackerModule.cc.

657{
658
659 uint32_t* min = std::max((data32 - nWords), data32_min);
660 uint32_t* max = std::min((data32 + nWords), data32_max);
661
662 size_t counter{0};
663 std::stringstream os;
664 os << std::hex << std::setfill('0');
665 for (uint32_t* ptr = min; ptr <= max; ++ptr) {
666 os << std::setw(8) << *ptr;
667 if (++counter % 10 == 0) os << std::endl;
668 else os << " ";
669 }
670
671 os << std::endl;
672 B2INFO(os.str());
673 return;
674
675}

◆ 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}
Belle2::LogConfig::ELogLevel
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
Belle2::LogConfig::setAbortLevel
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}
Belle2::LogConfig::setDebugLevel
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig &  logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
Belle2::LogConfig::setLogInfo
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}
Belle2::LogConfig::setLogLevel
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

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

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList &  params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
239 m_moduleParamList.setParamPython(name, pyObj);
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}
Belle2::LogSystem
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
Belle2::LogSystem::updateModule
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
Belle2::LogSystem::Instance
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
Belle2::ModuleParamList::setParamPython
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.
Definition: ModuleParamList.templateDetails.h:104

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

Definition at line 176 of file Module.h.

176{};

Member Data Documentation

◆ APVmap

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

pointer to APVforFADCmap filled by mapping procedure

Definition at line 74 of file SVDUnpackerModule.h.

◆ m_APVHeader

APVHeader m_APVHeader

Implementation of APV Header.

Definition at line 163 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 205 of file SVDUnpackerModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_data32

uint32_t m_data32

Input 32-bit data word.

Definition at line 160 of file SVDUnpackerModule.h.

◆ m_data_A

data_A m_data_A

Implementation of 1st data word.

Definition at line 164 of file SVDUnpackerModule.h.

◆ m_data_B

data_B m_data_B

Implementation of 2nd data word.

Definition at line 165 of file SVDUnpackerModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 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 186 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 213 of file SVDUnpackerModule.h.

◆ m_eventMetaDataPtr

StoreObjPtr<EventMetaData> m_eventMetaDataPtr
private

Required input for EventMetaData.

Definition at line 170 of file SVDUnpackerModule.h.

◆ m_FADCTrailer

FADCTrailer m_FADCTrailer

Implementation of FADC Trailer.

Definition at line 166 of file SVDUnpackerModule.h.

◆ m_FADCTriggerNumberOffset

int m_FADCTriggerNumberOffset
private

FADC Trigger Offset.

Definition at line 179 of file SVDUnpackerModule.h.

◆ m_FTBHeader

FTBHeader m_FTBHeader

Implementation of FTB Header.

Definition at line 161 of file SVDUnpackerModule.h.

◆ m_FTBTrailer

FTBTrailer m_FTBTrailer

Implementation of FTB Trailer.

Definition at line 167 of file SVDUnpackerModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_hwClock

DBObjPtr<HardwareClockSettings> m_hwClock
private

system clock

Definition at line 89 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 191 of file SVDUnpackerModule.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_MainHeader

MainHeader m_MainHeader

Implementation of FADC Header.

Definition at line 162 of file SVDUnpackerModule.h.

◆ m_map

std::unique_ptr<SVDOnlineToOfflineMap> m_map
private

Pointer to online-to-offline map.

Definition at line 77 of file SVDUnpackerModule.h.

◆ m_mapping

DBObjPtr<PayloadFile> m_mapping
private

pointer to the payload with the mapping

Definition at line 83 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 230 of file SVDUnpackerModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 508 of file Module.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 510 of file Module.h.

◆ m_printRaw

bool m_printRaw
private

Optionally we can get printout of Raw Data words.

Definition at line 208 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 512 of file Module.h.

◆ m_rawSVD

StoreArray<RawSVD> m_rawSVD
private

output for RawSVD

Definition at line 174 of file SVDUnpackerModule.h.

◆ m_rawSVDListName

std::string m_rawSVDListName

RawSVD StoreArray name.

Definition at line 60 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 235 of file SVDUnpackerModule.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_shutUpFTBError

int m_shutUpFTBError
private

regulates the number of "Event number mismatch" errors reported

Definition at line 178 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 200 of file SVDUnpackerModule.h.

◆ m_storeDAQDiagnostics

StoreArray<SVDDAQDiagnostic> m_storeDAQDiagnostics
private

SVDDAQDiagnostic array.

Definition at line 175 of file SVDUnpackerModule.h.

◆ m_storeShaperDigits

StoreArray<SVDShaperDigit> m_storeShaperDigits
private

SVDShaperDigit array.

Definition at line 176 of file SVDUnpackerModule.h.

◆ m_svdDAQDiagnosticsListName

std::string m_svdDAQDiagnosticsListName

SVDDAQDiagnostic StoreArray name.

Definition at line 62 of file SVDUnpackerModule.h.

◆ m_svdEventInfoName

std::string m_svdEventInfoName

SVDEventInfo name.

Definition at line 63 of file SVDUnpackerModule.h.

◆ m_svdEventInfoPtr

StoreObjPtr<SVDEventInfo> m_svdEventInfoPtr
private

SVDEventInfo output per event.

Definition at line 171 of file SVDUnpackerModule.h.

◆ m_svdGlobalConfig

DBObjPtr<SVDGlobalConfigParameters> m_svdGlobalConfig
private

SVDGlobal Configuration payload.

Definition at line 237 of file SVDUnpackerModule.h.

◆ m_SVDModeByte

SVDModeByte m_SVDModeByte
private

instance of SVDModeByte for the event

Definition at line 86 of file SVDUnpackerModule.h.

◆ m_svdShaperDigitListName

std::string m_svdShaperDigitListName

SVDShaperDigit StoreArray name.

Definition at line 61 of file SVDUnpackerModule.h.

◆ m_SVDTriggerType

SVDTriggerType m_SVDTriggerType
private

SVDTriggerType object.

Definition at line 172 of file SVDUnpackerModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ 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 233 of file SVDUnpackerModule.h.

◆ m_wrongFTBcrc

int m_wrongFTBcrc

FTB CRC no-Match counter.

Definition at line 65 of file SVDUnpackerModule.h.

◆ m_xmlFileName

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

XML filename.

Definition at line 80 of file SVDUnpackerModule.h.

◆ nAPVErrors

int nAPVErrors
private

counter of APV errors

Definition at line 225 of file SVDUnpackerModule.h.

◆ nErrorFieldErrors

int nErrorFieldErrors
private

counter of event mismatch errors in FTB's ErrorField

Definition at line 222 of file SVDUnpackerModule.h.

◆ nEventInfoMatchErrors

int nEventInfoMatchErrors
private

counter of inconsistencies in SVDEventInfo within an event

Definition at line 227 of file SVDUnpackerModule.h.

◆ nEventMatchErrors

int nEventMatchErrors
private

counter of Event match errors

Definition at line 220 of file SVDUnpackerModule.h.

◆ nFADCboards

unsigned short nFADCboards
private

how many FADCs we have

Definition at line 71 of file SVDUnpackerModule.h.

◆ nFADCMatchErrors

int nFADCMatchErrors
private

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

Definition at line 224 of file SVDUnpackerModule.h.

◆ nFTBFlagsErrors

int nFTBFlagsErrors
private

counter of errors in FTBFlags variable

Definition at line 226 of file SVDUnpackerModule.h.

◆ nMissingAPVsErrors

int nMissingAPVsErrors
private

counter of missing APVs errors

Definition at line 223 of file SVDUnpackerModule.h.

◆ nTriggerMatchErrors

int nTriggerMatchErrors
private

counters for specific ERRORS produced by the Unpacker

counter of Trigger match errors

Definition at line 219 of file SVDUnpackerModule.h.

◆ nUpsetAPVsErrors

int nUpsetAPVsErrors
private

counter of upset APV errors

Definition at line 221 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 216 of file SVDUnpackerModule.h.

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