ValidationManyFiguresOfMerit Class Reference

Inheritance diagram for ValidationManyFiguresOfMerit:

Public Member Functions
	__str__ (self)
	write (self, tdirectory=None)
	__setitem__ (self, figure_name, value)
	__getitem__ (self, figure_name)
	__delitem__ (self, figure_name)
	__iter__ (self)
	__len__ (self)

Public Attributes
	name = root_save_name(name)
	cached name for this figure of merit
	description = description
	cached description for this figure of merit
	check = check
	cached user-check action for this figure of merit
	contact = contact
	cached contact person for this figure of merit
	title = title
	cached title for this figure of merit
	figures_by_name = collections.OrderedDict()
	cached dictionary of figures for this figure of merit

Detailed Description

Create and write an TNtuple with several validation figures of merit

Definition at line 144 of file fom.py.

Member Function Documentation

__delitem__()

__delitem__ ( self, figure_name )

inherited

Braketed item deletion for figures of merit

Definition at line 128 of file fom.py.

    def __delitem__(self, figure_name):
        """Braketed item deletion for figures of merit"""
 
        del self.figures_by_name[figure_name]
 

__getitem__()

__getitem__ ( self, figure_name )

inherited

Braketed item lookup for figures of merit

Definition at line 123 of file fom.py.

    def __getitem__(self, figure_name):
        """Braketed item lookup for figures of merit"""
 
        return self.figures_by_name[figure_name]
 

__iter__()

__iter__ ( self )

inherited

Implements the iter() hook as if it was a dictionary.

Definition at line 133 of file fom.py.

    def __iter__(self):
        """Implements the iter() hook as if it was a dictionary."""
 
        return iter(self.figures_by_name)
 

__len__()

__len__ ( self )

inherited

Returns the number of figures of merit assigned. Implements the len() hook.

Definition at line 138 of file fom.py.

    def __len__(self):
        """Returns the number of figures of merit assigned. Implements the len() hook."""
 
        return len(self.figures_by_name)
 
 

__setitem__()

__setitem__ ( self, figure_name, value )

inherited

Braketed item assignment for figures of merit

Definition at line 118 of file fom.py.

    def __setitem__(self, figure_name, value):
        """Braketed item assignment for figures of merit"""
 
        self.figures_by_name[figure_name] = value
 

__str__()

__str__

(

self

)

Describe myself

Definition at line 147 of file fom.py.

    def __str__(self):
        """Describe myself"""
        return 'Not supported.'
 

write()

write	(		self,
			tdirectory = None )

Writes the figures of merit as a TNtuple.

Parameters
----------
tdirectory : ROOT.TDirectory, optional
    The directory to which the TNtuple shall be written.
    Defaults to the current directory.

Reimplemented from ValidationFiguresOfMerit.

Definition at line 151 of file fom.py.

    def write(self, tdirectory=None):
        """Writes the figures of merit as a TNtuple.
 
        Parameters
        ----------
        tdirectory : ROOT.TDirectory, optional
            The directory to which the TNtuple shall be written.
            Defaults to the current directory.
        """
        name = self.name
        figure_names = [root_save_name(key) for key in list(self.figures_by_name.keys())]
        values = list(self.figures_by_name.values())
 
        leaf_specification = ':'.join(figure_names)
        title = self.title or ""
        ntuple = ROOT.TNtuple(name, title, leaf_specification)
 
        for value in zip(*values):
            ntuple.Fill(*value)
 
        ntuple.SetAlias('Description', self.description)
        ntuple.SetAlias('Check', self.check)
        ntuple.SetAlias('Contact', self.contact)
 
        with root_cd(tdirectory):
            ntuple.Write()

Member Data Documentation

check

check = check

inherited

cached user-check action for this figure of merit

Definition at line 37 of file fom.py.

contact

contact = contact

inherited

cached contact person for this figure of merit

Definition at line 39 of file fom.py.

description

description = description

inherited

cached description for this figure of merit

Definition at line 35 of file fom.py.

figures_by_name

figures_by_name = collections.OrderedDict()

inherited

cached dictionary of figures for this figure of merit

Definition at line 44 of file fom.py.

name

name = root_save_name(name)

inherited

cached name for this figure of merit

Definition at line 33 of file fom.py.

title

title = title

inherited

cached title for this figure of merit

Definition at line 41 of file fom.py.

---

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

• tracking/scripts/tracking/validation/fom.py