SVDUnpackerModule Class Reference

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

#include <SVDUnpackerModule.h>

Inheritance diagram for SVDUnpackerModule:

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

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

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

                          {
      c_Input                       = 1,  
      c_Output                      = 2,  
      c_ParallelProcessingCertified = 4,  
      c_HistogramManager            = 8, 
      c_InternalSerializer          = 16,  
      c_TerminateInAllProcesses     = 32,  
      c_DontCollectStatistics       = 64,  
    };

Constructor & Destructor Documentation

SVDUnpackerModule()

SVDUnpackerModule

(

)

Constructor of the module.

Definition at line 45 of file SVDUnpackerModule.cc.

                                     : Module(),
  m_mapping(m_xmlFileName),
  m_shutUpFTBError(0),
  m_FADCTriggerNumberOffset(0)
{
  //Set module properties
  setDescription("Produce SVDShaperDigits from RawSVD. NOTE: only zero-suppressed mode is currently supported!");
  setPropertyFlags(c_ParallelProcessingCertified);
 
  addParam("SVDEventInfo", m_svdEventInfoName, "Name of the SVDEventInfo object", string(""));
  addParam("rawSVDListName", m_rawSVDListName, "Name of the raw SVD List", string(""));
  addParam("svdShaperDigitListName", m_svdShaperDigitListName, "Name of the SVDShaperDigits list", string(""));
  addParam("shutUpFTBError", m_shutUpFTBError,
           "if >0 is the number of reported FTB header ERRORs before quiet operations. If <0 full log produced.", -1);
  addParam("FADCTriggerNumberOffset", m_FADCTriggerNumberOffset,
           "number to be added to the FADC trigger number to match the main trigger number", 0);
  addParam("svdDAQDiagnosticsListName", m_svdDAQDiagnosticsListName, "Name of the DAQDiagnostics  list", string(""));
  addParam("softwarePipelineAddressEmulation", m_emulatePipelineAddress, "Estimate emulated pipeline address", bool(true));
  addParam("killDigitsFromUpsetAPVs", m_killUpsetDigits, "Delete digits from upset APVs", bool(false));
  addParam("silentlyAppend", m_silentAppend, "Append digits to a pre-existing non-empty storeArray", bool(false));
  addParam("badMappingFatal", m_badMappingFatal, "Throw B2FATAL if there's a wrong payload in the database", bool(false));
  addParam("UnpackerErrorRate", m_errorRate, "Unpacker will print one error every UnpackerErrorRate", int(1000));
  addParam("PrintRawData", m_printRaw, "Printing Raw data words for debugging", bool(false));
}

~SVDUnpackerModule()

~SVDUnpackerModule ( )

virtual

Destructor of the module.

Definition at line 70 of file SVDUnpackerModule.cc.

{
}

Member Function Documentation

beginRun()

void beginRun ( void  )

overridevirtual

begin run

Reimplemented from Module.

Definition at line 91 of file SVDUnpackerModule.cc.

{
  if (!m_mapping.isValid())
    B2FATAL("no valid SVD Channel Mapping. We stop here.");
 
  m_wrongFTBcrc = 0;
  if (m_mapping.hasChanged()) { m_map = std::make_unique<SVDOnlineToOfflineMap>(m_mapping->getFileName()); }
 
  if (! m_map) { //give up
    B2ERROR("SVD xml map not loaded." << std::endl <<
            "No SVDShaperDigit will be produced for this run!");
    return;
  }
 
  //number of FADC boards
  nFADCboards = m_map->getFADCboardsNumber();
 
  //passing APV<->FADC mapping from SVDOnlineToOfflineMap object
  APVmap = &(m_map->APVforFADCmap);
 
  //setting UnpackerErrorRate factor to use it for BadMapping error suppression
  m_map->setErrorRate(m_errorRate);
 
  nTriggerMatchErrors = -1;
  nEventMatchErrors = -1;
  nUpsetAPVsErrors = -1;
  nErrorFieldErrors = -1;
  nMissingAPVsErrors = -1;
  nFADCMatchErrors = -1;
  nAPVErrors = -1;
  nFTBFlagsErrors = -1;
  nEventInfoMatchErrors = -1;
 
  seenHeadersAndTrailers = 0;
 
  //get the relative time shift
  if (!m_svdGlobalConfig.isValid())
    B2FATAL("SVDGlobalConfigParameters not valid!!");
 
  m_relativeTimeShift = m_svdGlobalConfig->getRelativeTimeShift();
 
}

clone()

std::shared_ptr< PathElement > clone ( ) const

overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

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

def_beginRun()

virtual void def_beginRun ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

{ beginRun(); }

def_endRun()

virtual void def_endRun ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

{ endRun(); }

def_event()

virtual void def_event ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

{ event(); }

def_initialize()

virtual void def_initialize ( )

inlineprotectedvirtualinherited

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

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

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

{ initialize(); }

def_terminate()

virtual void def_terminate ( )

inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

{ terminate(); }

endRun()

void endRun ( void  )

overridevirtual

end run

Reimplemented from Module.

Definition at line 637 of file SVDUnpackerModule.cc.

{
  // Summary report on missing APVs
  if (m_missingAPVs.size() > 0) {
    B2WARNING("SVDUnpacker summary 1: Missing APVs");
    for (const auto& miss : m_missingAPVs)
      B2WARNING(LogVar("Missing APV", miss.first.second) << LogVar("FADC", miss.first.first) << LogVar("since event",
                miss.second.first) << LogVar("to event", miss.second.second));
  }
  if (m_upsetAPVs.size() > 0) {
    B2WARNING("SVDUnpacker summary 2: Upset APVs");
    for (const auto& upst : m_upsetAPVs)
      B2WARNING(LogVar("Upset APV", upst.first.second) << LogVar("FADC", upst.first.first) <<
                LogVar("since event", upst.second.first) << LogVar("to event", upst.second.second));
  }
}

evalCondition()

bool evalCondition ( ) const

inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns

True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

{
  if (m_conditions.empty()) return false;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return true;
    }
  }
  return false;
}

event()

void event ( void  )

overridevirtual

event

Reimplemented from Module.

Definition at line 138 of file SVDUnpackerModule.cc.

{
  if (!m_rawSVD || !m_rawSVD.getEntries())
    return;
 
  if (!m_silentAppend && m_storeShaperDigits && m_storeShaperDigits.getEntries())
    B2WARNING("Unpacking SVDShaperDigits to a non-empty pre-existing \n"
              << "StoreArray. This can lead to undesired behaviour. At least\n"
              << "remember to use SVDShaperDigitSorter in your path and \n"
              << "set the silentlyAppend parameter of SVDUnpacker to true.");
 
  SVDDAQDiagnostic* currentDAQDiagnostic;
  vector<SVDDAQDiagnostic*> vDiagnostic_ptr;
 
  map<SVDShaperDigit, SVDDAQDiagnostic*> diagnosticMap;
  // Store encountered pipeline addresses with APVs in which they were observed
  map<unsigned short, set<pair<unsigned short, unsigned short> > > apvsByPipeline;
 
  if (!m_eventMetaDataPtr.isValid()) {  // give up...
    B2ERROR("Missing valid EventMetaData." << std::endl << "No SVDShaperDigit produced for this event!");
    return;
  }
 
  bool nAPVmatch = true;
  bool badMapping = false;
  bool badHeader = false;
  bool badTrailer = false;
  bool missedHeader = false;
  bool missedTrailer = false;
 
  // flag to set SVDEventInfo once per event
  bool isSetEventInfo = false;
 
  //flag to set nAPVsamples in SVDEventInfo once per event
  bool isSetNAPVsamples = false;
 
  unsigned short nAPVheaders = 999;
  set<short> seenAPVHeaders = {};
 
  unsigned short nEntries_rawSVD = m_rawSVD.getEntries();
  auto eventNo = m_eventMetaDataPtr->getEvent();
 
  short fadc = 255, apv = 63;
 
  unsigned short cntFADCboards = 0;
  for (unsigned int i = 0; i < nEntries_rawSVD; i++) {
 
    unsigned int numEntries_rawSVD = m_rawSVD[ i ]->GetNumEntries();
    for (unsigned int j = 0; j < numEntries_rawSVD; j++) {
 
      const unsigned short maxNumOfCh = m_rawSVD[i]->GetMaxNumOfCh(j);
 
      std::vector<unsigned short> nWords;
      nWords.reserve(maxNumOfCh);
      uint32_t*      data32tab[maxNumOfCh]; //vector of pointers
      for (unsigned int k = 0; k < maxNumOfCh; k++) {
        nWords.push_back(m_rawSVD[i]->GetDetectorNwords(j, k));
        data32tab[k] = (uint32_t*)m_rawSVD[i]->GetDetectorBuffer(j, k); // points at the begining of the 1st buffer
      }
 
      unsigned short ftbError = 0;
      unsigned short trgType = 0;
      unsigned short trgNumber = 0;
      unsigned short daqMode = -1;
      unsigned short daqType = 0;
      unsigned short cmc1;
      unsigned short cmc2;
      unsigned short apvErrors;
      unsigned short pipAddr;
      unsigned short ftbFlags = 0;
      unsigned short apvErrorsOR = 0;
 
      bool is3sampleData = false;
      bool is6sampleData = false;
 
      for (unsigned int buf = 0; buf < maxNumOfCh; buf++) { // loop over 4(COPPER) or 48(PCIe40) buffers
 
        if (data32tab[buf] == nullptr || nWords.at(buf) == 0) {
          if (data32tab[buf] != nullptr || nWords.at(buf) != 0) {
            B2WARNING("Invalid combination of buffer pointer and nWords:" <<
                      LogVar("COPPER/PCIe40 ID", i) <<
                      LogVar("COPPER/PCIe40 Entry", j) <<
                      LogVar("COPPER/PCIe40 Channel", buf) <<
                      LogVar("data32tab[buf]", data32tab[buf]) <<
                      LogVar("nWords[buf]", nWords.at(buf)));
          }
          continue;
        }
        if (m_printRaw) printB2Debug(data32tab[buf], data32tab[buf], &data32tab[buf][nWords.at(buf) - 1], nWords.at(buf));
 
        cntFADCboards++;
 
        missedHeader = false;
        missedTrailer = false;
 
        uint32_t* data32_it = data32tab[buf];
        short strip, sample[6];
        vector<uint32_t> crc16vec;
 
        //reset value for headers and trailers check
        seenHeadersAndTrailers = 0;
 
        for (; data32_it != &data32tab[buf][nWords.at(buf)]; data32_it++) {
          m_data32 = *data32_it; //put current 32-bit frame to union
 
          if (m_data32 == 0xffaa0000) {   // first part of FTB header
            crc16vec.clear(); // clear the input container for crc16 calculation
            crc16vec.push_back(m_data32);
 
            seenHeadersAndTrailers |= 0x1; // we found FTB header
 
            data32_it++; // go to 2nd part of FTB header
            crc16vec.push_back(*data32_it);
 
            m_data32 = *data32_it; //put the second 32-bit frame to union
 
            ftbError = m_FTBHeader.errorsField;
 
            if (ftbError != 240) {
              nErrorFieldErrors++;
 
              if (!(nErrorFieldErrors % m_errorRate) or nErrorFieldErrors < 100) {
                switch (ftbError - 240) {
                  case 3:
                    B2ERROR("FADC Event Number is different from (FTB & TTD) Event Numbers");
                    break;
                  case 5:
                    B2ERROR("TTD Event Number is different from (FTB & FADC) Event Numbers");
                    break;
                  case 6:
                    B2ERROR("FTB Event Number is different from (TTD & FADC) Event Numbers");
                    break;
                  case 7:
                    B2ERROR("(FTB, TTD & FADC) Event Numbers are different from each other");
                    break;
                  default:
                    B2ERROR("Problem with errorsField variable in FTB Header" << LogVar("abnormal value", ftbError));
                }
              }
            }
 
            if (m_FTBHeader.eventNumber !=
                (eventNo & 0xFFFFFF)) {
              nEventMatchErrors++;
              if (m_shutUpFTBError && !(nEventMatchErrors % m_errorRate)) { //
                m_shutUpFTBError -= 1;
                B2ERROR("Event number mismatch detected! The event number given by EventMetaData object is different from the one in the FTB Header."
                        << LogVar("Expected event number & 0xFFFFFF",
                                  (eventNo & 0xFFFFFF)) << LogVar("Event number in the FTB", m_FTBHeader.eventNumber));
              }
            }
 
            continue;
          } // is FTB Header
 
          crc16vec.push_back(m_data32);
 
          if (m_MainHeader.check == 6) { // FADC header
 
            seenHeadersAndTrailers |= 0x2; //we found FADC Header
 
            fadc = m_MainHeader.FADCnum;
            trgType = m_MainHeader.trgType;
            trgNumber = m_MainHeader.trgNumber;
            daqMode = m_MainHeader.DAQMode;
            daqType = m_MainHeader.DAQType;
 
            //Let's add run-dependent info: daqMode="11" in case of 3-mixed-6 sample acquisition mode.
            if (daqType) daqMode = 3;
 
            nAPVheaders = 0; // start counting APV headers for this FADC
            nAPVmatch = true; //assume correct # of APV headers
            badMapping = false; //assume correct mapping
            badHeader = false;
            badTrailer = false;
 
            is3sampleData = false;
            is6sampleData = false;
 
            if (daqMode == 0) B2ERROR("SVDDataFormatCheck: the event " << eventNo <<
                                        " is apparently taken with 1-sample mode, this is not expected.");
            if (daqMode == 1) is3sampleData = true;
            if (daqMode == 2) is6sampleData = true;
 
            if (
              m_MainHeader.trgNumber !=
              ((eventNo - m_FADCTriggerNumberOffset) & 0xFF)) {
 
              nTriggerMatchErrors++;
              if (!(nTriggerMatchErrors % m_errorRate))
                B2ERROR("Event number mismatch detected! The event number given by EventMetaData object is different from the one in the FADC Header. "
                        << LogVar("Event number", eventNo) << LogVar("FADC", fadc) << LogVar("Trigger number LSByte reported by the FADC",
                            m_MainHeader.trgNumber) << LogVar("+ offset", m_FADCTriggerNumberOffset) << LogVar("expected", (eventNo & 0xFF)));
              badHeader = true;
            }
 
            // create SVDModeByte object from MainHeader vars
            m_SVDModeByte = SVDModeByte(m_MainHeader.runType, 0, daqMode, m_MainHeader.trgTiming);
 
            // create SVDEventInfo and fill it with SVDModeByte & SVDTriggerType objects
            if (!isSetEventInfo) {
              m_SVDTriggerType = SVDTriggerType(trgType);
              m_svdEventInfoPtr.create();
              m_svdEventInfoPtr->setModeByte(m_SVDModeByte);
              m_svdEventInfoPtr->setTriggerType(m_SVDTriggerType);
              m_svdEventInfoPtr->setAPVClock(m_hwClock);
 
              //set relative time shift
              m_svdEventInfoPtr->setRelativeShift(m_relativeTimeShift);
              // set X-talk info online from Raw Data
              m_svdEventInfoPtr->setCrossTalk(m_MainHeader.xTalk);
 
              isSetEventInfo = true;
            } else {  // let's check if the current SVDModeByte and SVDTriggerType are consistent with the one stored in SVDEventInfo
              if (m_SVDModeByte !=  m_svdEventInfoPtr->getModeByte())  {m_svdEventInfoPtr->setMatchModeByte(false); badHeader = true; nEventInfoMatchErrors++;}
              if (trgType != (m_svdEventInfoPtr->getTriggerType()).getType()) { m_svdEventInfoPtr->setMatchTriggerType(false);  badHeader = true; nEventInfoMatchErrors++;}
            }
          } // is FADC header
 
          if (m_APVHeader.check == 2) { // APV header
 
            nAPVheaders++;
            apv = m_APVHeader.APVnum;
            seenAPVHeaders.insert(apv);
 
            cmc1 = m_APVHeader.CMC1;
            cmc2 = m_APVHeader.CMC2;
            apvErrors = m_APVHeader.apvErr;
            pipAddr = m_APVHeader.pipelineAddr;
 
            if (apvErrors != 0) {
              nAPVErrors++;
              if (!(nAPVErrors % m_errorRate)
                  or nAPVErrors < 100) B2ERROR("APV error has been detected." << LogVar("FADC", fadc) << LogVar("APV", apv) << LogVar("Error value",
                                                 apvErrors));
            }
            // temporary SVDDAQDiagnostic object (no info from trailers and APVmatch code)
            currentDAQDiagnostic = m_storeDAQDiagnostics.appendNew(trgNumber, trgType, pipAddr, cmc1, cmc2, apvErrors, ftbError, true,
                                                                   nAPVmatch,
                                                                   badHeader, missedHeader, missedTrailer,
                                                                   fadc, apv);
            vDiagnostic_ptr.push_back(currentDAQDiagnostic);
 
            apvsByPipeline[pipAddr].insert(make_pair(fadc, apv));
          } //is APV Header
 
          if (m_data_A.check == 0) { // data
            strip = m_data_A.stripNum;
 
            sample[0] = m_data_A.sample1;
            sample[1] = m_data_A.sample2;
            sample[2] = m_data_A.sample3;
 
            sample[3] = 0;
            sample[4] = 0;
            sample[5] = 0;
 
            // Let's check the next rawdata word to determine if we acquired 3 or 6 sample
            data32_it++;
            m_data32 = *data32_it;
 
            if (m_data_B.check == 0 && strip == m_data_B.stripNum) { // 2nd data frame with the same strip number -> six samples
 
              if (!isSetNAPVsamples) {
                m_svdEventInfoPtr->setNSamples(6);
                isSetNAPVsamples = true;
              } else {
                if (is3sampleData)
                  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!");
              }
 
              crc16vec.push_back(m_data32);
 
              sample[3] = m_data_B.sample4;
              sample[4] = m_data_B.sample5;
              sample[5] = m_data_B.sample6;
            }
 
            else { // three samples
              data32_it--;
              m_data32 = *data32_it;
 
              if (!isSetNAPVsamples) {
                m_svdEventInfoPtr->setNSamples(3);
                isSetNAPVsamples = true;
              } else {
                if (is6sampleData)
                  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!");
              }
            }
 
            // Generating SVDShaperDigit object
            SVDShaperDigit* newShaperDigit = m_map->NewShaperDigit(fadc, apv, strip, sample, 0.0);
            if (newShaperDigit) {
              diagnosticMap.insert(make_pair(*newShaperDigit, currentDAQDiagnostic));
              delete newShaperDigit;
            } else if (m_badMappingFatal) {
              B2FATAL("Respective FADC/APV combination not found -->> incorrect payload in the database! ");
            } else {
              badMapping = true;
            }
 
          }  //is data frame
 
 
          if (m_FADCTrailer.check == 14)  { // FADC trailer
 
            seenHeadersAndTrailers |= 0x4; // we found FADC trailer
 
            //additional check if we have a faulty/fake FADC that is not in the map
            if (APVmap->find(fadc) == APVmap->end()) badMapping = true;
 
            //comparing number of APV chips and the number of APV headers, for the current FADC
            unsigned short nAPVs = APVmap->count(fadc);
 
            if (nAPVheaders == 0) {
              currentDAQDiagnostic = m_storeDAQDiagnostics.appendNew(0, 0, 0, 0, 0, 0, ftbError, true, nAPVmatch, badHeader, 0, 0, fadc, 0);
              vDiagnostic_ptr.push_back(currentDAQDiagnostic);
            }
 
            if (nAPVs != nAPVheaders) {
              // There is an APV missing, detect which it is.
              for (const auto& fadcApv : *APVmap) {
                if (fadcApv.first != fadc) continue;
                if (seenAPVHeaders.find(fadcApv.second) == seenAPVHeaders.end()) {
                  // We have a missing APV. Look if it is a known one.
                  auto missingRec = m_missingAPVs.find(make_pair(fadcApv.first, fadcApv.second));
                  if (missingRec != m_missingAPVs.end()) {
                    // This is known to be missing, so keep quiet and just update event counters
                    if (missingRec->second.first > eventNo)
                      missingRec->second.first = eventNo;
                    if (missingRec->second.second < eventNo)
                      missingRec->second.second = eventNo;
                  } else {
                    // We haven't seen this previously.
                    nMissingAPVsErrors++;
                    m_missingAPVs.insert(make_pair(
                                           make_pair(fadcApv.first, fadcApv.second),
                                           make_pair(eventNo, eventNo)
                                         ));
                    if (!(nMissingAPVsErrors % m_errorRate)) B2ERROR("missing APV header! " << LogVar("Event number", eventNo) << LogVar("APV",
                                                                       int(fadcApv.second)) << LogVar("FADC",
                                                                           int(fadcApv.first)));
                  }
                }
              }
              nAPVmatch = false;
            } // is nAPVs != nAPVheaders
 
            seenAPVHeaders.clear();
 
            ftbFlags = m_FADCTrailer.FTBFlags;
            if ((ftbFlags >> 5) != 0) badTrailer = true;
            if (ftbFlags != 0) {
              nFTBFlagsErrors++;
              if (!(nFTBFlagsErrors % m_errorRate) or nFTBFlagsErrors < 100) {
                B2ERROR(" FTB Flags variable has an active error bit(s)" << LogVar("on FADC number", fadc));
 
                if (ftbFlags & 16) B2ERROR("----> CRC error has been detected. Data might be corrupted!");
                if (ftbFlags & 8) B2ERROR("----> Bad Event indication has been detected. Data might be corrupted!");
                if (ftbFlags & 4) B2ERROR("----> Double Header has been detected. Data might be corrupted!");
                if (ftbFlags & 2) B2ERROR("----> Time Out has been detected. Data might be corrupted!");
                if (ftbFlags & 1) B2ERROR("----> Event Too Long! Data might be corrupted!");
              }
            }
 
            apvErrorsOR = m_FADCTrailer.apvErrOR;
 
 
          }// is FADC trailer
 
          if (m_FTBTrailer.controlWord == 0xff55)  {// FTB trailer
 
            seenHeadersAndTrailers |= 0x8; // we found FTB trailer
 
            //check CRC16
            crc16vec.pop_back();
            unsigned short iCRC = crc16vec.size();
            std::vector<uint32_t> crc16input;
            crc16input.reserve(iCRC);
 
            for (unsigned short icrc = 0; icrc < iCRC; icrc++)
              crc16input.push_back(htonl(crc16vec.at(icrc)));
 
            //verify CRC16
            boost::crc_basic<16> bcrc(0x8005, 0xffff, 0, false, false);
            bcrc.process_bytes(crc16input.data(), crc16input.size() * sizeof(uint32_t));
            unsigned int checkCRC = bcrc.checksum();
 
            if (checkCRC != m_FTBTrailer.crc16) {
              B2WARNING("FTB CRC16 checksum DOES NOT MATCH" << LogVar("for FADC no.", fadc));
              m_wrongFTBcrc++;
            }
 
          } // is FTB trailer
 
        } // end loop over 32-bit frames in each buffer
 
        //Let's check if all the headers and trailers were in place in the last frame
        if (seenHeadersAndTrailers != 0xf) {
          if (!(seenHeadersAndTrailers & 1)) {B2ERROR("Missing FTB Header is detected. SVD data might be corrupted!" << LogVar("Event number", eventNo) << LogVar("FADC", fadc)); missedHeader = true;}
          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;}
          if (!(seenHeadersAndTrailers & 4)) {B2ERROR("Missing FADC Trailer is detected. SVD data might be corrupted!" << LogVar("Event number", eventNo) << LogVar("FADC", fadc)); missedTrailer = true;}
          if (!(seenHeadersAndTrailers & 8)) {B2ERROR("Missing FTB Trailer is detected. SVD data might be corrupted!" << LogVar("Event number", eventNo) << LogVar("FADC", fadc)); missedTrailer = true;}
        }
 
        for (auto p : vDiagnostic_ptr) {
          // adding remaining info to Diagnostic object
          p->setFTBFlags(ftbFlags);
          p->setApvErrorOR(apvErrorsOR);
          p->setAPVMatch(nAPVmatch);
          p->setBadMapping(badMapping);
          p->setBadTrailer(badTrailer);
          p->setMissedHeader(missedHeader);
          p->setMissedTrailer(missedTrailer);
        }
 
        vDiagnostic_ptr.clear();
 
      } // end iteration on 4(COPPER)/48(PCIe40) data buffers
 
    } // end event loop
 
  }// end loop over RawSVD objects
 
  // Check the number of FADC boards
  if (cntFADCboards != nFADCboards) { // nFADCboards=52
    nFADCMatchErrors++;
    if (!(nFADCMatchErrors % m_errorRate))  B2ERROR("Number of data objects in rawSVD do not match the number of FADC boards" <<
                                                      LogVar("# of data objects in rawSVD",
                                                             cntFADCboards)  << LogVar("# of FADCs", nFADCboards) << LogVar("Event number", eventNo));
 
    // We override all FADCMatch fields in diagnostics and set it to false.
    for (auto& p : m_storeDAQDiagnostics) {
      p.setFADCMatch(false);
    }
  }
 
  // Detect upset APVs and report/treat
  auto major_apv = max_element(apvsByPipeline.begin(), apvsByPipeline.end(),
                               [](const decltype(apvsByPipeline)::value_type & p1,
                                  const decltype(apvsByPipeline)::value_type & p2) -> bool
  { return p1.second.size() < p2.second.size(); }
                              );
  // We set emuPipelineAddress fields in diagnostics to this.
  if (m_emulatePipelineAddress)
    for (auto& p : m_storeDAQDiagnostics)
      p.setEmuPipelineAddress(major_apv->first);
  // And report any upset apvs or update records
  if (apvsByPipeline.size() > 1)
    for (const auto& p : apvsByPipeline) {
      if (p.first == major_apv->first) continue;
      for (const auto& fadcApv : p.second) {
        // We have an upset APV. Look if it is a known one.
        auto upsetRec = m_upsetAPVs.find(make_pair(fadcApv.first, fadcApv.second));
        if (upsetRec != m_upsetAPVs.end()) {
          // This is known to be upset, so keep quiet and update event counters
          if (upsetRec->second.first > eventNo)
            upsetRec->second.first = eventNo;
          if (upsetRec->second.second < eventNo)
            upsetRec->second.second = eventNo;
        } else {
          // We haven't seen this one previously.
          nUpsetAPVsErrors++;
          m_upsetAPVs.insert(make_pair(
                               make_pair(fadcApv.first, fadcApv.second),
                               make_pair(eventNo, eventNo)
                             ));
          for (auto& pp : m_storeDAQDiagnostics) {
 
            if (pp.getFADCNumber() == fadcApv.first and pp.getAPVNumber() == fadcApv.second)
              pp.setUpsetAPV(true);
          }
          if (!(nUpsetAPVsErrors % m_errorRate)) B2ERROR("Upset APV detected!!!" << LogVar("APV", int(fadcApv.second)) << LogVar("FADC",
                                                           int(fadcApv.first)) << LogVar("Event number", eventNo));
        }
      }
    }
 
  // Here we can delete digits coming from upset APVs. We detect them by comparing
  // actual and emulated pipeline address fields in DAQDiagnostics.
  for (auto& p : diagnosticMap) {
 
    if ((m_killUpsetDigits && p.second->getPipelineAddress() != p.second->getEmuPipelineAddress()) || p.second->getFTBError() != 240
        || p.second->getFTBFlags()     || p.second->getAPVError() || !(p.second->getAPVMatch()) || !(p.second->getFADCMatch())
        || p.second->getBadHeader()
        ||  p.second->getBadMapping() || p.second->getUpsetAPV() || p.second->getMissedHeader() || p.second->getMissedTrailer()) continue;
    m_storeShaperDigits.appendNew(p.first);
  }
 
  if (!m_svdEventInfoPtr->getMatchTriggerType()) {if (!(nEventInfoMatchErrors % m_errorRate) or nEventInfoMatchErrors < 200) B2WARNING("Inconsistent SVD Trigger Type value for: " << LogVar("Event number", eventNo));}
  if (!m_svdEventInfoPtr->getMatchModeByte())  {if (!(nEventInfoMatchErrors % m_errorRate) or nEventInfoMatchErrors < 200) B2WARNING("Inconsistent SVD ModeByte object for: " << LogVar("Event number", eventNo));}
 
 
} //end event function

exposePythonAPI()

void exposePythonAPI ( )

staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

{
  // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
  namespace bp = boost::python;
 
  docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
 
  void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
 
  enum_<Module::EAfterConditionPath>("AfterConditionPath",
                                     R"(Determines execution behaviour after a conditional path has been executed:
 
.. attribute:: END
 
  End processing of this path after the conditional path. (this is the default for if_value() etc.)
 
.. attribute:: CONTINUE
 
  After the conditional path, resume execution after this module.)")
  .value("END", Module::EAfterConditionPath::c_End)
  .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
  ;
 
  /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
  enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
  .value(">", Belle2::ModuleCondition::EConditionOperators::c_GT)
  .value("<", Belle2::ModuleCondition::EConditionOperators::c_ST)
  .value(">=", Belle2::ModuleCondition::EConditionOperators::c_GE)
  .value("<=", Belle2::ModuleCondition::EConditionOperators::c_SE)
  .value("==", Belle2::ModuleCondition::EConditionOperators::c_EQ)
  .value("!=", Belle2::ModuleCondition::EConditionOperators::c_NE)
  ;
 
  enum_<Module::EModulePropFlags>("ModulePropFlags",
                                  R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
 
.. attribute:: PARALLELPROCESSINGCERTIFIED
 
    This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
 
.. attribute:: HISTOGRAMMANAGER
 
  This module is used to manage histograms accumulated by other modules
 
.. attribute:: TERMINATEINALLPROCESSES
 
  When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
)")
  .value("INPUT", Module::EModulePropFlags::c_Input)
  .value("OUTPUT", Module::EModulePropFlags::c_Output)
  .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
  .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
  .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
  .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
  ;
 
  //Python class definition
  class_<Module, PyModule> module("Module", R"(
Base class for Modules.
 
A module is the smallest building block of the framework.
A typical event processing chain consists of a Path containing
modules. By inheriting from this base class, various types of
modules can be created. To use a module, please refer to
:func:`Path.add_module()`.  A list of modules is available by running
``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
given by e.g. ``basf2 -m RootInput``.
 
The 'Module Development' section in the manual provides detailed information
on how to create modules, setting parameters, or using return values/conditions:
https://xwiki.desy.de/xwiki/rest/p/f4fa4/#HModuleDevelopment
 
)");
  module
  .def("__str__", &Module::getPathString)
  .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
       "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
  .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
       "Returns the type of the module (i.e. class name minus 'Module')")
  .def("set_name", &Module::setName, args("name"), R"(
Set custom name, e.g. to distinguish multiple modules of the same type.
 
>>> path.add_module('EventInfoSetter')
>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
>>> ro.set_name('RootOutput_metadata_only')
>>> print(path)
[EventInfoSetter -> RootOutput_metadata_only]
 
)")
  .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
       "Returns the description of this module.")
  .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
       "Returns the package this module belongs to.")
  .def("available_params", &_getParamInfoListPython,
       "Return list of all module parameters as `ModuleParamInfo` instances")
  .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
       R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
 
>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
>>>     ...
 
Parameters:
  properties (int): bitmask of `ModulePropFlags` to check for.
)DOCSTRING")
  .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
       "Set module properties in the form of an OR combination of `ModulePropFlags`.");
  {
    // python signature is too crowded, make ourselves
    docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
    module
    .def("if_value", &Module::if_value,
         (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this
module if the return value set in the module passes the given ``expression``.
 
Modules can define a return value (int or bool) using ``setReturnValue()``,
which can be used in the steering file to split the Path based on this value, for example
 
>>> module_with_condition.if_value("<1", another_path)
 
In case the return value of the ``module_with_condition`` for a given event is
less than 1, the execution will be diverted into ``another_path`` for this event.
 
You could for example set a special return value if an error occurs, and divert
the execution into a path containing :b2:mod:`RootOutput` if it is found;
saving only the data producing/produced by the error.
 
After a conditional path has executed, basf2 will by default stop processing
the path for this event. This behaviour can be changed by setting the
``after_condition_path`` argument.
 
Parameters:
  expression (str): Expression to determine if the conditional path should be executed.
      This should be one of the comparison operators ``<``, ``>``, ``<=``,
      ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
  condition_path (Path): path to execute in case the expression is fulfilled
  after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
)DOCSTRING")
    .def("if_false", &Module::if_false,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to False. This is equivalent to
calling `if_value` with ``expression=\"<1\"``)DOC")
    .def("if_true", &Module::if_true,
         (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
         R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
 
Sets a conditional sub path which will be executed after this module if
the return value of the module evaluates to True. It is equivalent to
calling `if_value` with ``expression=\">=1\"``)DOC");
  }
  module
  .def("has_condition", &Module::hasCondition,
       "Return true if a conditional path has been set for this module "
       "using `if_value`, `if_true` or `if_false`")
  .def("get_all_condition_paths", &_getAllConditionPathsPython,
       "Return a list of all conditional paths set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .def("get_all_conditions", &_getAllConditionsPython,
       "Return a list of all conditional path expressions set for this module using "
       "`if_value`, `if_true` or `if_false`")
  .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
                &Module::setLogConfig)

getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const

inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

{
  if (m_conditions.empty()) return EAfterConditionPath::c_End;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getAfterConditionPath();
    }
  }
 
  return EAfterConditionPath::c_End;
}

getAllConditionPaths()

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

inherited

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

Definition at line 150 of file Module.cc.

{
  std::vector<std::shared_ptr<Path>> allConditionPaths;
  for (const auto& condition : m_conditions) {
    allConditionPaths.push_back(condition.getPath());
  }
 
  return allConditionPaths;
}

getAllConditions()

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

inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

    {
      return m_conditions;
    }

getCondition()

const ModuleCondition * getCondition ( ) const

inlineinherited

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

Definition at line 314 of file Module.h.

    {
      if (m_conditions.empty()) {
        return nullptr;
      } else {
        return &m_conditions.front();
      }
    }

getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const

inherited

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

Definition at line 113 of file Module.cc.

{
  PathPtr p;
  if (m_conditions.empty()) return p;
 
  //okay, a condition was set for this Module...
  if (!m_hasReturnValue) {
    B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
  }
 
  for (const auto& condition : m_conditions) {
    if (condition.evaluate(m_returnValue)) {
      return condition.getPath();
    }
  }
 
  // if none of the conditions were true, return a null pointer.
  return p;
}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

{return m_description;}

getFileNames()

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

inlinevirtualinherited

Return a list of output filenames for this modules.

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

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

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

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

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

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

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

getLogConfig()

LogConfig & getLogConfig ( )

inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

{return m_logConfig;}

getModules()

std::list< ModulePtr > getModules ( ) const

inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

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

getName()

const std::string & getName ( ) const

inlineinherited

Returns the name of the module.

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

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

Definition at line 187 of file Module.h.

{return m_name;}

getPackage()

const std::string & getPackage ( ) const

inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

{return m_package;}

getParamInfoListPython()

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

inherited

Returns a python list of all parameters.

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

Returns

A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

{
  return m_moduleParamList.getParamInfoListPython();
}

getParamList()

const ModuleParamList & getParamList ( ) const

inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

{ return m_moduleParamList; }

getPathString()

std::string getPathString ( ) const

overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

getReturnValue()

int getReturnValue ( ) const

inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

{ return m_returnValue; }

getType()

const std::string & getType ( ) const

inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

hasCondition()

bool hasCondition ( ) const

inlineinherited

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

Definition at line 311 of file Module.h.

{ return not m_conditions.empty(); };

hasProperties()

bool hasProperties ( unsigned int  propertyFlags ) const

inherited

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

Parameters

propertyFlags

Ored EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

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

hasReturnValue()

bool hasReturnValue ( ) const

inlineinherited

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

Definition at line 378 of file Module.h.

{ return m_hasReturnValue; }

hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const

inherited

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

Definition at line 166 of file Module.cc.

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

if_false()

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

inherited

A simplified version to add a condition to the module.

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

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

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

Parameters

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

Definition at line 85 of file Module.cc.

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

if_true()

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

inherited

A simplified version to set the condition of the module.

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

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

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

Parameters

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

Definition at line 90 of file Module.cc.

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

if_value()

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

inherited

Add a condition to the module.

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

See https://xwiki.desy.de/xwiki/rest/p/a94f2 or ModuleCondition for a description of the syntax.

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

Parameters

expression	The expression of the condition.
path	Shared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPath	What to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

initialize()

void initialize ( void  )

overridevirtual

Initializes the Module.

initialize

Reimplemented from Module.

Definition at line 74 of file SVDUnpackerModule.cc.

{
  m_eventMetaDataPtr.isRequired();
  // Don't panic if no SVD data.
  m_rawSVD.isOptional(m_rawSVDListName);
 
  // Register default SVDEventInfo for unpacking Raw Data
  m_svdEventInfoPtr.registerInDataStore(m_svdEventInfoName, DataStore::c_ErrorIfAlreadyRegistered);
 
  m_storeDAQDiagnostics.registerInDataStore(m_svdDAQDiagnosticsListName);
  m_svdDAQDiagnosticsListName = m_storeDAQDiagnostics.getName();
 
  m_storeShaperDigits.registerInDataStore(m_svdShaperDigitListName);
  m_svdShaperDigitListName = m_storeShaperDigits.getName();
 
}

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.

{
 
  uint32_t* min = std::max((data32 - nWords), data32_min);
  uint32_t* max = std::min((data32 + nWords), data32_max);
 
  size_t counter{0};
  std::stringstream os;
  os << std::hex << std::setfill('0');
  for (uint32_t* ptr = min; ptr <= max; ++ptr) {
    os << std::setw(8) << *ptr;
    if (++counter % 10 == 0) os << std::endl;
    else os << " ";
  }
 
  os << std::endl;
  B2INFO(os.str());
  return;
 
}

setAbortLevel()

void setAbortLevel ( int  abortLevel )

inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

{
  m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
}

setDebugLevel()

void setDebugLevel ( int  debugLevel )

inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

{
  m_logConfig.setDebugLevel(debugLevel);
}

setDescription()

void setDescription ( const std::string &  description )

protectedinherited

Sets the description of the module.

Parameters

description

A description of the module.

Definition at line 214 of file Module.cc.

{
  m_description = description;
}

setLogConfig()

void setLogConfig ( const LogConfig &  logConfig )

inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

{m_logConfig = logConfig;}

setLogInfo()

void setLogInfo ( int  logLevel, unsigned int  logInfo  )

inherited

Configure the printed log information for the given level.

Parameters

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

Definition at line 73 of file Module.cc.

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

setLogLevel()

void setLogLevel ( int  logLevel )

inherited

Configure the log level.

Definition at line 55 of file Module.cc.

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

setName()

void setName ( const std::string &  name )

inlineinherited

Set the name of the module.

Note

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

Parameters

name	The name of the module

Definition at line 214 of file Module.h.

{ m_name = name; };

setParamList()

void setParamList ( const ModuleParamList &  params )

inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

{ m_moduleParamList = params; }

setParamPython()

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

privateinherited

Implements a method for setting boost::python objects.

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

Parameters

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

Definition at line 234 of file Module.cc.

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

setParamPythonDict()

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

privateinherited

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

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

Parameters

dictionary

The python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

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

setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags )

inherited

Sets the flags for the module properties.

Parameters

propertyFlags

bitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

{
  m_propertyFlags = propertyFlags;
}

setReturnValue() [1/2]

void setReturnValue ( bool  value )

protectedinherited

Sets the return value for this module as bool.

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

Parameters

value

The value of the return value.

Definition at line 227 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setReturnValue() [2/2]

void setReturnValue ( int  value )

protectedinherited

Sets the return value for this module as integer.

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

Parameters

value

The value of the return value.

Definition at line 220 of file Module.cc.

{
  m_hasReturnValue = true;
  m_returnValue = value;
}

setType()

void setType ( const std::string &  type )

protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

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.

{};

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:

• svd/modules/svdUnpacker/include/SVDUnpackerModule.h
• svd/modules/svdUnpacker/src/SVDUnpackerModule.cc