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

#include <SVDUnpackerModule.h>

Inheritance diagram for SVDUnpackerModule:

Collaboration diagram for SVDUnpackerModule:

[legend]

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

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

virtual void	terminate ()
	This method is called at the end of the event processing. More...

const std::string &	getName () const
	Returns the name of the module. More...

const std::string &	getType () const
	Returns the type of the module (i.e. More...

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

void	setPropertyFlags (unsigned int propertyFlags)
	Sets the flags for the module properties. More...

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

void	if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	Add a condition to the module. More...

void	if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to add a condition to the module. More...

void	if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
	A simplified version to set the condition of the module. More...

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

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). More...

Module::EAfterConditionPath	getAfterConditionPath () const
	What to do after the conditional path is finished. More...

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

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

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

std::shared_ptr< PathElement >	clone () const override
	Create an independent copy of this module. More...

std::shared_ptr< boost::python::list >	getParamInfoListPython () const
	Returns a python list of all parameters. More...

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

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

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

void	setType (const std::string &type)
	Set the module type. More...

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

template<typename T >
void	addParam (const std::string &name, T &paramVariable, const std::string &description)
	Adds a new enforced parameter to the module. More...

void	setReturnValue (int value)
	Sets the return value for this module as integer. More...

void	setReturnValue (bool value)
	Sets the return value for this module as bool. More...

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

void	setParamPythonDict (const boost::python::dict &dictionary)
	Implements a method for reading the parameter values from a boost::python dictionary. More...

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.

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.

};

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

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

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

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

Member Function Documentation

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

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

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

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

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

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

◆ 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 RootOutputModule, StorageRootOutputModule, and RootInputModule.

Definition at line 134 of file Module.h.

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

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

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

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

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

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

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

inherited

Add a condition to the module.

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

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

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

Parameters

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.

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

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

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

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

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

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

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

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

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

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

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

Definition at line 176 of file Module.h.

Member Data Documentation

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

◆ nTriggerMatchErrors

int nTriggerMatchErrors

private

counters for specific ERRORS produced by the Unpacker

counter of Trigger match errors

Definition at line 222 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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EModulePropFlags

Member Function Documentation

◆ clone()

◆ def_endRun()

◆ def_initialize()

◆ evalCondition()

◆ getAfterConditionPath()

◆ getConditionPath()

◆ getFileNames()

◆ getName()

◆ getParamInfoListPython()

◆ getReturnValue()

◆ getType()

◆ hasProperties()

◆ if_false()

◆ if_true()

◆ if_value()

◆ initialize()

◆ setDescription()

◆ setLogInfo()

◆ setName()

◆ setParamPython()

◆ setParamPythonDict()

◆ setPropertyFlags()

◆ setReturnValue() [1/2]

◆ setReturnValue() [2/2]

◆ setType()

◆ terminate()

Member Data Documentation

◆ m_emulatePipelineAddress

◆ m_silentAppend

◆ nTriggerMatchErrors