python.TableConstructorBase.TableConstructorBase Class Reference

Collaboration diagram for python.TableConstructorBase.TableConstructorBase:

Public Member Functions
	__init__ (self, tableObj, underflowThreshold, overflowThreshold)
	getWarningMsgs (self)
	getHistogram (self, name)
	cacheHistograms (self, dirName, prefix)
	getXWeightedIntegral (self, histName, isLog=True)
	saveToFile (self, fileName)
	normalizeColumns (self, denominator)
	fillTable (self, prefix='')
	defineColumns (self)
	fillColumns (self, histName='')
	postProcessing (self)

Public Attributes
	tableObj = tableObj
	columns = OrderedDict()
dict	histograms = {}
list	expectedHistograms = []
	underflowThreshold = underflowThreshold
	overflowThreshold = overflowThreshold
list	warningMsg = []

Detailed Description

 @brief Class representing a single table

Base class trepresenting table. It defines basic behavior common for 
    all the tables like caching histograms or saving table to file. 

Definition at line 61 of file TableConstructorBase.py.

Constructor & Destructor Documentation

__init__()

python.TableConstructorBase.TableConstructorBase.__init__	(		self,
			tableObj,
			underflowThreshold,
			overflowThreshold )

ROOT table directory object, storing subdirs with histograms

Definition at line 68 of file TableConstructorBase.py.

    def __init__(self, tableObj, underflowThreshold, overflowThreshold):
        '''ROOT table directory object, storing subdirs with histograms'''
        self.tableObj = tableObj
 
        '''Dictionary storing the columns. Each column is identified by given name (key)'''
        self.columns = OrderedDict()
 
        '''Map to cache expected histograms'''
        self.histograms = {}
 
        '''List with expected histograms'''
        self.expectedHistograms = []
 
        '''Number of underflow bins after which warning will be saved to metadata tree'''
        self.underflowThreshold = underflowThreshold
 
        '''Number of overflow bins after which warning will be saved to metadata tree'''
        self.overflowThreshold = overflowThreshold
 
        '''Overflow log'''
        self.warningMsg = []
 
 

Member Function Documentation

cacheHistograms()

python.TableConstructorBase.TableConstructorBase.cacheHistograms	(		self,
			dirName,
			prefix )

 @brief Cache histograms in map for given directory

Save histograms in the map by their short name as a key. If the histogram 
with a given name is not found function logs an error.

@param[in] dirName Name of subdirectory to look for histograms
@param[in] prefix Prefix of the histogram name

Definition at line 104 of file TableConstructorBase.py.

    def cacheHistograms(self, dirName, prefix):
        ''' @brief Cache histograms in map for given directory
        
        Save histograms in the map by their short name as a key. If the histogram 
        with a given name is not found function logs an error.
 
        @param[in] dirName Name of subdirectory to look for histograms
        @param[in] prefix Prefix of the histogram name
        
        '''
        dirKey = [key for key in self.tableObj.GetListOfKeys() if key.GetName() == dirName]
        if not dirKey:
            log.error("Subdirectory %s not found", dirName)
 
        dirObj = dirKey[0].ReadObj()
        for histName in self.expectedHistograms:
            fullHistName = prefix + dirName + '_' + histName
            hist = dirObj.Get(fullHistName)
 
            if not hist:
                log.debug("Full name %s", fullHistName)
                log.debug("Directory: %s", dirObj.ls())
                log.error("Expected histogram %s not found", histName)
            else:
                # Check for under and overflows
                # Under/overflow bin stores weighted value - we cannot base on entries
                histIntegral = hist.Integral(0, hist.GetNbinsX() + 1) # Integral including overflows
                overflowThreshold = self.overflowThreshold * histIntegral
                overflow = hist.GetBinContent(hist.GetNbinsX() + 1)
                if overflow > overflowThreshold:
                    log.warning("Histogram {0} contains overflow of {1}".format(fullHistName, overflow))
                    self.warningMsg.append("Overflow of {0} ({1} histogram integral) in {2}".format(overflow, histIntegral, fullHistName))
 
                underflowThreshold = self.underflowThreshold * histIntegral
                underflow = hist.GetBinContent(0)
                if underflow > underflowThreshold and not ignoreUnderflow(fullHistName):
                    log.warning("Histogram {0} contains underflow of {1}".format(fullHistName, underflow))
                    self.warningMsg.append("Underflow of {0} ({1} histogram integral) in {2}".format(underflow, histIntegral, fullHistName))
 
                self.histograms[histName] = hist
 
 

defineColumns()

python.TableConstructorBase.TableConstructorBase.defineColumns

(

self

)

 @brief Define the columns for the table

Columns should be objects of class Column, added to the map self.columns.

Definition at line 226 of file TableConstructorBase.py.

    def defineColumns(self):
        ''' @brief Define the columns for the table
 
        Columns should be objects of class Column, added to the map self.columns.
        '''
        log.error("Should not call defineColumns on base class!")
 
 

fillColumns()

python.TableConstructorBase.TableConstructorBase.fillColumns	(		self,
			histName = '' )

@brief Fill the columns with values 

Definition at line 234 of file TableConstructorBase.py.

    def fillColumns(self, histName=''):
        ''' @brief Fill the columns with values '''
        log.error("Should not call fillColumns on base class!")
 
 

fillTable()

python.TableConstructorBase.TableConstructorBase.fillTable	(		self,
			prefix = '' )

@brief Fill the table based on ROOT directory's content.

Definition at line 213 of file TableConstructorBase.py.

    def fillTable(self, prefix=''):
        ''' @brief Fill the table based on ROOT directory's content.'''
 
        self.defineColumns()
 
        # Fill the columns
        for hist in self.tableObj.GetListOfKeys():
            self.cacheHistograms(hist.GetName(), prefix)
            self.fillColumns(hist.GetName())
 
        self.postProcessing()
 
 

getHistogram()

python.TableConstructorBase.TableConstructorBase.getHistogram	(		self,
			name )

@brief Return cached histogram with given name

Definition at line 96 of file TableConstructorBase.py.

    def getHistogram(self, name):
        ''' @brief Return cached histogram with given name'''
        if name not in self.histograms:
            log.error("Histogram %s not found!", name)
            return None
        return self.histograms[name]
 
 

getWarningMsgs()

python.TableConstructorBase.TableConstructorBase.getWarningMsgs

(

self

)

@brief Raturn warning messages concerning histogram under/over flows 

Definition at line 91 of file TableConstructorBase.py.

    def getWarningMsgs(self):
        ''' @brief Raturn warning messages concerning histogram under/over flows '''
        return self.warningMsg
 
 

getXWeightedIntegral()

python.TableConstructorBase.TableConstructorBase.getXWeightedIntegral	(		self,
			histName,
			isLog = True )

 @brief Get "total" value by integrating over a histogram, weighting every entry by its x-axis mean.

@param[in] histName Histogram name
@param[in] isLog If histogram is log x-axis, modifies how x-axis mean is computed for each bin.

@return Total value of the histogram.

Definition at line 146 of file TableConstructorBase.py.

    def getXWeightedIntegral(self, histName, isLog = True):
        ''' @brief Get "total" value by integrating over a histogram, weighting every entry by its x-axis mean.
 
        @param[in] histName Histogram name
        @param[in] isLog If histogram is log x-axis, modifies how x-axis mean is computed for each bin.
 
        @return Total value of the histogram.
        '''
 
        hist = self.getHistogram(histName)
        if not hist:
            return 0
 
        total = 0
        for i in range(1, hist.GetXaxis().GetNbins()+1):
            if isLog:
                total += hist.GetBinContent(i) * hist.GetXaxis().GetBinCenterLog(i)
            else:
                total += hist.GetBinContent(i) * hist.GetXaxis().GetBinCenter(i)
 
        return total
 
 

normalizeColumns()

python.TableConstructorBase.TableConstructorBase.normalizeColumns	(		self,
			denominator )

 @brief Perform normalization on marked columns 

@param[in] denominator Value to normalize choosen columns

Definition at line 199 of file TableConstructorBase.py.

    def normalizeColumns(self, denominator):
        ''' @brief Perform normalization on marked columns 
        
        @param[in] denominator Value to normalize choosen columns
        '''
        for columnName, column in self.columns.items():
            if column.needNormalizing:
                if fabs(denominator) < 1e-10:
                    log.error("Normalise denominator is zero. Setting %s to zero.", columnName)
                    column.content = [0] * len(column.content)
                else:
                    column.content = [entry/denominator for entry in column.content]
 
 

postProcessing()

python.TableConstructorBase.TableConstructorBase.postProcessing

(

self

)

 @brief Additional operations

Normalization in performed separatly!

Definition at line 239 of file TableConstructorBase.py.

    def postProcessing(self):
        ''' @brief Additional operations
 
        Normalization in performed separatly!
        '''
        pass

saveToFile()

python.TableConstructorBase.TableConstructorBase.saveToFile	(		self,
			fileName )

 @brief Function to save table content to csv file with specified fileName

@param[in] fileName  Name of the file to save the table

Definition at line 169 of file TableConstructorBase.py.

    def saveToFile(self, fileName):
        ''' @brief Function to save table content to csv file with specified fileName
 
        @param[in] fileName  Name of the file to save the table
        '''
 
        from TrigCostAnalysis.Util import convert
        import csv
 
        with open(fileName, mode='w') as csvFile:
            csvWriter = csv.writer(csvFile, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
            
            header = []
            desc = []
            rows = []
            for column in self.columns.values():
                header.append(column.header)
                desc.append(column.headerDesc)
                content = [ convert(entry) for entry in column.content ]
                rows.append(content)
 
            csvWriter.writerow(header)
            csvWriter.writerow(desc)
 
            # Transpose columns to rows
            rows = list(zip(*rows))
            for row in rows:
                csvWriter.writerow(row)
 
 

Member Data Documentation

columns

python.TableConstructorBase.TableConstructorBase.columns = OrderedDict()

Definition at line 73 of file TableConstructorBase.py.

expectedHistograms

list python.TableConstructorBase.TableConstructorBase.expectedHistograms = []

Definition at line 79 of file TableConstructorBase.py.

histograms

dict python.TableConstructorBase.TableConstructorBase.histograms = {}

Definition at line 76 of file TableConstructorBase.py.

overflowThreshold

python.TableConstructorBase.TableConstructorBase.overflowThreshold = overflowThreshold

Definition at line 85 of file TableConstructorBase.py.

tableObj

python.TableConstructorBase.TableConstructorBase.tableObj = tableObj

Definition at line 70 of file TableConstructorBase.py.

underflowThreshold

python.TableConstructorBase.TableConstructorBase.underflowThreshold = underflowThreshold

Definition at line 82 of file TableConstructorBase.py.

warningMsg

list python.TableConstructorBase.TableConstructorBase.warningMsg = []

Definition at line 88 of file TableConstructorBase.py.

---

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

• TableConstructorBase.py