CombinedTrackingValidationModule Class Reference

Inheritance diagram for CombinedTrackingValidationModule:

Collaboration diagram for CombinedTrackingValidationModule:

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.

                 expert_level=None):
        """Constructor"""
 
        ## Output TFile to be opened in the initialize method
        self.output_file_name = output_file_name or name + 'TrackingValidation.root'
 
        # First forward the output_file_name to the separate modules
        # but we open the TFile in the top level and forward it to them on initialize.
 
        eventwise_module = self.EventwiseModule(name,
                                                contact,
                                                output_file_name=self.output_file_name,
                                                reco_tracks_name=reco_tracks_name,
                                                mc_reco_tracks_name=mc_reco_tracks_name,
                                                expert_level=expert_level)
 
        pr_side_module = self.PRSideModule(name,
                                           contact,
                                           output_file_name=self.output_file_name,
                                           reco_tracks_name=reco_tracks_name,
                                           mc_reco_tracks_name=mc_reco_tracks_name,
                                           expert_level=expert_level)
 
        mc_side_module = self.MCSideModule(name,
                                           contact,
                                           output_file_name=self.output_file_name,
                                           reco_tracks_name=reco_tracks_name,
                                           mc_reco_tracks_name=mc_reco_tracks_name,
                                           expert_level=expert_level)
 
        ## Subordinate modules
        self.modules = [
            eventwise_module,
            pr_side_module,
            mc_side_module,
        ]
 
        super().__init__(modules=self.modules)
 

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.

    def event(self):
        """Event method of the module
 
        Sets the return value of this module to true and triggers the execution of the wrapped path.
        """
 
        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.

    def initialize(self):
        """Initialization signal at the start of the event processing"""
        super().initialize()
        output_tfile = ROOT.TFile(self.output_file_name, "RECREATE")
 
        # Substitute the output file with the common output file opened in this module.
        for module in self.modules:
            module.output_file_name = output_tfile
 
        
        self.output_tfile = output_tfile
 

terminate()

terminate

(

self

)

Termination signal at the start of the event processing

Definition at line 86 of file combined_module.py.

    def terminate(self):
        """Termination signal at the start of the event processing"""
        self.output_tfile.Flush()
        self.output_tfile.Close()
        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:

• tracking/scripts/tracking/harvesting_validation/combined_module.py