Belle II Software  release-08-01-10
TOPTBCComparatorModule Class Reference

Module for the comparison of different sets of time base correction (TBC) constants and to produce monitoring plots out of a given set. More...

#include <TOPTBCComparatorModule.h>

Inheritance diagram for TOPTBCComparatorModule:
Collaboration diagram for TOPTBCComparatorModule:

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

 TOPTBCComparatorModule ()
 Constructor.
 
 ~TOPTBCComparatorModule ()
 Destructor.
 
void defineHisto () override
 Defining the histograms. More...
 
void initialize () override
 Initialize the module.
 
void beginRun () override
 Called when entering a new run.
 
void event () override
 Event processor.
 
void endRun () override
 End-of-run action. More...
 
void terminate () override
 Termination action. More...
 
int analyzeCalFile ()
 Analyzes the calibrations stored in the file m_calSetFile. More...
 
int makeComparisons ()
 Last function to be called, compared the histograms of different datasets filled by analyzeCalFile() Every new comparison histogram added to the module has to be filled here.
 
int parseSlotAndScrodIDfromFileName (std::string)
 Utility function to parse the slot and BS id from the calibration file names.
 
int parseInputDirectoryLine (std::string)
 Utility function to get the directory name and the label from a line of the m_inputDirectoryList file Sets the values of m_calSetDirectory and m_calSetLabel.
 
TH1F * calculateHistoRatio (TH1F *, TH1F *, TH1F *)
 Utility function to take the ratio of two histograms using TH1::Divide(), without overwriting the output name and title initialized in defineHisto().
 
TH2F * calculateHistoRatio (TH2F *, TH2F *, TH2F *)
 Utility function to take the ratio of two histograms using TH2::Divide(), without overwriting the output name and title initialized in defineHisto().
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules. 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...
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level. 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 ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true. More...
 
std::shared_ptr< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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.
 

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

std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects. More...
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary. More...
 

Private Attributes

std::string m_inputDirectoryList
 List of the directories (one per IOV) in which the files with the calibration constants of the SCODS are stored (i.e. More...
 
bool m_compareToPreviousSet
 Determines if the reverence set for the ratio is the first CalSet of the list (if false) or if each CalSet is compared to the previous one (if true) More...
 
std::string m_outputFile = ""
 File in which the output histograms are stored.
 
short m_minCalPulses = 200
 Minimum number of calpulses to declare a sample as non-empty.
 
short m_numSamples = 256
 Number of samples that have been calibrated.
 
std::string m_calSetDirectory
 Label to be used to indetify the histograms of a the calibration set.
 
TFile * m_calSetFile
 File containing the calibration constants of the SCROD being analyzed. More...
 
std::string m_calSetLabel
 Label to be used to identify the histograms of a the calibration set.
 
short m_slotID = -1
 ID of the slot whose calibrations are being analyzed.
 
short m_boardstackID = -1
 ID of the slot whose calibrations are being analyzed.
 
short m_scrodID = -1
 ID of the scrod whose calibrations are being analyzed.
 
short m_calSetID = 0
 Internal ID of the calibration set that is being analyzed.
 
short m_totCalSets = 0
 Total number of calibration sets, as counted int defineHistos.
 
std::vector< TH1F * > m_slotAverageDeltaT [16]
 Average of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number.
 
std::vector< TH1F * > m_slotSigmaDeltaT [16]
 Standard deviation of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number.
 
std::vector< TH2F * > m_slotAverageDeltaTMap [16]
 Map of the average of the DeltaT (time difference petween the calibraiton pulses) distribution.
 
std::vector< TH2F * > m_slotSigmaDeltaTMap [16]
 Map of the Standard deviation of the DeltaT (time difference petween the calibraiton pulses) distribution.
 
std::vector< TH1F * > m_topAverageDeltaT
 Average of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number on the whole detector.
 
std::vector< TH1F * > m_topSigmaDeltaT
 Standard deviation of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number on the whole detector.
 
std::vector< TH1F * > m_slotSampleOccupancy [16]
 Average number of calpulses per sample used in the minimization, as function of the channel number.
 
std::vector< TH1F * > m_slotEmptySamples [16]
 Number of (semi-)empty samples in each channel.
 
std::vector< TH2F * > m_slotSampleOccupancyMap [16]
 Map of the average number of calpulses per sample used in the minimizat on.
 
std::vector< TH2F * > m_slotEmptySamplesMap [16]
 Map of the number of (semi-)empty samples.
 
std::vector< TH1F * > m_topSampleOccupancy
 Average number of calpulses per sample used in the minimization, as function of the channel number on the whole detector.
 
std::vector< TH1F * > m_slotAverageDeltaTComparison [16]
 Ratio of the average of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number.
 
std::vector< TH1F * > m_slotSigmaDeltaTComparison [16]
 Ratio of the Standard deviation of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number.
 
std::vector< TH2F * > m_slotAverageDeltaTMapComparison [16]
 Map of the Ratio of the average DeltaT (time difference petween the calibraiton pulses)
 
std::vector< TH2F * > m_slotSigmaDeltaTMapComparison [16]
 Map of Ratio of the Standard deviation on DeltaT (time difference petween the calibraiton pulses)
 
std::vector< TH1F * > m_topAverageDeltaTComparison
 Average of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number on the whole detector.
 
std::vector< TH1F * > m_topSigmaDeltaTComparison
 Standard deviation of the DeltaT (time difference petween the calibraiton pulses) distribution, as function of the channel number on the whole detector.
 
std::vector< TH1F * > m_topSampleOccupancyComparison
 Ratios of the average sample occupancy on the whole detector.
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

Module for the comparison of different sets of time base correction (TBC) constants and to produce monitoring plots out of a given set.

1) Input format The input constants are given in the histogram format provided by the TOPTimeCalibrator module. According to the current (2017) TBC production standards, all the root files belonging to the same calibration set must be locaded in one single directory, with no more than one level of subdirectories. An example of a valid directory stucture for the input is:

CalibrationSetRootFolder/tbc_ch0/ tbc_ch1/ tbc_ch2/ ... tbc_ch7/

where the root files are located under tbc_chX/ The module is sensitive to the name format of the input files, since slot, BS and scrod ID are parsed from them. The naming is tbcSlotXX_Y-scrodZZZ.root, where XX is the slot number, Y is the BS number, and ZZZ is the scrodID. Both 2- and 3-digits scrodID are allowed.

To specify the calibration sets to be analyzed and compared, the user must provide a text file containing the absolute path to the CalibrationSetRootFolder, and a label to identify the calibration set. Separate sets are specified on separate lines of this configuration file:

/absolute/path/to/CalibrationSetRootFolder1/ LabelSet1 /absolute/path/to/CalibrationSetRootFolder2/ LabelSet2 /absolute/path/to/CalibrationSetRootFolder3/ LabelSet3

2) Basic functions

  • The output histograms are declared as private members, and are initialized in the defineHisto() function
  • The main loop that runs over all the datasets and all the rootfiles is implemented in endRun(), that calls the two main functions of this module, analyzeCalFile() and makeComparisons().
  • First all the calset-by-calset histograms are filled, then the comparisons are done by taking ratios of these histograms
  • The output writing is done in the terminate() function
  • The histogram filling is performed in the analyzeFile() function, called in the main loop over the calibration sets inside endRun().
  • The histogram comparison is performed in the makeComparisons() function, called in endRun() outside the main loop over the calibration sets.

3) How to add a new histogram

4) How to add a new comparison histogram

  • Create an histogram array (hQuantity) that saves the quantity you want calset-by-calset, and fill it in analyzeCalFile()
  • Create an histogram to save the comparson (hQuantityCom), and fill it in the makeComparisons() usig the hQuantity histograms. You can use the calculateHistoRatio() utility to do that.

Definition at line 72 of file TOPTBCComparatorModule.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
propertyFlagsOred 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
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

◆ if_value()

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

Add a condition to the module.

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

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

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

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

Definition at line 79 of file Module.cc.

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

◆ setName()

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

Set the name of the module.

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

Definition at line 214 of file Module.h.

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 234 of file Module.cc.

◆ setParamPythonDict()

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

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

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

Parameters
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

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

Member Data Documentation

◆ m_calSetFile

TFile* m_calSetFile
private
Initial value:
=
nullptr

File containing the calibration constants of the SCROD being analyzed.

Definition at line 172 of file TOPTBCComparatorModule.h.

◆ m_compareToPreviousSet

bool m_compareToPreviousSet
private
Initial value:
=
true

Determines if the reverence set for the ratio is the first CalSet of the list (if false) or if each CalSet is compared to the previous one (if true)

Definition at line 163 of file TOPTBCComparatorModule.h.

◆ m_inputDirectoryList

std::string m_inputDirectoryList
private
Initial value:
=
""

List of the directories (one per IOV) in which the files with the calibration constants of the SCODS are stored (i.e.

the output of the TBC production module)

Definition at line 161 of file TOPTBCComparatorModule.h.


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