GaudiMP.pTools.HistoAgent Class Reference

Public Member Functions
def	__init__ (self, gmpComponent)
def	register (self, tup)
def	Receive (self)
def	RebuildHistoStore (self)
def	bookDataObject (self, n, o)
def	bookTH1D (self, n, o)
def	bookTH2D (self, n, o)
def	bookTH3D (self, n, o)
def	bookTProfile (self, n, o)
def	bookTProfile2D (self, n, o)

Public Attributes
	hvt
	histos
	qin
	log
	bookingDict

Private Attributes
	_gmpc

Detailed Description

Definition at line 61 of file pTools.py.

Constructor & Destructor Documentation

__init__()

def GaudiMP.pTools.HistoAgent.__init__	(		self,
			gmpComponent
	)

Definition at line 62 of file pTools.py.

    def __init__(self, gmpComponent):
        self._gmpc = gmpComponent
        self.hvt = self._gmpc.hvt
        self.histos = []
        self.qin = self._gmpc.hq
        self.log = self._gmpc.log
 
        # There are many methods for booking Histogram Objects to Histo store
        # here they are collected in a dictionary, with key = a relevant name
        self.bookingDict = {}
        self.bookingDict["DataObject"] = self.bookDataObject
        self.bookingDict["NTuple::Directory"] = self.bookDataObject
        self.bookingDict["NTuple::File"] = self.bookDataObject
        self.bookingDict["TH1D"] = self.bookTH1D
        self.bookingDict["TH2D"] = self.bookTH2D
        self.bookingDict["TH3D"] = self.bookTH3D
        self.bookingDict["TProfile"] = self.bookTProfile
        self.bookingDict["TProfile2D"] = self.bookTProfile2D
 

Member Function Documentation

bookDataObject()

def GaudiMP.pTools.HistoAgent.bookDataObject	(		self,
			n,
			o
	)

Register a DataObject to the Histo Store

Definition at line 150 of file pTools.py.

    def bookDataObject(self, n, o):
        """
        Register a DataObject to the Histo Store
        """
        self._gmpc.hvt.registerObject(n, o)
 

bookTH1D()

def GaudiMP.pTools.HistoAgent.bookTH1D	(		self,
			n,
			o
	)

Register a ROOT 1D THisto to the Histo Store

Definition at line 156 of file pTools.py.

    def bookTH1D(self, n, o):
        """
        Register a ROOT 1D THisto to the Histo Store
        """
        obj = self.hvt._ihs.book(
            n,
            o.GetTitle(),
            o.GetXaxis().GetNbins(),
            o.GetXaxis().GetXmin(),
            o.GetXaxis().GetXmax(),
        )
        aida2root(obj).Add(o)
 

bookTH2D()

def GaudiMP.pTools.HistoAgent.bookTH2D	(		self,
			n,
			o
	)

Register a ROOT 2D THisto to the Histo Store

Definition at line 169 of file pTools.py.

    def bookTH2D(self, n, o):
        """
        Register a ROOT 2D THisto to the Histo Store
        """
        obj = self.hvt._ihs.book(
            n,
            o.GetTitle(),
            o.GetXaxis().GetNbins(),
            o.GetXaxis().GetXmin(),
            o.GetXaxis().GetXmax(),
            o.GetYaxis().GetNbins(),
            o.GetYaxis().GetXmin(),
            o.GetYaxis().GetXmax(),
        )
        aida2root(obj).Add(o)
 

bookTH3D()

def GaudiMP.pTools.HistoAgent.bookTH3D	(		self,
			n,
			o
	)

Register a ROOT 3D THisto to the Histo Store

Definition at line 185 of file pTools.py.

    def bookTH3D(self, n, o):
        """
        Register a ROOT 3D THisto to the Histo Store
        """
        obj = self.hvt._ihs.book(
            n,
            o.GetTitle(),
            o.GetXaxis().GetXbins(),
            o.GetXaxis().GetXmin(),
            o.GetXaxis().GetXmax(),
            o.GetYaxis().GetXbins(),
            o.GetYaxis().GetXmin(),
            o.GetYaxis().GetXmax(),
            o.GetZaxis().GetXbins(),
            o.GetZaxis().GetXmin(),
            o.GetZaxis().GetXmax(),
        )
        aida2root(obj).Add(o)
 

bookTProfile()

def GaudiMP.pTools.HistoAgent.bookTProfile	(		self,
			n,
			o
	)

Register a ROOT TProfile to the Histo Store

Definition at line 204 of file pTools.py.

    def bookTProfile(self, n, o):
        """
        Register a ROOT TProfile to the Histo Store
        """
        obj = self.hvt._ihs.bookProf(
            n,
            o.GetTitle(),
            o.GetXaxis().GetNbins(),
            o.GetXaxis().GetXmin(),
            o.GetXaxis().GetXmax(),
            o.GetOption(),
        )
        aida2root(obj).Add(o)
 

bookTProfile2D()

def GaudiMP.pTools.HistoAgent.bookTProfile2D	(		self,
			n,
			o
	)

Register a ROOT TProfile2D to the Histo Store

Definition at line 218 of file pTools.py.

    def bookTProfile2D(self, n, o):
        """
        Register a ROOT TProfile2D to the Histo Store
        """
        obj = self.hvt._ihs.bookProf(
            n,
            o.GetTitle(),
            o.GetXaxis().GetNbins(),
            o.GetXaxis().GetXmin(),
            o.GetXaxis().GetXmax(),
            o.GetYaxis().GetNbins(),
            o.GetYaxis().GetXmin(),
            o.GetYaxis().GetXmax(),
        )
        aida2root(obj).Add(o)
 
 
# =============================================================================
 
 

RebuildHistoStore()

def GaudiMP.pTools.HistoAgent.RebuildHistoStore

(

self

)

Rebuild the Histogram Store from the histos received by Receive()
If we have a histo which is not in the store,
book and fill it according to self.bookingDict
If we have a histo with a matching histo in the store,
add the two histos, remembering that aida2root must be used on
the Stored histo for compatibility.

Definition at line 101 of file pTools.py.

    def RebuildHistoStore(self):
        """
        Rebuild the Histogram Store from the histos received by Receive()
        If we have a histo which is not in the store,
        book and fill it according to self.bookingDict
        If we have a histo with a matching histo in the store,
        add the two histos, remembering that aida2root must be used on
        the Stored histo for compatibility.
        """
        errors = 0
        for tup in self.histos:
            workerID, histDict = tup
            added = 0
            booked = 0
 
            for n in histDict.keys():
                o = histDict[n]
                obj = self.hvt.retrieve(n)
 
                if obj:
                    try:
                        aida2root(obj).Add(o)
                    except Exception:
                        self.log.warning("FAILED TO ADD : %s" % (str(obj)))
                        errors += 1
                    added += 1
                else:
                    if o.__class__.__name__ in self.bookingDict.keys():
                        try:
                            self.bookingDict[o.__class__.__name__](n, o)
                        except Exception:
                            self.log.warning(
                                "FAILED TO REGISTER : %s\tto%s"
                                % (o.__class__.__name__, n)
                            )
                            errors += 1
                    else:
                        self.log.warning(
                            "No booking method for: %s\t%s\t%s"
                            % (n, type(o), o.__class__.__name__)
                        )
                        errors += 1
                    booked += 1
        hs = self.hvt.getHistoNames()
        self.log.info("Histo Store Rebuilt : ")
        self.log.info("  Contains %i objects." % (len(hs)))
        self.log.info("  Errors in Rebuilding : %i" % (errors))
        return SUCCESS
 

Receive()

def GaudiMP.pTools.HistoAgent.Receive

(

self

)

Definition at line 86 of file pTools.py.

    def Receive(self):
        hstatus = self._gmpc.nWorkers + 1  # +1 for the Reader!
        while True:
            tup = self.qin.get()
            if tup == "HISTOS_SENT":
                self.log.debug("received HISTOS_SENT message")
                hstatus -= 1
                if not hstatus:
                    break
            else:
                self.register(tup)
        self._gmpc.sEvent.set()
        self.log.info("Writer received all histo bundles and set sync event")
        return SUCCESS
 

register()

def GaudiMP.pTools.HistoAgent.register	(		self,
			tup
	)

Definition at line 81 of file pTools.py.

    def register(self, tup):
        # add a tuple of (worker-id, histoDict) to self.histos
        assert tup.__class__.__name__ == "tuple"
        self.histos.append(tup)
 

Member Data Documentation

_gmpc

GaudiMP.pTools.HistoAgent._gmpc

private

Definition at line 63 of file pTools.py.

bookingDict

GaudiMP.pTools.HistoAgent.bookingDict

Definition at line 71 of file pTools.py.

histos

GaudiMP.pTools.HistoAgent.histos

Definition at line 65 of file pTools.py.

hvt

GaudiMP.pTools.HistoAgent.hvt

Definition at line 64 of file pTools.py.

log

GaudiMP.pTools.HistoAgent.log

Definition at line 67 of file pTools.py.

qin

GaudiMP.pTools.HistoAgent.qin

Definition at line 66 of file pTools.py.

---

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

• GaudiMP/python/GaudiMP/pTools.py