Belle II Software development
|
SVDPackerModule: The SVD Raw Hits Creator. More...
#include <SVDPackerModule.h>
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 | DataInfo |
6 samples and APV channel struct 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 | |
SVDPackerModule () | |
default constructor | |
virtual | ~SVDPackerModule () |
default destructor | |
virtual void | initialize () override |
initialize | |
virtual void | beginRun () override |
begin run | |
virtual void | event () override |
event | |
virtual void | endRun () override |
end run | |
virtual void | terminate () override |
terminate | |
virtual std::vector< std::string > | getFileNames (bool outputFiles) |
Return a list of output filenames for this modules. | |
const std::string & | getName () const |
Returns the name of the module. | |
const std::string & | getType () const |
Returns the type of the module (i.e. | |
const std::string & | getPackage () const |
Returns the package this module is in. | |
const std::string & | getDescription () const |
Returns the description of the module. | |
void | setName (const std::string &name) |
Set the name of the module. | |
void | setPropertyFlags (unsigned int propertyFlags) |
Sets the flags for the module properties. | |
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_svdEventInfoName |
SVDEventInfo name. | |
bool | m_simulate3sampleData |
if true, simulate 3-sample data taking | |
bool | m_binPrintout |
if true, print data created by the Packer | |
uint32_t | data32 |
Output 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 ¶mVariable, const std::string &description, const T &defaultValue) |
Adds a new parameter to the module. | |
template<typename T > | |
void | addParam (const std::string &name, T ¶mVariable, 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 ¶ms) |
Replace existing parameter list. | |
Private Types | |
typedef std::unordered_map< unsigned short, unsigned short > | FADCmap |
type def for the FADC map | |
Private Member Functions | |
void | addData32 (uint32_t adata32) |
adds packed 32-bit data word to the raw data vector | |
void | binPrintout (unsigned int nwords) |
tool: print out N 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 | |
int | n_basf2evt |
event number | |
int | m_nodeid |
Node ID. | |
DBObjPtr< PayloadFile > | m_mapping |
channel map payload | |
std::unique_ptr< SVDOnlineToOfflineMap > | m_map |
Pointer to online-to-offline map. | |
FADCmap | FADCnumberMap |
maps containing assignment (0,1,2,3,4,..,nFADCboards-1) <-> FADC numbers | |
FADCmap | FADCnumberMapRev |
maps containing assignment (0,1,2,3,4,..,nFADCboards-1) <-> FADC numbers | |
std::vector< uint32_t > | data_words |
vector of raw data words | |
struct Belle2::SVD::SVDPackerModule::DataInfo | dataInfo |
data info | |
union { | |
uint32_t data32 | |
Output 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 from simulation. | |
StoreArray< RawSVD > | m_rawSVD |
output for RawSVD | |
StoreArray< SVDShaperDigit > | m_svdShaperDigit |
Required input for SVDShaperDigit. | |
int | m_FADCTriggerNumberOffset |
FADC trigger numnber offset. | |
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 | |
SVDPackerModule: The SVD Raw Hits Creator.
This module produces SVD Raw Data from simulated SVDShaperDigits
Definition at line 37 of file SVDPackerModule.h.
|
inherited |
Forward the EAfterConditionPath definition from the ModuleCondition.
|
private |
type def for the FADC map
Definition at line 65 of file SVDPackerModule.h.
|
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.
SVDPackerModule | ( | ) |
default constructor
Definition at line 43 of file SVDPackerModule.cc.
|
virtual |
|
inlineprivate |
adds packed 32-bit data word to the raw data vector
Definition at line 89 of file SVDPackerModule.h.
|
overridevirtual |
begin run
Reimplemented from Module.
Definition at line 81 of file SVDPackerModule.cc.
|
private |
tool: print out N words
Definition at line 369 of file SVDPackerModule.cc.
|
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.
|
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.
|
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.
|
inlineprotectedvirtualinherited |
|
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.
|
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.
|
overridevirtual |
|
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().
Definition at line 96 of file Module.cc.
|
overridevirtual |
event
Reimplemented from Module.
Definition at line 101 of file SVDPackerModule.cc.
|
staticinherited |
Exposes methods of the Module class to Python.
Definition at line 325 of file Module.cc.
|
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.
|
inherited |
|
inlineinherited |
Return all set conditions for this module.
|
inlineinherited |
|
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.
|
inlineinherited |
Returns the description of the module.
Definition at line 202 of file Module.h.
|
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.
|
inlineinherited |
|
inlineoverrideprivatevirtualinherited |
no submodules, return empty list
Implements PathElement.
Definition at line 506 of file Module.h.
|
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.
|
inlineinherited |
|
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.
Definition at line 279 of file Module.cc.
|
inlineinherited |
|
overrideprivatevirtualinherited |
return the module name.
Implements PathElement.
Definition at line 192 of file Module.cc.
|
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.
|
inherited |
Returns the type of the module (i.e.
class name minus 'Module')
|
inlineinherited |
|
inherited |
Returns true if all specified property flags are available in this module.
propertyFlags | Ored EModulePropFlags which should be compared with the module flags. |
|
inlineinherited |
|
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.
|
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.
path | Shared pointer to the Path which will be executed if the return value is false. |
afterConditionPath | What to do after executing 'path'. |
|
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.
path | Shared pointer to the Path which will be executed if the return value is true. |
afterConditionPath | What to do after executing 'path'. |
|
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.
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'. |
|
overridevirtual |
initialize
Reimplemented from Module.
Definition at line 71 of file SVDPackerModule.cc.
|
inherited |
Configure the abort log level.
Definition at line 67 of file Module.cc.
|
inherited |
Configure the debug messaging level.
Definition at line 61 of file Module.cc.
|
protectedinherited |
Sets the description of the module.
description | A description of the module. |
|
inlineinherited |
Set the log system configuration.
Definition at line 230 of file Module.h.
|
inherited |
Configure the printed log information for the given level.
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.
|
inherited |
Configure the log level.
|
inlineinherited |
|
inlineprotectedinherited |
Replace existing parameter list.
Definition at line 501 of file Module.h.
|
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.
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.
|
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.
dictionary | The python dictionary from which the parameter values are read. |
Definition at line 249 of file Module.cc.
|
inherited |
Sets the flags for the module properties.
propertyFlags | bitwise OR of EModulePropFlags |
|
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.
value | The value of the return 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.
value | The value of the return value. |
|
protectedinherited |
Set the module type.
Only for use by internal modules (which don't use the normal REG_MODULE mechanism).
|
overridevirtual |
|
private |
pointer to APVforFADCmap filled by mapping procedure
Definition at line 71 of file SVDPackerModule.h.
uint32_t data32 |
Output 32-bit data word.
Definition at line 174 of file SVDPackerModule.h.
|
private |
vector of raw data words
Definition at line 86 of file SVDPackerModule.h.
|
private |
maps containing assignment (0,1,2,3,4,..,nFADCboards-1) <-> FADC numbers
Definition at line 82 of file SVDPackerModule.h.
|
private |
maps containing assignment (0,1,2,3,4,..,nFADCboards-1) <-> FADC numbers
Definition at line 84 of file SVDPackerModule.h.
APVHeader m_APVHeader |
Implementation of APV Header.
Definition at line 177 of file SVDPackerModule.h.
bool m_binPrintout |
if true, print data created by the Packer
Definition at line 60 of file SVDPackerModule.h.
|
privateinherited |
data_A m_data_A |
Implementation of 1st data word.
Definition at line 178 of file SVDPackerModule.h.
data_B m_data_B |
Implementation of 2nd data word.
Definition at line 179 of file SVDPackerModule.h.
|
privateinherited |
|
private |
Required input for EventMetaData.
Definition at line 184 of file SVDPackerModule.h.
FADCTrailer m_FADCTrailer |
Implementation of FADC Trailer.
Definition at line 180 of file SVDPackerModule.h.
|
private |
FADC trigger numnber offset.
Definition at line 188 of file SVDPackerModule.h.
FTBHeader m_FTBHeader |
Implementation of FTB Header.
Definition at line 175 of file SVDPackerModule.h.
FTBTrailer m_FTBTrailer |
Implementation of FTB Trailer.
Definition at line 181 of file SVDPackerModule.h.
|
privateinherited |
|
privateinherited |
MainHeader m_MainHeader |
Implementation of FADC Header.
Definition at line 176 of file SVDPackerModule.h.
|
private |
Pointer to online-to-offline map.
Definition at line 79 of file SVDPackerModule.h.
|
private |
channel map payload
Definition at line 77 of file SVDPackerModule.h.
|
privateinherited |
|
privateinherited |
|
private |
Node ID.
Definition at line 74 of file SVDPackerModule.h.
|
privateinherited |
|
privateinherited |
|
private |
output for RawSVD
Definition at line 186 of file SVDPackerModule.h.
std::string m_rawSVDListName |
RawSVD StoreArray name.
Definition at line 56 of file SVDPackerModule.h.
bool m_simulate3sampleData |
if true, simulate 3-sample data taking
Definition at line 59 of file SVDPackerModule.h.
std::string m_svdEventInfoName |
SVDEventInfo name.
Definition at line 58 of file SVDPackerModule.h.
|
private |
SVDEventInfo from simulation.
Definition at line 185 of file SVDPackerModule.h.
|
private |
Required input for SVDShaperDigit.
Definition at line 187 of file SVDPackerModule.h.
std::string m_svdShaperDigitListName |
SVDShaperDigit StoreArray name.
Definition at line 57 of file SVDPackerModule.h.
|
privateinherited |
|
staticprivate |
< xml filename
Definition at line 76 of file SVDPackerModule.h.
|
private |
event number
Definition at line 73 of file SVDPackerModule.h.
|
private |
how many FADCs we have
Definition at line 68 of file SVDPackerModule.h.