PerEventStatisticsGetterModule Class Reference

Inheritance diagram for PerEventStatisticsGetterModule:

Collaboration diagram for PerEventStatisticsGetterModule:

Public Member Functions
def	__init__ (self, output_file_name)
def	initialize (self)
def	event (self)
def	terminate (self)

Public Attributes
	output_file_name
	Name of the output file.
	tfile
	Will host the pointer to the opened TFile later.
	statistics
	Will host the TTree later.
	event_number
	The columns to store the event number.
	ttree_inputs
	The columns for the statistics TTree (they will be filled in the event function).
	last_time_sum
	Last recored sum of event calls for all modules.
	branches_added
	A flag to indicate that we have already added the Branches to the TTree (which we will do in the first event)
	event_meta_data
	The event meta data.

Detailed Description

A basf2 python module to export *all* module time statistics (of every event, not just averaged)
 into a ROOT TTree written to a file.

Definition at line 13 of file per_event_statistics.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			output_file_name
	)

Create a new PerEventStatisticsGetterModule. You have to give the name of the
file, where the TTree with the full event statistics will be saved.

Definition at line 19 of file per_event_statistics.py.

    def __init__(self, output_file_name):
        """
        Create a new PerEventStatisticsGetterModule. You have to give the name of the
        file, where the TTree with the full event statistics will be saved.
        """
        super().__init__()
 
        
        self.output_file_name = output_file_name
        
        self.tfile = None
        
        self.statistics = None
 
        
        self.event_number = np.zeros(3, dtype=float)
        
        self.ttree_inputs = None
        
        self.last_time_sum = None
 
        
        self.branches_added = False
 
        # Always avoid the top-level 'import ROOT'.
        import ROOT  # noqa
 
        
        self.event_meta_data = ROOT.Belle2.PyStoreObj("EventMetaData")  # noqa
 

Member Function Documentation

event()

def event

(

self

)

The event loop: Store the statistics as a new row in the TTree.

Definition at line 76 of file per_event_statistics.py.

    def event(self):
        """
        The event loop: Store the statistics as a new row in the TTree.
        """
        # Always avoid the top-level 'import ROOT'.
        import ROOT  # noqa
 
        # TTree reference (for shorter code)
        ttree = self.statistics
 
        # Get the statistics
        module_stats = basf2.statistics.modules
 
        # Fill in the event information
        self.event_number[0] = self.event_meta_data.getExperiment()
        self.event_number[1] = self.event_meta_data.getRun()
        self.event_number[2] = self.event_meta_data.getEvent()
 
        # Again, change the directory
        old = ROOT.gDirectory
        self.tfile.cd()
 
        if not self.branches_added:
 
            # make sure all this is only done in the output process
            if ROOT.Belle2.ProcHandler.parallelProcessingUsed() and not ROOT.Belle2.ProcHandler.isOutputProcess():
                basf2.B2FATAL("PerEventStatisticsGetterModule can only be used in single processing mode or in the output process")
 
            self.ttree_inputs = np.zeros(len(module_stats), dtype=float)
            self.last_time_sum = np.zeros(len(module_stats), dtype=float)
 
            for i, stat in enumerate(module_stats):
                # escape the module names in ROOT-safe manner. Otherwise weird stuff happens like
                # sub-branches get created or the branch cannot be opened in the TBrowser
                module_name = f"{ROOT.Belle2.MakeROOTCompatible.makeROOTCompatible(stat.name)}_{i}"
                # Create the branch. See initialize() for why it's [i:] and not [i]
                ttree.Branch(module_name, self.ttree_inputs[i:], f"{module_name}/D")
 
            self.branches_added = True
 
        # Fill in the module statistics into the branches
        time_sum = np.array([m.time_sum(basf2.statistics.EVENT) for m in module_stats], dtype=float)
        # We need to change the contents of the ttree_inputs array **without**
        # changing its address so we cannot just assign. But we can assign to
        # to the full array itself using the empty slice syntax.
        self.ttree_inputs[:] = time_sum - self.last_time_sum
        self.last_time_sum[:] = time_sum
 
        # Send the branches to the TTree.
        ttree.Fill()
 
        # and back again
        ROOT.gDirectory = old
 

initialize()

def initialize

(

self

)

Create the needed store object pointer in the DataStore and the TFile with the TTree.

Definition at line 49 of file per_event_statistics.py.

    def initialize(self):
        """
        Create the needed store object pointer in the DataStore and the TFile with the TTree.
        """
        # Always avoid the top-level 'import ROOT'.
        import ROOT  # noqa
 
        self.event_meta_data.isRequired()
 
        # try to avoid side effects ...
        old = ROOT.gDirectory
        # Before creating the TTree, open the output file.
        self.tfile = ROOT.TFile.Open(self.output_file_name, "RECREATE")
        # Create the TTree.
        self.statistics = ROOT.TTree("statistics", "Per event execution Statistics for all modules")
        # and reset stupid global directory pointer
        ROOT.gDirectory = old
 
        # Add branches identifying the event. The reason these are [i:] instead
        # of just [i] is that the latter just returns a single float object which
        # doesn't work as a buffer to TTree::Branch. We need a buffer with an
        # address where it can write the value. So we take a reference to the
        # array starting at element i with [i:]
        self.statistics.Branch("expNo", self.event_number[0:], "expNo/D")
        self.statistics.Branch("runNo", self.event_number[1:], "runNo/D")
        self.statistics.Branch("evtNo", self.event_number[2:], "evtNo/D")
 

terminate()

def terminate

(

self

)

Write out the merged statistics to the ROOT file.
This should only be called once, as we would end up with different versions otherwise.

Definition at line 130 of file per_event_statistics.py.

    def terminate(self):
        """
        Write out the merged statistics to the ROOT file.
        This should only be called once, as we would end up with different versions otherwise.
        """
        # Always avoid the top-level 'import ROOT'.
        import ROOT  # noqa
 
        # Change the path a last time
        old = ROOT.gDirectory
        self.tfile.cd()
 
        self.statistics.Write()
        self.tfile.Close()
 
        # and back again
        ROOT.gDirectory = old

Member Data Documentation

branches_added

branches_added

A flag to indicate that we have already added the Branches to the TTree (which we will do in the first event)

Definition at line 41 of file per_event_statistics.py.

event_meta_data

event_meta_data

The event meta data.

Definition at line 47 of file per_event_statistics.py.

event_number

event_number

The columns to store the event number.

Definition at line 34 of file per_event_statistics.py.

last_time_sum

last_time_sum

Last recored sum of event calls for all modules.

Definition at line 38 of file per_event_statistics.py.

output_file_name

output_file_name

Name of the output file.

Definition at line 27 of file per_event_statistics.py.

statistics

statistics

Will host the TTree later.

Definition at line 31 of file per_event_statistics.py.

tfile

tfile

Will host the pointer to the opened TFile later.

Definition at line 29 of file per_event_statistics.py.

ttree_inputs

ttree_inputs

The columns for the statistics TTree (they will be filled in the event function).

Definition at line 36 of file per_event_statistics.py.

---

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

• framework/scripts/per_event_statistics.py