Belle II Software development
CombinedTrackingValidationModule Class Reference
Inheritance diagram for CombinedTrackingValidationModule:
PathModule

Public Member Functions

 __init__ (self, name, contact, output_file_name=None, reco_tracks_name='RecoTracks', mc_reco_tracks_name='MCRecoTracks', expert_level=None)
 
 initialize (self)
 
 terminate (self)
 
 event (self)
 

Public Attributes

str output_file_name = output_file_name or name + 'TrackingValidation.root'
 Output TFile to be opened in the initialize method.
 
list modules
 Subordinate modules.
 
 output_tfile = output_tfile
 the output TFile
 

Static Public Attributes

 MCSideModule = MCSideTrackingValidationModule
 MC side validation module to use.
 
 PRSideModule = PRSideTrackingValidationModule
 PR side validation module to use.
 
 EventwiseModule = EventwiseTrackingValidationModule
 Eventwise side validation module to use.
 

Protected Attributes

 _path = path
 The contained path.
 

Detailed Description

Harvesting validation module combining eventwise, pr side and mc side tracking validation parts

Definition at line 17 of file combined_module.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
name,
contact,
output_file_name = None,
reco_tracks_name = 'RecoTracks',
mc_reco_tracks_name = 'MCRecoTracks',
expert_level = None )
Constructor

Definition at line 29 of file combined_module.py.

35 expert_level=None):
36 """Constructor"""
37
38 ## Output TFile to be opened in the initialize method
39 self.output_file_name = output_file_name or name + 'TrackingValidation.root'
40
41 # First forward the output_file_name to the separate modules
42 # but we open the TFile in the top level and forward it to them on initialize.
43
44 eventwise_module = self.EventwiseModule(name,
45 contact,
46 output_file_name=self.output_file_name,
47 reco_tracks_name=reco_tracks_name,
48 mc_reco_tracks_name=mc_reco_tracks_name,
49 expert_level=expert_level)
50
51 pr_side_module = self.PRSideModule(name,
52 contact,
53 output_file_name=self.output_file_name,
54 reco_tracks_name=reco_tracks_name,
55 mc_reco_tracks_name=mc_reco_tracks_name,
56 expert_level=expert_level)
57
58 mc_side_module = self.MCSideModule(name,
59 contact,
60 output_file_name=self.output_file_name,
61 reco_tracks_name=reco_tracks_name,
62 mc_reco_tracks_name=mc_reco_tracks_name,
63 expert_level=expert_level)
64
65 ## Subordinate modules
66 self.modules = [
67 eventwise_module,
68 pr_side_module,
69 mc_side_module,
70 ]
71
72 super().__init__(modules=self.modules)
73

Member Function Documentation

◆ event()

event ( self)
inherited
Event method of the module

Sets the return value of this module to true and triggers the execution of the wrapped path.

Definition at line 355 of file metamodules.py.

355 def event(self):
356 """Event method of the module
357
358 Sets the return value of this module to true and triggers the execution of the wrapped path.
359 """
360
361 self.return_value(True)

◆ initialize()

initialize ( self)
Initialization signal at the start of the event processing

Definition at line 74 of file combined_module.py.

74 def initialize(self):
75 """Initialization signal at the start of the event processing"""
76 super().initialize()
77 output_tfile = ROOT.TFile(self.output_file_name, "RECREATE")
78
79 # Substitute the output file with the common output file opened in this module.
80 for module in self.modules:
81 module.output_file_name = output_tfile
82
83
84 self.output_tfile = output_tfile
85

◆ terminate()

terminate ( self)
Termination signal at the start of the event processing

Definition at line 86 of file combined_module.py.

86 def terminate(self):
87 """Termination signal at the start of the event processing"""
88 self.output_tfile.Flush()
89 self.output_tfile.Close()
90 super().terminate()

Member Data Documentation

◆ _path

_path = path
protectedinherited

The contained path.

Definition at line 340 of file metamodules.py.

◆ EventwiseModule

EventwiseModule = EventwiseTrackingValidationModule
static

Eventwise side validation module to use.

Definition at line 27 of file combined_module.py.

◆ MCSideModule

MCSideModule = MCSideTrackingValidationModule
static

MC side validation module to use.

Definition at line 21 of file combined_module.py.

◆ modules

list modules
Initial value:
= [
eventwise_module,
pr_side_module,
mc_side_module,
]

Subordinate modules.

Definition at line 66 of file combined_module.py.

◆ output_file_name

str output_file_name = output_file_name or name + 'TrackingValidation.root'

Output TFile to be opened in the initialize method.

Definition at line 39 of file combined_module.py.

◆ output_tfile

output_tfile = output_tfile

the output TFile

Definition at line 84 of file combined_module.py.

◆ PRSideModule

PRSideModule = PRSideTrackingValidationModule
static

PR side validation module to use.

Definition at line 24 of file combined_module.py.


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