GaudiAlg.HistoUtils.HistoFile Class Reference

Public Member Functions
def	__init__ (self, fileName)
def	save (self, *args)
def	close (self)

Public Attributes
	file
	aida2root
	aidaTypes

Private Member Functions
def	__convertibleType (self, histo)

Static Private Attributes
	__author__

Detailed Description

Class to write histograms to a ROOT file.
hFile = HistoFile("myFile.root")
myHisto = ...
hFile.save(myHisto)
myHisto0 = ...
myHisto1 = ...
myHisto2 = ...
hFile.save(myHisto0, myHisto1, myHisto2)
histoList = [h0, h1, h2, h3]
hFile.save(histoList)
...
hWriter.close()

Definition at line 1008 of file HistoUtils.py.

Constructor & Destructor Documentation

__init__()

def GaudiAlg.HistoUtils.HistoFile.__init__	(		self,
			fileName
	)

Definition at line 1026 of file HistoUtils.py.

    def __init__(self, fileName):
        self.file = ROOT.TFile(fileName, "RECREATE")
        from GaudiPython import gbl
 
        self.aida2root = gbl.Gaudi.Utils.Aida2ROOT.aida2root
        self.aidaTypes = [
            gbl.AIDA.IHistogram1D,
            gbl.AIDA.IHistogram2D,
            gbl.AIDA.IHistogram3D,
            gbl.AIDA.IProfile1D,
            gbl.AIDA.IProfile2D,
            gbl.AIDA.IHistogram,
        ]
 

Member Function Documentation

__convertibleType()

def GaudiAlg.HistoUtils.HistoFile.__convertibleType (   self,   histo  )

private

Definition at line 1040 of file HistoUtils.py.

    def __convertibleType(self, histo):
        histoType = type(histo)
        for t in self.aidaTypes:
            if histoType == t:
                return True
        return False
 

close()

def GaudiAlg.HistoUtils.HistoFile.close

(

self

)

Definition at line 1063 of file HistoUtils.py.

    def close(self):
        self.file.Write()
        self.file.Close()
 
 
# =============================================================================

save()

def GaudiAlg.HistoUtils.HistoFile.save	(		self,
		*	args
	)

This function stores histograms on the file for future saving.
It takes an arbitrary number of AIDA or ROOT histograms or
a list of them.

Definition at line 1047 of file HistoUtils.py.

    def save(self, *args):
        """
        This function stores histograms on the file for future saving.
        It takes an arbitrary number of AIDA or ROOT histograms or
        a list of them.
        """
        if args:
            if isinstance(args[0], list):
                histoList = args[0]
            else:
                histoList = args
            for h in histoList:
                if self.__convertibleType(h):
                    h = self.aida2root(h)
                h.Write()
 

Member Data Documentation

__author__

GaudiAlg.HistoUtils.HistoFile.__author__

staticprivate

Definition at line 1024 of file HistoUtils.py.

aida2root

GaudiAlg.HistoUtils.HistoFile.aida2root

Definition at line 1030 of file HistoUtils.py.

aidaTypes

GaudiAlg.HistoUtils.HistoFile.aidaTypes

Definition at line 1031 of file HistoUtils.py.

file

GaudiAlg.HistoUtils.HistoFile.file

Definition at line 1027 of file HistoUtils.py.

---

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

• GaudiAlg/python/GaudiAlg/HistoUtils.py