Belle II Software development
TRGTOPWaveformPlotterModule Class Reference
Inheritance diagram for TRGTOPWaveformPlotterModule:
Module PathElement

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

 TRGTOPWaveformPlotterModule ()
 Constructor.
 
virtual ~TRGTOPWaveformPlotterModule ()
 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.
 
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.
 
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 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.
 
std::shared_ptr< PathgetConditionPath () 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 ModuleParamListgetParamList () 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< PathElementclone () 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.
 

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

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.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

TCanvas * m_myCanvas [NUMBER_OF_TOP_SLOTS]
 TDirectory.
 
TGraph * m_timeStampsGraphMainReadout [NUMBER_OF_TOP_SLOTS]
 
TGraph * m_timeStampsGraphTriggerReadout [NUMBER_OF_TOP_SLOTS]
 
TMultiGraph * m_myMultiGraph [NUMBER_OF_TOP_SLOTS]
 
TPaveText * m_myPaveText [NUMBER_OF_TOP_SLOTS]
 
Int_t m_timeStampsMainReadout [NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
 
Int_t m_timeStampsTriggerReadout [NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
 
Int_t m_clockCyclesMainReadout [NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
 
Int_t m_clockCyclesTriggerReadout [NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
 
int m_plottingMode
 
double m_markerSizeHits
 
double m_markerSizeTimestamps
 
int m_markerTypeHits
 
int m_markerTypeTimestamps
 
int m_firstAssumedClockCycle
 
int m_cutPlotMinNumberTriggerReadoutHits
 
int m_cutPlotMinNumberMainReadoutHits
 
int m_xMin
 
int m_xMax
 
int m_yMin
 
int m_yMax
 
int m_showGridx
 
int m_showGridy
 
int m_canvasXMin
 
int m_canvasYMin
 
int m_canvasXSize
 
int m_canvasYSize
 
int m_shiftCanvas
 
int m_xShiftCanvas
 
int m_yShiftCanvas
 
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

Definition at line 56 of file TRGTOPWaveformPlotterModule.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

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

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

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

c_HistogramManager 

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

c_InternalSerializer 

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

c_TerminateInAllProcesses 

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

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

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ TRGTOPWaveformPlotterModule()

Constructor.

Definition at line 49 of file TRGTOPWaveformPlotterModule.cc.

50{
51
52 setDescription("TRGTOP Waveform Plotter");
53
55
56 // Parameter definitions
57
58 addParam("plottingMode", m_plottingMode,
59 "Plotting mode: 0 (forced ranges for x and y), 1 (slot-level zoom-in), 2 (global zoom-in; default), 3 (global zoom-in for y and xmax, forced left-side edge for x), 4 (global zoom-in for y, forced range for x), anything else (full ranges)",
60 2);
61
62 addParam("firstAssumedClockCycle", m_firstAssumedClockCycle,
63 "First assumed clock cycle for main readout hits",
64 108);
65
66 addParam("cutPlotMinNumberTriggerReadoutHits", m_cutPlotMinNumberTriggerReadoutHits,
67 "Minimum number of trigger timestamps cut for drawing the waveform",
68 5);
69
70 addParam("cutPlotMinNumberMainReadoutHits", m_cutPlotMinNumberMainReadoutHits,
71 "Minimum number of main readout hits cut for drawing the hits",
72 5);
73
74 addParam("markerSizeHits", m_markerSizeHits,
75 "Marker size (default: 0.85) used to plot main readout hits",
76 0.85);
77
78 addParam("markerSizeTimestamps", m_markerSizeTimestamps,
79 "Marker size (default: 0.65) used to plot trigger readout timestamps",
80 0.65);
81
82 addParam("markerTypeHits", m_markerTypeHits,
83 "Marker type (default: 21) used to plot main readout hits",
84 21);
85
86 addParam("markerTypeTimestamps", m_markerTypeTimestamps,
87 "Marker type (default: 20) used to plot trigger readout timestamps",
88 20);
89
90 addParam("xMin", m_xMin,
91 "xMin for plotting (default: 100)",
92 100);
93
94 addParam("xMax", m_xMax,
95 "xMax for plotting (default: 200)",
96 200);
97
98 addParam("yMin", m_yMin,
99 "yMin for plotting (default: 0)",
100 0);
101
102 addParam("yMax", m_yMax,
103 "yMax for plotting (default: 47000)",
104 47000);
105
106 addParam("showGridx", m_showGridx,
107 "Show grid x (default: 0 (no))",
108 0);
109
110 addParam("showGridy", m_showGridy,
111 "Show grid y (default: 1 (yes))",
112 1);
113
114 addParam("canvasXMin", m_canvasXMin,
115 "TCanvas x min (default: 0))",
116 0);
117
118 addParam("canvasYMin", m_canvasYMin,
119 "TCanvas y min (default: 0))",
120 0);
121
122 addParam("canvasXSize", m_canvasXSize,
123 "TCanvas x size (default: 900))",
124 900);
125
126 addParam("canvasYSize", m_canvasYSize,
127 "TCanvas y size (default: 600))",
128 600);
129
130 addParam("shiftCanvas", m_shiftCanvas,
131 "Shift canvases (default: 1 (yes)))",
132 1);
133
134 addParam("xShiftCanvas", m_xShiftCanvas,
135 "x shift canvases (default: 900))",
136 910);
137
138 addParam("yShiftCanvas", m_yShiftCanvas,
139 "y shift canvases (default: 600))",
140 610);
141
142}
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
Module()
Constructor.
Definition: Module.cc:30
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:559

◆ ~TRGTOPWaveformPlotterModule()

virtual ~TRGTOPWaveformPlotterModule ( )
inlinevirtual

Destructor.

Definition at line 63 of file TRGTOPWaveformPlotterModule.h.

63{}

Member Function Documentation

◆ beginRun()

void beginRun ( void  )
overridevirtual

begin Run

Reimplemented from Module.

Definition at line 144 of file TRGTOPWaveformPlotterModule.cc.

145{
146
147 // myROOTDir->cd();
148
149 // oldROOTDir->cd();
150
151}

◆ clone()

std::shared_ptr< PathElement > clone ( ) const
overridevirtualinherited

Create an independent copy of this module.

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

Implements PathElement.

Definition at line 179 of file Module.cc.

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:362
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:186
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:511
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:513
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:520
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:509
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 425 of file Module.h.

425{ beginRun(); }
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:146

◆ 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 438 of file Module.h.

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

◆ 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 431 of file Module.h.

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

◆ 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 419 of file Module.h.

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

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

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

Reimplemented in PyModule.

Definition at line 444 of file Module.h.

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

◆ endRun()

void endRun ( void  )
overridevirtual

End Run.

Reimplemented from Module.

Definition at line 174 of file TRGTOPWaveformPlotterModule.cc.

175{
176
177}

◆ evalCondition()

bool evalCondition ( ) const
inherited

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

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

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

Definition at line 96 of file Module.cc.

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:518
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:517

◆ event()

void event ( void  )
overridevirtual

Event.

Reimplemented from Module.

Definition at line 179 of file TRGTOPWaveformPlotterModule.cc.

180{
181
182 // oldROOTDir = gDirectory;
183 // myROOTDir->cd();
184
185 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) {
186
187 //
188 // The code below assumes that none of the higher-level object (such as TCanvas) own any of the embedded objects (such as TGraph's)
189 //
190
191 if (m_timeStampsGraphMainReadout[slot - 1]) {
192 delete m_timeStampsGraphMainReadout[slot - 1];
193 m_timeStampsGraphMainReadout[slot - 1] = NULL;
194 }
195
196 if (m_timeStampsGraphTriggerReadout[slot - 1]) {
197 delete m_timeStampsGraphTriggerReadout[slot - 1];
198 m_timeStampsGraphTriggerReadout[slot - 1] = NULL;
199 }
200
201 if (m_myMultiGraph[slot - 1]) {
202 delete m_myMultiGraph[slot - 1];
203 m_myMultiGraph[slot - 1] = NULL;
204 }
205
206 if (m_myPaveText[slot - 1]) {
207 delete m_myPaveText[slot - 1];
208 m_myPaveText[slot - 1] = NULL;
209 }
210
211 if (m_myCanvas[slot - 1]) {
212 delete m_myCanvas[slot - 1];
213 m_myCanvas[slot - 1] = NULL;
214 }
215
216 }
217
218 // TOP timestamps made from TOPRawDigits
219 StoreArray<TRGTOPTimeStamp> trgtopTimeStamps("TRGTOPTimeStamps");
220 StoreArray<TRGTOPTimeStampsSlot> trgtopTimeStampsSlots("TRGTOPTimeStampsSlots");
221
222 // TRG TOP waveform readout
223 StoreArray<TRGTOPWaveFormTimeStamp> trgtopWaveFormTimeStamps("TRGTOPWaveFormTimeStamps");
224 StoreArray<TRGTOPWaveFormTimeStampsSlot> trgtopWaveFormTimeStampsSlots("TRGTOPWaveFormTimeStampsSlots");
225
226 // TOP TRG slot-level t0 decisions
227 StoreArray<TRGTOPSlotTiming> trgtopSlotTimingAll("TRGTOPSlotTimings");
228
229 // ISim results for main readout (for all slots and all decisions for each slot)
230 StoreArray<TRGTOPTimingISim> trgtopTimingISimMainReadoutAll("TRGTOPTimingISimMainReadouts");
231
232 // ISim results for trigger readout (for all slots and all decisions for each slot)
233 StoreArray<TRGTOPTimingISim> trgtopTimingISimTriggerReadoutAll("TRGTOPTimingISimTriggerReadouts");
234
235
236 // if (!trgtopWaveFormTimeStamps) return;
237 // if (!trgtopWaveFormTimeStampsSlots) return;
238
239 // ISim results for main readout hits
240
241 bool topTRGISimMRODecisionPresent[NUMBER_OF_TOP_SLOTS] = {false};
242 int topTRGISimMRODecisionTiming[NUMBER_OF_TOP_SLOTS] = {0};
243 int topTRGISimMRODecisionNTS[NUMBER_OF_TOP_SLOTS] = {0};
244 int topTRGISimMRODecisionNumber[NUMBER_OF_TOP_SLOTS] = {0};
245
246 std::string topTRGIsimMRODecisionText[NUMBER_OF_TOP_SLOTS];
247 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) topTRGIsimMRODecisionText[slot - 1] = "All iSim TOP decisions: ";
248
249 for (const auto& slotDecision : trgtopTimingISimMainReadoutAll) {
250
251 int slot = slotDecision.getSlotId();
252
253 topTRGISimMRODecisionPresent[slot - 1] = true;
254 topTRGISimMRODecisionTiming[slot - 1] = slotDecision.getSlotTiming();
255 topTRGISimMRODecisionNTS[slot - 1] = topTRGISimMRODecisionNTS[slot - 1] + slotDecision.getSlotNHits();
256 topTRGISimMRODecisionNumber[slot - 1] = topTRGISimMRODecisionNumber[slot - 1] + 1;
257
258 std::stringstream ss1;
259 ss1 << slotDecision.getSlotNHits();
260 std::stringstream ss2;
261 ss2 << slotDecision.getSlotTiming();
262 std::stringstream ss3;
263 ss3 << slotDecision.getSlotDecisionClockCycle();
264 topTRGIsimMRODecisionText[slot - 1] = topTRGIsimMRODecisionText[slot - 1] + " " + ss2.str() + " ( " + ss1.str() + " [" + ss3.str() +
265 "]" + " ); ";
266
267 }
268
269 // ISim results for trigger readout hits
270
271 bool topTRGISimWFRODecisionPresent[NUMBER_OF_TOP_SLOTS] = {false};
272 int topTRGISimWFRODecisionTiming[NUMBER_OF_TOP_SLOTS] = {0};
273 int topTRGISimWFRODecisionNTS[NUMBER_OF_TOP_SLOTS] = {0};
274 int topTRGISimWFRODecisionNumber[NUMBER_OF_TOP_SLOTS] = {0};
275
276 std::string topTRGIsimWFRODecisionText[NUMBER_OF_TOP_SLOTS];
277 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) topTRGIsimWFRODecisionText[slot - 1] = "All iSim TRG decisions: ";
278
279 for (const auto& slotDecision : trgtopTimingISimTriggerReadoutAll) {
280
281 int slot = slotDecision.getSlotId();
282
283 topTRGISimWFRODecisionPresent[slot - 1] = true;
284 topTRGISimWFRODecisionTiming[slot - 1] = slotDecision.getSlotTiming();
285 topTRGISimWFRODecisionNTS[slot - 1] = topTRGISimWFRODecisionNTS[slot - 1] + slotDecision.getSlotNHits();
286 topTRGISimWFRODecisionNumber[slot - 1] = topTRGISimWFRODecisionNumber[slot - 1] + 1;
287
288 std::stringstream ss1;
289 ss1 << slotDecision.getSlotNHits();
290 std::stringstream ss2;
291 ss2 << slotDecision.getSlotTiming();
292 std::stringstream ss3;
293 ss3 << slotDecision.getSlotDecisionClockCycle();
294 topTRGIsimWFRODecisionText[slot - 1] = topTRGIsimWFRODecisionText[slot - 1] + " " + ss2.str() + " ( " + ss1.str() + " [" + ss3.str()
295 + "]" + " ); ";
296
297 }
298
299 // slot-level online trigger decisions
300
301 bool topTRGDecisionPresent[NUMBER_OF_TOP_SLOTS] = {false};
302 int topTRGDecisionTiming[NUMBER_OF_TOP_SLOTS] = {0};
303 int topTRGDecisionNTS[NUMBER_OF_TOP_SLOTS] = {0};
304 int topTRGDecisionNumber[NUMBER_OF_TOP_SLOTS] = {0};
305 // int topTRGDecisionClockCycle[NUMBER_OF_TOP_SLOTS] = {0};
306
307 std::string topTRGDecisionText[NUMBER_OF_TOP_SLOTS];
308 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) topTRGDecisionText[slot - 1] = "All online TRG decisions: ";
309
310 for (const auto& slotDecision : trgtopSlotTimingAll) {
311
312 // for purposes of visualization do not display information received from the OTHER board
313 if (slotDecision.isThisBoard()) {
314
315 int slot = slotDecision.getSlotId();
316
317 topTRGDecisionPresent[slot - 1] = true;
318 topTRGDecisionTiming[slot - 1] = slotDecision.getSlotTiming();
319 topTRGDecisionNTS[slot - 1] = topTRGDecisionNTS[slot - 1] + slotDecision.getSlotNHits();
320 // topTRGDecisionClockCycle[slot-1] = slotDecision.getSlotDecisionClockCycle();
321 topTRGDecisionNumber[slot - 1] = topTRGDecisionNumber[slot - 1] + 1;
322
323 std::stringstream ss1;
324 ss1 << slotDecision.getSlotNHits();
325 std::stringstream ss2;
326 ss2 << slotDecision.getSlotTiming() / 2;
327 std::stringstream ss3;
328 ss3 << slotDecision.getSlotDecisionClockCycle();
329 topTRGDecisionText[slot - 1] = topTRGDecisionText[slot - 1] + " " + ss2.str() + " ( " + ss1.str() + " [" + ss3.str() + "]" + " ); ";
330
331 }
332 }
333
334 // main readout
335
336 bool topTRGMROPresent[NUMBER_OF_TOP_SLOTS] = {false};
337 int topTRGMRONTS[NUMBER_OF_TOP_SLOTS] = {0};
338
339 int clockCycleMainReadout[NUMBER_OF_TOP_SLOTS] = {0};
340 int indexClockCycleMainReadout[NUMBER_OF_TOP_SLOTS] = {0};
341
342 int xMinMRO[NUMBER_OF_TOP_SLOTS] = {0};
343 int xMaxMRO[NUMBER_OF_TOP_SLOTS] = {0};
344
345 int yMinMRO[NUMBER_OF_TOP_SLOTS] = {0};
346 int yMaxMRO[NUMBER_OF_TOP_SLOTS] = {0};
347
348 for (const auto& slotTSS : trgtopTimeStampsSlots) {
349
350 int slot = slotTSS.getSlotId();
351
352 clockCycleMainReadout[slot - 1] = m_firstAssumedClockCycle;
353
354 xMinMRO[slot - 1] = -1;
355 xMaxMRO[slot - 1] = -1;
356
357 yMinMRO[slot - 1] = -1;
358 yMaxMRO[slot - 1] = -1;
359
360 int nHits = slotTSS.getNumberOfTimeStamps();
361
362 if (nHits != 0) {
363
364 topTRGMROPresent[slot - 1] = true;
365 topTRGMRONTS[slot - 1] = nHits;
366
367 if (topTRGMRONTS[slot - 1] > MAX_NUMBER_OF_CLOCK_CYCLES) topTRGMRONTS[slot - 1] = MAX_NUMBER_OF_CLOCK_CYCLES;
368
369 for (const auto& timeStamp : slotTSS.getRelationsTo<TRGTOPTimeStamp>()) {
370 int value = timeStamp.getTimeStamp();
371
372 m_clockCyclesMainReadout[slot - 1][indexClockCycleMainReadout[slot - 1]] = clockCycleMainReadout[slot - 1];
373 m_timeStampsMainReadout[slot - 1][indexClockCycleMainReadout[slot - 1]] = value;
374
375 if (xMinMRO[slot - 1] == -1
376 || clockCycleMainReadout[slot - 1] < xMinMRO[slot - 1]) xMinMRO[slot - 1] = clockCycleMainReadout[slot - 1];
377 if (xMaxMRO[slot - 1] == -1
378 || clockCycleMainReadout[slot - 1] > xMaxMRO[slot - 1]) xMaxMRO[slot - 1] = clockCycleMainReadout[slot - 1];
379
380 if (yMinMRO[slot - 1] == -1 || value < yMinMRO[slot - 1]) yMinMRO[slot - 1] = value;
381 if (yMaxMRO[slot - 1] == -1 || value > yMaxMRO[slot - 1]) yMaxMRO[slot - 1] = value;
382
383 if (indexClockCycleMainReadout[slot - 1] < MAX_NUMBER_OF_CLOCK_CYCLES) {
384 indexClockCycleMainReadout[slot - 1]++;
385 clockCycleMainReadout[slot - 1]++;
386 }
387 }
388 }
389 }
390
391 // waveform readout
392
393 bool topTRGWFROPresent[NUMBER_OF_TOP_SLOTS] = {false};
394 int topTRGWFRONTS[NUMBER_OF_TOP_SLOTS] = {0};
395
396 int clockCycleTriggerReadout[NUMBER_OF_TOP_SLOTS] = {0};
397 int indexClockCycleTriggerReadout[NUMBER_OF_TOP_SLOTS] = {0};
398
399 int xMinWFRO[NUMBER_OF_TOP_SLOTS] = {0};
400 int xMaxWFRO[NUMBER_OF_TOP_SLOTS] = {0};
401
402 int yMinWFRO[NUMBER_OF_TOP_SLOTS] = {0};
403 int yMaxWFRO[NUMBER_OF_TOP_SLOTS] = {0};
404
405 for (auto& slotWaveFormTSS : trgtopWaveFormTimeStampsSlots) {
406
407 int slot = slotWaveFormTSS.getSlotId();
408
409 xMinWFRO[slot - 1] = -1;
410 xMaxWFRO[slot - 1] = -1;
411
412 yMinWFRO[slot - 1] = -1;
413 yMaxWFRO[slot - 1] = -1;
414
415 int nHits = slotWaveFormTSS.getNumberOfActualTimeStamps();
416
417 if (nHits != 0) {
418
419 topTRGWFROPresent[slot - 1] = true;
420 topTRGWFRONTS[slot - 1] = nHits;
421
422 if (topTRGWFRONTS[slot - 1] > MAX_NUMBER_OF_CLOCK_CYCLES) topTRGWFRONTS[slot - 1] = MAX_NUMBER_OF_CLOCK_CYCLES;
423
424 for (auto& timeStamp : slotWaveFormTSS.getRelationsTo<TRGTOPWaveFormTimeStamp>()) {
425
426 if (!timeStamp.isEmptyClockCycle()) {
427
428 int value = timeStamp.getTimeStamp();
429
430 m_clockCyclesTriggerReadout[slot - 1][indexClockCycleTriggerReadout[slot - 1]] = clockCycleTriggerReadout[slot - 1];
431 m_timeStampsTriggerReadout[slot - 1][indexClockCycleTriggerReadout[slot - 1]] = value;
432
433 if (xMinWFRO[slot - 1] == -1
434 || clockCycleTriggerReadout[slot - 1] < xMinWFRO[slot - 1]) xMinWFRO[slot - 1] = clockCycleTriggerReadout[slot - 1];
435 if (xMaxWFRO[slot - 1] == -1
436 || clockCycleTriggerReadout[slot - 1] > xMaxWFRO[slot - 1]) xMaxWFRO[slot - 1] = clockCycleTriggerReadout[slot - 1];
437
438 if (yMinWFRO[slot - 1] == -1 || value < yMinWFRO[slot - 1]) yMinWFRO[slot - 1] = value;
439 if (yMaxWFRO[slot - 1] == -1 || value > yMaxWFRO[slot - 1]) yMaxWFRO[slot - 1] = value;
440
441 if (indexClockCycleTriggerReadout[slot - 1] < MAX_NUMBER_OF_CLOCK_CYCLES) {
442 indexClockCycleTriggerReadout[slot - 1]++;
443 }
444 }
445 clockCycleTriggerReadout[slot - 1]++;
446 }
447 }
448 }
449
450 // plotting
451
452 // for each slot
453 // decide if there is anything available (and requested) to plot for this slot
454 // then create a TMultiGraph
455 // then create at least one TGraph and add it to the list in TMultiGraph
456 // finally, decide how to plot this TMultiGraph and do that
457
458 bool plotMyCanvas[NUMBER_OF_TOP_SLOTS] = {false};
459
460 int xMin = -1;
461 int xMax = -1;
462 int yMin = -1;
463 int yMax = -1;
464
465 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) {
466 if (topTRGMRONTS[slot - 1] > 0 || topTRGWFRONTS[slot - 1] > 0) {
467 if (topTRGMRONTS[slot - 1] >= m_cutPlotMinNumberMainReadoutHits) {
468 if (topTRGWFRONTS[slot - 1] >= m_cutPlotMinNumberTriggerReadoutHits) {
469 plotMyCanvas[slot - 1] = true;
470 if (xMinMRO[slot - 1] != -1 && (xMin == -1 || xMinMRO[slot - 1] < xMin)) xMin = xMinMRO[slot - 1];
471 if (xMaxMRO[slot - 1] != -1 && (xMax == -1 || xMaxMRO[slot - 1] > xMax)) xMax = xMaxMRO[slot - 1];
472 if (yMinMRO[slot - 1] != -1 && (yMin == -1 || yMinMRO[slot - 1] < yMin)) yMin = yMinMRO[slot - 1];
473 if (yMaxMRO[slot - 1] != -1 && (yMax == -1 || yMaxMRO[slot - 1] > yMax)) yMax = yMaxMRO[slot - 1];
474
475 if (xMinWFRO[slot - 1] != -1 && (xMin == -1 || xMinWFRO[slot - 1] < xMin)) xMin = xMinWFRO[slot - 1];
476 if (xMaxWFRO[slot - 1] != -1 && (xMax == -1 || xMaxWFRO[slot - 1] > xMax)) xMax = xMaxWFRO[slot - 1];
477 if (yMinWFRO[slot - 1] != -1 && (yMin == -1 || yMinWFRO[slot - 1] < yMin)) yMin = yMinWFRO[slot - 1];
478 if (yMaxWFRO[slot - 1] != -1 && (yMax == -1 || yMaxWFRO[slot - 1] > yMax)) yMax = yMaxWFRO[slot - 1];
479 }
480 }
481 }
482 }
483
484 xMin = std::max(xMin - 10, 0);
485 xMax = xMax + 10;
486 yMin = std::max(yMin - 10, 0);
487 yMax = yMax + 10;
488
489 std::string myMultiGraphTitle[NUMBER_OF_TOP_SLOTS];
490
491 std::string myPaveTextInfo[NUMBER_OF_TOP_SLOTS][8];
492
493 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) {
494
495 if (plotMyCanvas[slot - 1]) {
496
497 m_myMultiGraph[slot - 1] = new TMultiGraph();
498 // In principle, we can allow TCanvas (where this TMultiGraph will be plotted) to assume the ownership over this graph.
499 // Then, when memory is freed, it should be sufficient to delete TCanvas only, as it would delete the graph also.
500 // m_myMultiGraph[slot-1]->SetBit(kCanDelete);
501 std::stringstream slotInfo;
502 slotInfo << slot;
503 myMultiGraphTitle[slot - 1] = "Slot " + slotInfo.str() + " : ";
504
505 m_myPaveText[slot - 1] = new TPaveText(0.40, 0.10, 0.90, 0.30, "bl NDC");
506 // m_myPaveText[slot-1]->SetHeader(myMultiGraphTitle[slot-1].c_str(),"C");;
507
508 if (topTRGMROPresent[slot - 1]) {
509
510 m_timeStampsGraphMainReadout[slot - 1] = new TGraph(topTRGMRONTS[slot - 1], &m_clockCyclesMainReadout[slot - 1][0],
511 &m_timeStampsMainReadout[slot - 1][0]);
512 // In principle, we can allow TCanvas (where this TGraph will be plotted) to assume the ownership over this graph.
513 // Then, when memory is freed, it should be sufficient to delete TCanvas only, as it would delete the graph also.
514 // m_timeStampsGraphMainReadout[slot-1]->SetBit(kCanDelete);
515
516 m_timeStampsGraphMainReadout[slot - 1]->SetMarkerStyle(m_markerTypeHits);
517 m_timeStampsGraphMainReadout[slot - 1]->SetMarkerSize(m_markerSizeHits);
518 m_timeStampsGraphMainReadout[slot - 1]->SetMarkerColor(kRed);
519
520 m_myMultiGraph[slot - 1]->Add(m_timeStampsGraphMainReadout[slot - 1], "AP");
521 }
522
523
524 if (topTRGWFROPresent[slot - 1]) {
525
526 m_timeStampsGraphTriggerReadout[slot - 1] = new TGraph(topTRGWFRONTS[slot - 1], &m_clockCyclesTriggerReadout[slot - 1][0],
527 &m_timeStampsTriggerReadout[slot - 1][0]);
528 // In principle, we can allow TCanvas (where this TGraph will be plotted) to assume the ownership over this graph.
529 // Then, when memory is freed, it should be sufficient to delete TCanvas only, as it would delete the graph also.
530 // m_timeStampsGraphTriggerReadout[slot-1]->SetBit(kCanDelete);
531
532 m_timeStampsGraphTriggerReadout[slot - 1]->SetMarkerStyle(m_markerTypeTimestamps);
533 m_timeStampsGraphTriggerReadout[slot - 1]->SetMarkerSize(m_markerSizeTimestamps);
534 m_timeStampsGraphTriggerReadout[slot - 1]->SetLineWidth(3);
535
536 int color = kBlue;
537 if (!topTRGDecisionPresent[slot - 1]) color = kBlack;
538
539 m_timeStampsGraphTriggerReadout[slot - 1]->SetMarkerColor(color);
540
541 m_myMultiGraph[slot - 1]->Add(m_timeStampsGraphTriggerReadout[slot - 1], "AP");
542 }
543 }
544 }
545
546 int canvasXMin = m_canvasXMin;
547 int canvasYMin = m_canvasYMin;
548 int canvasXSize = m_canvasXSize;
549 int canvasYSize = m_canvasYSize;
550
551 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) {
552
553 if (plotMyCanvas[slot - 1]) {
554
555 myMultiGraphTitle[slot - 1] = myMultiGraphTitle[slot - 1] + " TOP / TRG / L1 / iSim TOP / iSim TRG hits:";
556
557 std::stringstream nHitInfoMainReadout;
558 nHitInfoMainReadout << topTRGMRONTS[slot - 1];
559 myMultiGraphTitle[slot - 1] = myMultiGraphTitle[slot - 1] + " " + nHitInfoMainReadout.str();
560
561 myPaveTextInfo[slot - 1][0] = "N hits (TOP readout): " + nHitInfoMainReadout.str();
562
563 std::stringstream nHitInfoTriggerReadout;
564 nHitInfoTriggerReadout << topTRGWFRONTS[slot - 1];
565 myMultiGraphTitle[slot - 1] = myMultiGraphTitle[slot - 1] + " / " + nHitInfoTriggerReadout.str();
566
567 myPaveTextInfo[slot - 1][1] = "N timestamps (TRG readout): " + nHitInfoTriggerReadout.str();
568
569 std::stringstream nHitInfoTriggerDecision;
570 nHitInfoTriggerDecision << topTRGDecisionNTS[slot - 1];
571 myMultiGraphTitle[slot - 1] = myMultiGraphTitle[slot - 1] + " / " + nHitInfoTriggerDecision.str();
572
573 myPaveTextInfo[slot - 1][2] = "N timestamps TRG online: " + nHitInfoTriggerDecision.str();
574
575 std::stringstream nHitInfoISimTriggerDecisionMainReadout;
576 nHitInfoISimTriggerDecisionMainReadout << topTRGISimMRODecisionNTS[slot - 1];
577 myMultiGraphTitle[slot - 1] = myMultiGraphTitle[slot - 1] + " / " + nHitInfoISimTriggerDecisionMainReadout.str();
578
579 myPaveTextInfo[slot - 1][3] = "N timestamps TRG ISim (all, TOP readout): " + nHitInfoISimTriggerDecisionMainReadout.str();
580
581 std::stringstream nHitInfoISimTriggerDecisionTriggerReadout;
582 nHitInfoISimTriggerDecisionTriggerReadout << topTRGISimWFRODecisionNTS[slot - 1];
583 myMultiGraphTitle[slot - 1] = myMultiGraphTitle[slot - 1] + " / " + nHitInfoISimTriggerDecisionTriggerReadout.str();
584
585 myPaveTextInfo[slot - 1][4] = "N timestamps TRG ISim (all, TRG readout): " + nHitInfoISimTriggerDecisionTriggerReadout.str();
586
587 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + ", t0 online/ISim main/TRG: ";
588
589 if (topTRGDecisionPresent[slot - 1]) {
590 std::stringstream nTimingInfoTriggerDecision;
591 nTimingInfoTriggerDecision << topTRGDecisionTiming[slot - 1] / 2;
592 std::stringstream nNumberInfoTriggerDecision;
593 nNumberInfoTriggerDecision << topTRGDecisionNumber[slot - 1];
594 myPaveTextInfo[slot - 1][5] = "Number of online TRG decisions: " + nNumberInfoTriggerDecision.str() + ", most recent t0: " +
595 nTimingInfoTriggerDecision.str();
596 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + nNumberInfoTriggerDecision.str() + " ( ";
597 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + nTimingInfoTriggerDecision.str() + " ) / ";
598 } else {
599 myPaveTextInfo[slot - 1][5] = "No online TRG decisions";
600 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + "none / ";
601 }
602
603 if (topTRGISimMRODecisionPresent[slot - 1]) {
604 std::stringstream nTimingInfoTriggerDecision;
605 nTimingInfoTriggerDecision << topTRGISimMRODecisionTiming[slot - 1];
606 std::stringstream nNumberInfoTriggerDecision;
607 nNumberInfoTriggerDecision << topTRGISimMRODecisionNumber[slot - 1];
608 myPaveTextInfo[slot - 1][6] = "Number of ISim TOP readout TRG decisions: " + nNumberInfoTriggerDecision.str() + ", most recent t0: "
609 + nTimingInfoTriggerDecision.str();
610 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + nNumberInfoTriggerDecision.str() + " ( ";
611 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + nTimingInfoTriggerDecision.str() + " ) / ";
612 } else {
613 myPaveTextInfo[slot - 1][6] = "No iSim TOP readout TRG decisions";
614 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + " none / ";
615 }
616
617 if (topTRGISimWFRODecisionPresent[slot - 1]) {
618 std::stringstream nTimingInfoTriggerDecision;
619 nTimingInfoTriggerDecision << topTRGISimWFRODecisionTiming[slot - 1];
620 std::stringstream nNumberInfoTriggerDecision;
621 nNumberInfoTriggerDecision << topTRGISimWFRODecisionNumber[slot - 1];
622 myPaveTextInfo[slot - 1][7] = "Number of ISim TRG readout TRG decisions: " + nNumberInfoTriggerDecision.str() + ", most recent t0: "
623 + nTimingInfoTriggerDecision.str();
624 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + nNumberInfoTriggerDecision.str() + " ( ";
625 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + nTimingInfoTriggerDecision.str() + " )";
626 } else {
627 myPaveTextInfo[slot - 1][7] = "No iSim TRG readout TRG decisions";
628 // myMultiGraphTitle[slot-1] = myMultiGraphTitle[slot-1] + "none";
629 }
630
631 myMultiGraphTitle[slot - 1] = myMultiGraphTitle[slot - 1] + "; Clock cycle (8ns units); Hit time (2ns units)";
632 m_myMultiGraph[slot - 1]->SetTitle(myMultiGraphTitle[slot - 1].c_str());
633
634 std::stringstream slotInfo;
635 slotInfo << slot;
636 std::string name = "c_" + slotInfo.str();
637 std::string title = "Main readout hits (red) and trigger readout timestamps (blue/black) for slot " + slotInfo.str();
638 m_myCanvas[slot - 1] = new TCanvas(name.c_str(), title.c_str(), canvasXMin, canvasYMin, canvasXSize, canvasYSize);
639 if (m_shiftCanvas) {
640 canvasXMin = canvasXMin + m_xShiftCanvas;
641 if (canvasXMin >= 1000) {
642 canvasXMin = m_canvasXMin;
643 canvasYMin = canvasYMin + m_yShiftCanvas;
644 if (canvasYMin >= 700) {
645 canvasYMin = m_canvasYMin;
646 }
647 }
648 }
649
650 m_myMultiGraph[slot - 1]->Draw("AP");
651
652 TAxis* xAxis = m_myMultiGraph[slot - 1]->GetXaxis();
653
654 if (m_plottingMode == 0) {
655 m_myMultiGraph[slot - 1]->SetMinimum(m_yMin);
656 m_myMultiGraph[slot - 1]->SetMaximum(m_yMax);
657 xAxis->SetLimits(m_xMin, m_xMax);
658 } else if (m_plottingMode == 1) {
659 m_myMultiGraph[slot - 1]->SetMinimum(std::min(yMinMRO[slot - 1], yMinWFRO[slot - 1]));
660 m_myMultiGraph[slot - 1]->SetMaximum(std::max(yMaxMRO[slot - 1], yMaxWFRO[slot - 1]));
661 xAxis->SetLimits(std::min(xMinMRO[slot - 1], xMinWFRO[slot - 1]), std::max(xMaxMRO[slot - 1], xMaxWFRO[slot - 1]));
662 } else if (m_plottingMode == 2) {
663 m_myMultiGraph[slot - 1]->SetMinimum(yMin);
664 m_myMultiGraph[slot - 1]->SetMaximum(yMax);
665 xAxis->SetLimits(xMin, xMax);
666 } else if (m_plottingMode == 3) {
667 m_myMultiGraph[slot - 1]->SetMinimum(yMin);
668 m_myMultiGraph[slot - 1]->SetMaximum(yMax);
669 xAxis->SetLimits(m_xMin, xMax);
670 } else if (m_plottingMode == 4) {
671 m_myMultiGraph[slot - 1]->SetMinimum(yMin);
672 m_myMultiGraph[slot - 1]->SetMaximum(yMax);
673 xAxis->SetLimits(m_xMin, m_xMax);
674 } else {
675 m_myMultiGraph[slot - 1]->SetMinimum(0);
676 m_myMultiGraph[slot - 1]->SetMaximum(MAX_TIMESTAMP_RANGE);
677 xAxis->SetLimits(0, MAX_NUMBER_OF_CLOCK_CYCLES);
678 }
679
680 m_myMultiGraph[slot - 1]->Draw("AP");
681 m_myCanvas[slot - 1]->SetGridx(m_showGridx);
682 m_myCanvas[slot - 1]->SetGridy(m_showGridy);
683
684 // m_myPaveText[slot-1]->AddText(myPaveTextInfo[slot-1][0].c_str());
685 // m_myPaveText[slot-1]->AddText(myPaveTextInfo[slot-1][1].c_str());
686 // m_myPaveText[slot-1]->AddText(myPaveTextInfo[slot-1][2].c_str());
687 // m_myPaveText[slot-1]->AddText(myPaveTextInfo[slot-1][3].c_str());
688 // m_myPaveText[slot-1]->AddText(myPaveTextInfo[slot-1][4].c_str());
689 m_myPaveText[slot - 1]->AddText(myPaveTextInfo[slot - 1][5].c_str());
690 m_myPaveText[slot - 1]->AddText(myPaveTextInfo[slot - 1][6].c_str());
691 m_myPaveText[slot - 1]->AddText(myPaveTextInfo[slot - 1][7].c_str());
692
693 m_myPaveText[slot - 1]->AddText(topTRGDecisionText[slot - 1].c_str());
694 m_myPaveText[slot - 1]->AddText(topTRGIsimMRODecisionText[slot - 1].c_str());
695 m_myPaveText[slot - 1]->AddText(topTRGIsimWFRODecisionText[slot - 1].c_str());
696
697 m_myPaveText[slot - 1]->SetBorderSize(1);
698 // m_myPaveText[slot-1]->SetFillColor(19);
699 m_myPaveText[slot - 1]->SetFillStyle(0);
700 m_myPaveText[slot - 1]->SetTextFont(40);
701 m_myPaveText[slot - 1]->SetTextAlign(12);
702 m_myPaveText[slot - 1]->Draw();
703
704 m_myCanvas[slot - 1]->Update();
705
706 }
707 }
708
709 // if (!oldROOTDir) oldROOTDir->cd();
710}
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113
Example Detector.
TCanvas * m_myCanvas[NUMBER_OF_TOP_SLOTS]
TDirectory.

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

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

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

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

◆ getAllConditionPaths()

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

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

Definition at line 150 of file Module.cc.

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

◆ getAllConditions()

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

Return all set conditions for this module.

Definition at line 323 of file Module.h.

324 {
325 return m_conditions;
326 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

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

Definition at line 313 of file Module.h.

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

◆ getConditionPath()

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

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


Definition at line 113 of file Module.cc.

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

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 201 of file Module.h.

201{return m_description;}
std::string m_description
The description of the module.
Definition: Module.h:510

◆ 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 133 of file Module.h.

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

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 224 of file Module.h.

224{return m_logConfig;}

◆ getModules()

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

no submodules, return empty list

Implements PathElement.

Definition at line 505 of file Module.h.

505{ 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 186 of file Module.h.

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

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 196 of file Module.h.

196{return m_package;}

◆ getParamInfoListPython()

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

Returns a python list of all parameters.

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

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

Definition at line 279 of file Module.cc.

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

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 362 of file Module.h.

362{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

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

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 380 of file Module.h.

380{ return m_returnValue; }

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

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

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

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

Definition at line 310 of file Module.h.

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

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

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

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

Definition at line 160 of file Module.cc.

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

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

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

Definition at line 377 of file Module.h.

377{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

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

Definition at line 166 of file Module.cc.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ if_false()

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

A simplified version to add a condition to the module.

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

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

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

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

Definition at line 85 of file Module.cc.

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

◆ if_true()

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

A simplified version to set the condition of the module.

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

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

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

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

Definition at line 90 of file Module.cc.

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

◆ if_value()

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

Add a condition to the module.

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

See https://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
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

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

◆ initialize()

void initialize ( void  )
overridevirtual

initialize

Reimplemented from Module.

Definition at line 153 of file TRGTOPWaveformPlotterModule.cc.

154{
155
156 // oldROOTDir = gDirectory;
157
158 // m_file = new TFile(m_outputTTreeFileName.c_str(), "RECREATE");
159
160 // myROOTDir = gDirectory;
161
162 for (int slot = 1; slot <= NUMBER_OF_TOP_SLOTS; slot++) {
163 m_timeStampsGraphMainReadout[slot - 1] = 0;
164 m_timeStampsGraphTriggerReadout[slot - 1] = 0;
165 m_myMultiGraph[slot - 1] = 0;
166 m_myPaveText[slot - 1] = 0;
167 m_myCanvas[slot - 1] = 0;
168 }
169
170 // if (!oldROOTDir) oldROOTDir->cd();
171
172}

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

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

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 229 of file Module.h.

229{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

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

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ setName()

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

Set the name of the module.

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

Definition at line 213 of file Module.h.

213{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 500 of file Module.h.

500{ m_moduleParamList = params; }

◆ setParamPython()

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

Implements a method for setting boost::python objects.

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

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

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:28
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ setParamPythonDict()

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

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

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

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

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

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

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

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

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

◆ setType()

void setType ( const std::string &  type)
protectedinherited

Set the module type.

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

Definition at line 48 of file Module.cc.

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

◆ terminate()

void terminate ( void  )
overridevirtual

terminate

Reimplemented from Module.

Definition at line 712 of file TRGTOPWaveformPlotterModule.cc.

713{
714 // oldROOTDir = gDirectory;
715 // myROOTDir->cd();
716
717 // if (!oldROOTDir) oldROOTDir->cd();
718}

Member Data Documentation

◆ m_canvasXMin

int m_canvasXMin
private

Definition at line 129 of file TRGTOPWaveformPlotterModule.h.

◆ m_canvasXSize

int m_canvasXSize
private

Definition at line 131 of file TRGTOPWaveformPlotterModule.h.

◆ m_canvasYMin

int m_canvasYMin
private

Definition at line 130 of file TRGTOPWaveformPlotterModule.h.

◆ m_canvasYSize

int m_canvasYSize
private

Definition at line 132 of file TRGTOPWaveformPlotterModule.h.

◆ m_clockCyclesMainReadout

Int_t m_clockCyclesMainReadout[NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
private

Definition at line 102 of file TRGTOPWaveformPlotterModule.h.

◆ m_clockCyclesTriggerReadout

Int_t m_clockCyclesTriggerReadout[NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
private

Definition at line 103 of file TRGTOPWaveformPlotterModule.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 520 of file Module.h.

◆ m_cutPlotMinNumberMainReadoutHits

int m_cutPlotMinNumberMainReadoutHits
private

Definition at line 119 of file TRGTOPWaveformPlotterModule.h.

◆ m_cutPlotMinNumberTriggerReadoutHits

int m_cutPlotMinNumberTriggerReadoutHits
private

Definition at line 117 of file TRGTOPWaveformPlotterModule.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 510 of file Module.h.

◆ m_firstAssumedClockCycle

int m_firstAssumedClockCycle
private

Definition at line 115 of file TRGTOPWaveformPlotterModule.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 517 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 513 of file Module.h.

◆ m_markerSizeHits

double m_markerSizeHits
private

Definition at line 109 of file TRGTOPWaveformPlotterModule.h.

◆ m_markerSizeTimestamps

double m_markerSizeTimestamps
private

Definition at line 110 of file TRGTOPWaveformPlotterModule.h.

◆ m_markerTypeHits

int m_markerTypeHits
private

Definition at line 112 of file TRGTOPWaveformPlotterModule.h.

◆ m_markerTypeTimestamps

int m_markerTypeTimestamps
private

Definition at line 113 of file TRGTOPWaveformPlotterModule.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 515 of file Module.h.

◆ m_myCanvas

TCanvas* m_myCanvas[NUMBER_OF_TOP_SLOTS]
private

TDirectory.

TDirectory pointer to ROOT file with TTree for efficiecy studies

Definition at line 90 of file TRGTOPWaveformPlotterModule.h.

◆ m_myMultiGraph

TMultiGraph* m_myMultiGraph[NUMBER_OF_TOP_SLOTS]
private

Definition at line 95 of file TRGTOPWaveformPlotterModule.h.

◆ m_myPaveText

TPaveText* m_myPaveText[NUMBER_OF_TOP_SLOTS]
private

Definition at line 97 of file TRGTOPWaveformPlotterModule.h.

◆ m_name

std::string m_name
privateinherited

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

Definition at line 507 of file Module.h.

◆ m_package

std::string m_package
privateinherited

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

Definition at line 509 of file Module.h.

◆ m_plottingMode

int m_plottingMode
private

Definition at line 107 of file TRGTOPWaveformPlotterModule.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 511 of file Module.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 518 of file Module.h.

◆ m_shiftCanvas

int m_shiftCanvas
private

Definition at line 134 of file TRGTOPWaveformPlotterModule.h.

◆ m_showGridx

int m_showGridx
private

Definition at line 126 of file TRGTOPWaveformPlotterModule.h.

◆ m_showGridy

int m_showGridy
private

Definition at line 127 of file TRGTOPWaveformPlotterModule.h.

◆ m_timeStampsGraphMainReadout

TGraph* m_timeStampsGraphMainReadout[NUMBER_OF_TOP_SLOTS]
private

Definition at line 92 of file TRGTOPWaveformPlotterModule.h.

◆ m_timeStampsGraphTriggerReadout

TGraph* m_timeStampsGraphTriggerReadout[NUMBER_OF_TOP_SLOTS]
private

Definition at line 93 of file TRGTOPWaveformPlotterModule.h.

◆ m_timeStampsMainReadout

Int_t m_timeStampsMainReadout[NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
private

Definition at line 99 of file TRGTOPWaveformPlotterModule.h.

◆ m_timeStampsTriggerReadout

Int_t m_timeStampsTriggerReadout[NUMBER_OF_TOP_SLOTS][MAX_NUMBER_OF_CLOCK_CYCLES]
private

Definition at line 100 of file TRGTOPWaveformPlotterModule.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 508 of file Module.h.

◆ m_xMax

int m_xMax
private

Definition at line 122 of file TRGTOPWaveformPlotterModule.h.

◆ m_xMin

int m_xMin
private

Definition at line 121 of file TRGTOPWaveformPlotterModule.h.

◆ m_xShiftCanvas

int m_xShiftCanvas
private

Definition at line 135 of file TRGTOPWaveformPlotterModule.h.

◆ m_yMax

int m_yMax
private

Definition at line 124 of file TRGTOPWaveformPlotterModule.h.

◆ m_yMin

int m_yMin
private

Definition at line 123 of file TRGTOPWaveformPlotterModule.h.

◆ m_yShiftCanvas

int m_yShiftCanvas
private

Definition at line 136 of file TRGTOPWaveformPlotterModule.h.


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