ValidationFiguresOfMerit Class Reference

Inheritance diagram for ValidationFiguresOfMerit:

Collaboration diagram for ValidationFiguresOfMerit:

Public Member Functions
def	__init__ (self, name, description='', check='', contact='', title='')
def	__str__ (self)
def	write (self, tdirectory=None)
def	__setitem__ (self, figure_name, value)
def	__getitem__ (self, figure_name)
def	__delitem__ (self, figure_name)
def	__iter__ (self)
def	__len__ (self)

Public Attributes
	name
	cached name for this figure of merit
	description
	cached description for this figure of merit
	check
	cached user-check action for this figure of merit
	contact
	cached contact person for this figure of merit
	title
	cached title for this figure of merit
	figures_by_name
	cached dictionary of figures for this figure of merit

Detailed Description

Create and write an TNtuple of the validation figures of merit

Definition at line 11 of file fom.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			name,
			description = '',
			check = '',
			contact = '',
			title = ''
	)

Constructor

Definition at line 14 of file fom.py.

    def __init__(
        self,
        name,
        description='',
        check='',
        contact='',
        title='',
    ):
        """Constructor"""
 
        
        self.name = root_save_name(name)
        
        self.description = description
        
        self.check = check
        
        self.contact = contact
        
        self.title = title
 
        
        self.figures_by_name = collections.OrderedDict()
 

Member Function Documentation

__delitem__()

def __delitem__	(		self,
			figure_name
	)

Braketed item deletion for figures of merit

Definition at line 120 of file fom.py.

__getitem__()

def __getitem__	(		self,
			figure_name
	)

Braketed item lookup for figures of merit

Definition at line 115 of file fom.py.

__iter__()

def __iter__

(

self

)

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

Definition at line 125 of file fom.py.

__len__()

def __len__

(

self

)

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

Definition at line 130 of file fom.py.

__setitem__()

def __setitem__	(		self,
			figure_name,
			value
	)

Braketed item assignement for figures of merit

Definition at line 110 of file fom.py.

__str__()

def __str__

(

self

)

Informal string output listing the assigned figures of merit.

Reimplemented in ValidationManyFiguresOfMerit.

Definition at line 38 of file fom.py.

write()

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.

Reimplemented in ValidationManyFiguresOfMerit.

Definition at line 46 of file fom.py.

---

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

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