RetentionCheck Class Reference

Inheritance diagram for RetentionCheck:

Collaboration diagram for RetentionCheck:

Public Member Functions
def	__init__ (self, module_name='', module_number=0, particle_lists=None)
def	event (self)
def	terminate (self)
def	print_results (cls)
def	plot_retention (cls, particle_list, plot_title="", save_as=None, module_name_max_length=80)

Public Attributes
	module_name
	module_number
	candidate_count
	event_with_candidate_count
	particle_lists

Static Public Attributes
dictionary	summary = {}
	output_override = None

Private Attributes
	_key

Detailed Description

Check the retention rate and the number of candidates for a given set of particle lists.

The module stores its results in the static variable "summary".

To monitor the effect of every module of an initial path, this module should be added after
each module of the path. A function was written (`skim.utils.retention.pathWithRetentionCheck`) to do it:

>>> path = pathWithRetentionCheck(particle_lists, path)

After the path processing, the result of the RetentionCheck can be printed with

>>> RetentionCheck.print_results()

or plotted with (check the corresponding documentation)

>>> RetentionCheck.plot_retention(...)

and the summary dictionary can be accessed through

>>> RetentionCheck.summary

Authors:

    Cyrille Praz, Slavomira Stefkova

Parameters:

    module_name (str): name of the module after which the retention rate is measured
    module_number (int): index of the module after which the retention rate is measured
    particle_lists (list(str)): list of particle list names which will be tracked by the module

Definition at line 24 of file retention.py.

Member Function Documentation

plot_retention()

def plot_retention	(		cls,
			particle_list,
			plot_title = "",
			save_as = None,
			module_name_max_length = 80
	)

 Plot the result of the RetentionCheck for a given particle list.

Example of use (to be put after process(path)):

>>> RetentionCheck.plot_retention('B+:semileptonic','skim:feiSLBplus','retention_plots/plot.pdf')

Parameters:

    particle_list (str): particle list name
    title (str): plot title (overwritten by the -o argument in basf2)
    save_as (str): output filename (overwritten by the -o argument in basf2)
    module_name_max_length (int): if the module name length is higher than this value, do not display the full name

Definition at line 160 of file retention.py.

    def plot_retention(cls, particle_list, plot_title="", save_as=None, module_name_max_length=80):
        """ Plot the result of the RetentionCheck for a given particle list.
 
        Example of use (to be put after process(path)):
 
        >>> RetentionCheck.plot_retention('B+:semileptonic','skim:feiSLBplus','retention_plots/plot.pdf')
 
        Parameters:
 
            particle_list (str): particle list name
            title (str): plot title (overwritten by the -o argument in basf2)
            save_as (str): output filename (overwritten by the -o argument in basf2)
            module_name_max_length (int): if the module name length is higher than this value, do not display the full name
        """
        module_name = []
        retention = []
 
        at_least_one_entry = False
        for module, results in cls.summary.items():
 
            if particle_list not in results.keys():
                b2.B2WARNING(particle_list + " is not present in the results of the RetentionCheck for the module {}."
                             .format(module))
                return
 
            if results[particle_list]['retention_rate'] > 0 or at_least_one_entry:
                at_least_one_entry = True
                if len(module) > module_name_max_length and module_name_max_length > 3:  # module name tool long
                    module = module[:module_name_max_length - 3] + "..."
                module_name.append(module)
                retention.append(100 * (results[particle_list]['retention_rate']))
 
        if not at_least_one_entry:
            b2.B2WARNING(particle_list + " seems to have a zero retention rate when created (if created).")
            return
 
        plt.figure()
        bars = plt.barh(module_name, retention, label=particle_list, color=(0.67, 0.15, 0.31, 0.6))
 
        for bar in bars:
            yval = bar.get_width()
            plt.text(0.5, bar.get_y() + bar.get_height() / 2.0 + 0.1, str(round(yval, 3)))
 
        plt.gca().invert_yaxis()
        plt.xticks(rotation=45)
        plt.xlim(0, 100)
        plt.axvline(x=10.0, linewidth=1, linestyle="--", color='k', alpha=0.5)
        plt.xlabel('Retention Rate [%]')
        plt.legend(loc='lower right')
 
        if save_as or cls.output_override:
            if cls.output_override:
                plot_title = (cls.output_override).split(".")[0]
                save_as = plot_title + '.pdf'
            if '/' in save_as:
                os.makedirs(os.path.dirname(save_as), exist_ok=True)
            plt.title(plot_title)
            plt.savefig(save_as, bbox_inches="tight")
            b2.B2RESULT("Retention rate results for list {} saved in {}."
                        .format(particle_list, os.getcwd() + "/" + save_as))
 
 

print_results()

def print_results

(

cls

)

 Print the results, should be called after the path processing.

Definition at line 118 of file retention.py.

---

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

• skim/scripts/skim/utils/retention.py