Models.py

Go to the documentation of this file.

#!/usr/bin/env python

from UserTagging.Manager import ObjectSet
from GaudiPython import gbl
import ROOT

class Data(object):
    '''Model for UserData'''
    
    def __init__(self, path=''):
        self.path = path
        self.header = gbl.DayaBay.UserDataHeader()
        ROOT.SetOwnership(self.header, False)
        self.paraSet = ParameterSet()

    # ---------------------------------------
    def save(self):
        """Save Parameters to the UserDataHeader"""   
        
        for paraName, paraClass in self.paraSet.description.items():
            if paraClass == Int:
                self.header.setInt(paraName, self.paraSet.__dict__[paraName])
                self.paraSet.__setattr__(paraName, Int())
            elif paraClass == Float:
                self.header.setFloat(paraName, self.paraSet.__dict__[paraName])
                self.paraSet.__setattr__(paraName, Float())
            elif paraClass == IntArray:
                self.header.setIntArray(paraName, gbl.std.vector('int')())
                for value in self.paraSet.__dict__[paraName]:
                    self.header.get(paraName).value().push_back(value)
                self.paraSet.__setattr__(paraName, IntArray())
            elif paraClass == FloatArray:
                self.header.setFloatArray(paraName, gbl.std.vector('float')())
                for value in self.paraSet.__dict__[paraName]:
                    self.header.get(paraName).value().push_back(value)
                self.paraSet.__setattr__(paraName, FloatArray())
            else:
                raise AttributeError(paraName + ' should not be in the description. ' + str(paraClass))
                                                     
    # ---------------------------------------
    def addInt(self, *paraList):
        self.paraSet.addInt(*paraList)
        return self
    
    def addFloat(self, *paraList):
        self.paraSet.addFloat(*paraList)
        return self
    
    def addIntArray(self, *paraList):
        self.paraSet.addIntArray(*paraList)
        return self
    
    def addFloatArray(self, *paraList):
        self.paraSet.addFloatArray(*paraList)
        return self
                
    # ---------------------------------------
    def set(self, name, value):
        """set Int or Float"""
        try:
            paraClass = self.paraSet.description[name]
        except KeyError:
            raise NameError('Parameter ' + name + ' is not defined yet')
        if paraClass in [Int, Float]:
            self.paraSet.__setattr__(name, value)
        else:
            raise AttributeError('Parameter ' + name + ' is an array. Use append() instead.')        
        
        return self
            
    # ---------------------------------------
    def append(self, name, value):
        """append to IntArray or FloatArray"""
        try:
            paraClass = self.paraSet.description[name]
        except KeyError:
            raise NameError('Parameter ' + name + ' is not defined yet')
        try:
            self.paraSet.__dict__[name].append(value)
        except AttributeError:
            raise AttributeError('Parameter ' + name + ' is not array. Use set() instead.')
        return self

    def get(self, paraName):
        '''wrapper of self.paraSet.get()'''             
        return self.paraSet.get(paraName)
               
    # ---------------------------------------
    def dump(self):
        '''wrapper of self.paraSet.dump()'''    
        print "\n----- dumping ", self.path, ' ------'         
        self.paraSet.dump()
        return self

    # ---------------------------------------
    def setInputHeaders(self, inputHeaders):
        '''
        a workaround on PyROOT's poor verctor support 
        on the original HeaderObject.setInputHeaders() 
        
        inputHeaders: a python list of HeaderObject's
        '''
        self.header.inputHeaders().clear()
        for hdr in inputHeaders:
            self.header.addInputHeader(hdr)
        return self

    # ---------------------------------------
    def addInputHeader(self, hdr):
        self.header.addInputHeader(hdr)
        return self

# =========================================== 
class Tag(object):
    '''Model for UserTag'''
    
    def __init__(self, path=''):
        # the path where the tagHeader saved to, e.g. '/Event/Tag/Detector/AD'
        # path can be empty string, in which case only the data will be saved
        self.path = path
        
        # the 'tagHeader' is saved as a generic HeaderObject
        # this is instantiated at every execution cycle
        self.header = gbl.DayaBay.HeaderObject()
        ROOT.SetOwnership(self.header, False)
        
        # the context, execNumber, earliest, latest properties
        # of the tagHeader will be set the same as the 'baseHeader' HeaderObject
        self.baseHeader = '/Event/Readout/ReadoutHeader'    # default
        
        # at the end of each exec cycle, the algorithm checks 'isTagged'
        # flag, and decide whether of not to save the tag and the user data
        self.isTagged = False
        
        # automatically increased by one for each tagged event
        self.nTagged = 0
        
        # you can save a set of Data's together with the tag        
        self.dataSet = DataSet()
        
    # ---------------------------------------
    def tagIt(self):
        self.isTagged = True

    # ---------------------------------------
    def addData(self, name, path):
        """Add one UserTag"""
        return self.dataSet.addData(name, path)

    # ---------------------------------------
    def getData(self, name):
        """Get the UserTagHeader"""
        return self.dataSet.getData(name)

    # ---------------------------------------
    def setBaseHeader(self, baseHeader):
        self.baseHeader = baseHeader
        return self
        
    # ---------------------------------------
    def setInputHeaders(self, inputHeaders):
        '''
        a workaround on PyROOT's poor verctor support 
        on the original HeaderObject.setInputHeaders() 
        
        inputHeaders: a python list of HeaderObject's
        '''
        self.header.inputHeaders().clear()
        for hdr in inputHeaders:
            self.header.addInputHeader(hdr)
        return self

    # ---------------------------------------
    def addInputHeader(self, hdr):
        self.header.addInputHeader(hdr)
        return self


# =========================================== 
class Int(int):
    pass

# =========================================== 
class Float(float):
    pass

# =========================================== 
class IntArray(list):
    pass
        
# =========================================== 
class FloatArray(list):
    pass
    
# =========================================== 
class ParameterSet(ObjectSet):
    '''Manager for colection of Parameter's'''
    
    def __init__(self):    
        self.classForManaging = (Int, Float, IntArray, FloatArray)
        # description = {name: class} for bookkeeping the attribute
        self.description = {}
        self.getParameter = self.get    # make alias

    # ---------------------------------------
    def addInt(self, *paraList):
        for para in paraList:
            self.__setattr__(para, Int())
        return self
    
    def addFloat(self, *paraList):
        for para in paraList:
            self.__setattr__(para, Float())
        return self
    
    def addIntArray(self, *paraList):
        for para in paraList:
            self.__setattr__(para, IntArray())
        return self
    
    def addFloatArray(self, *paraList):
        for para in paraList:
            self.__setattr__(para, FloatArray())
        return self
                    
    # ---------------------------------------    
    def dump(self):
        '''print all values in the parameter set'''
        for paraName, paraClass in self.description.items():
            print paraName, "\t", self.__dict__[paraName]
                    
# =========================================== 
class DataSet(ObjectSet):
    '''Manager for colection of Data's'''
    
    def __init__(self):  
        self.classForManaging = Data
        # description = {name: class} for bookkeeping the attribute
        self.description = {} 
        self.getData = self.get    # make alias
    
    def addData(self, name, path):
        return ObjectSet.add(self, name, Data(path))    
        
# =========================================== 
class TagSet(ObjectSet):
    '''Manager for colection of Tag's'''
    
    def __init__(self):      
        self.classForManaging = Tag
        # description = {name: class} for bookkeeping the attribute
        self.description = {}
        self.getTag = self.get    # make alias
    
    def addTag(self, name, path=''):
        return ObjectSet.add(self, name, Tag(path))