ModuleStatistics Class Reference

Public Member Functions
	__init__ (self, stats, categories)
	__getitem__ (self, item)

Static Public Member Functions
	get_dict (function, categories)

Public Attributes
	name = stats.name
	Name property.
	time_sum = self.get_dict(stats.time_sum, categories)
	Time sum property.
	time_mean = self.get_dict(stats.time_mean, categories)
	Time mean property.
	time_stddev = self.get_dict(stats.time_stddev, categories)
	Time std property.
	memory_sum = self.get_dict(stats.memory_sum, categories)
	Memory sum property.
	memory_mean = self.get_dict(stats.memory_mean, categories)
	Memory mean property.
	memory_stddev = self.get_dict(stats.memory_stddev, categories)
	Memory std property.
	calls = self.get_dict(stats.calls, categories)
	Calls property.

Detailed Description

Dictionary list holding the module statistics (like the C++ class ModuleStatistics)

Definition at line 13 of file entities.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			stats,
			categories )

Create a new module statistics entity.

Definition at line 19 of file entities.py.

    def __init__(self, stats, categories):
        """Create a new module statistics entity."""
        
        self.name = stats.name
        
        self.time_sum = self.get_dict(stats.time_sum, categories)
        
        self.time_mean = self.get_dict(stats.time_mean, categories)
        
        self.time_stddev = self.get_dict(stats.time_stddev, categories)
        
        self.memory_sum = self.get_dict(stats.memory_sum, categories)
        
        self.memory_mean = self.get_dict(stats.memory_mean, categories)
        
        self.memory_stddev = self.get_dict(stats.memory_stddev, categories)
        
        self.calls = self.get_dict(stats.calls, categories)
 

Member Function Documentation

__getitem__()

__getitem__	(		self,
			item )

Convenience function for the display.

Definition at line 46 of file entities.py.

    def __getitem__(self, item):
        """Convenience function for the display."""
        if item == "name":
            return self.name
        elif item == "calls":
            return self.calls["EVENT"]
        elif item == "mem":
            return self.memory_mean["EVENT"] * 1E-3
        elif item == "time":
            return np.round(self.time_sum["EVENT"] * 1E-9, 2)
        elif item == "eventtime":
            return np.round(self.time_mean["EVENT"] * 1E-6, 2), "±", np.round(self.time_stddev["EVENT"] * 1E-6, 2)
 
 

get_dict()

get_dict ( function, categories )

static

Call the function on each information in the categories and return a dict
name -> function(value)

Definition at line 39 of file entities.py.

    def get_dict(function, categories):
        """
        Call the function on each information in the categories and return a dict
        name -> function(value)
        """
        return {name: function(category) for name, category in categories}
 

Member Data Documentation

calls

calls = self.get_dict(stats.calls, categories)

Calls property.

Definition at line 36 of file entities.py.

memory_mean

memory_mean = self.get_dict(stats.memory_mean, categories)

Memory mean property.

Definition at line 32 of file entities.py.

memory_stddev

memory_stddev = self.get_dict(stats.memory_stddev, categories)

Memory std property.

Definition at line 34 of file entities.py.

memory_sum

memory_sum = self.get_dict(stats.memory_sum, categories)

Memory sum property.

Definition at line 30 of file entities.py.

name

name = stats.name

Name property.

Definition at line 22 of file entities.py.

time_mean

time_mean = self.get_dict(stats.time_mean, categories)

Time mean property.

Definition at line 26 of file entities.py.

time_stddev

time_stddev = self.get_dict(stats.time_stddev, categories)

Time std property.

Definition at line 28 of file entities.py.

time_sum

time_sum = self.get_dict(stats.time_sum, categories)

Time sum property.

Definition at line 24 of file entities.py.

---

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

• framework/scripts/hep_ipython_tools/ipython_handler_basf2/entities.py