python.ROOTUtils.PlotLibrary Class Reference

Collaboration diagram for python.ROOTUtils.PlotLibrary:

Public Member Functions
def	__init__ (self, name='MyPlots', otherMethods=[])
def	protect (self, obj)
def	plot (self, plotName='', *args)
def	genPlot (self, what='ALL', code='plot', labels=[], *args)

Public Attributes
	name
	otherMethods
	rootObjects
	whatList
	singleCanvasSize
	allCanvasSize
	allCanvasDivs
	saveAsList
	gPadSaveAsList

Detailed Description

PlotLibrary is a base class that can be used to manage a set of
   plots. Each individual plot should be created as a method of a
   derived class.  Other methods of the derived class that do not
   generate plots should either have names starting with
   underscore, or should be declared when calling __init__ of the
   base class.

Definition at line 74 of file python/ROOTUtils.py.

Constructor & Destructor Documentation

__init__()

def python.ROOTUtils.PlotLibrary.__init__	(		self,
			name = 'MyPlots',
			otherMethods = []
	)

Constructor. otherMethods specifies a list of methods of the derived
   class that are not creating plots and should not be called by plot().

Definition at line 82 of file python/ROOTUtils.py.

    def __init__(self, name = 'MyPlots', otherMethods=[]):
        """Constructor. otherMethods specifies a list of methods of the derived
           class that are not creating plots and should not be called by plot()."""
        self.name = name
        self.otherMethods = []
        self.otherMethods.extend(otherMethods)
        self.rootObjects = []
 
        # Variables used by genPlot
        self.whatList = []
        self.singleCanvasSize = 'default'
        self.allCanvasSize = 'page'
        self.allCanvasDivs = (3,4)
        self.saveAsList = []
        self.gPadSaveAsList = []
 

Member Function Documentation

genPlot()

def python.ROOTUtils.PlotLibrary.genPlot	(		self,
			what = 'ALL',
			code = 'plot',
			labels = [],
		*	args
	)

Make plots using a general code. genPlot makes either a single plot defined
   by argument what, or all plots (if what=''). The plots made in the latter
   case are specified by whatList. A canvas that is subdivided if necessary
   is created before the plotting code is called.

Definition at line 113 of file python/ROOTUtils.py.

    def genPlot(self,what='ALL',code='plot',labels=[],*args):
        """Make plots using a general code. genPlot makes either a single plot defined
           by argument what, or all plots (if what=''). The plots made in the latter
           case are specified by whatList. A canvas that is subdivided if necessary
           is created before the plotting code is called."""
        if what=='' or what.upper()=='ALL':
            c = self.protect( MyCanvas('%s-%s-%s' % (self.name,what,code),
                                       self.allCanvasSize,self.allCanvasDivs[0],self.allCanvasDivs[1]) )
            iCanvas = 0
            for w in self.whatList:
                iCanvas += 1
                c.cd(iCanvas)
                try:
                    self.__class__.__dict__[code](self,w,*args)
                except Exception:
                    self.__class__.__bases__[0].__dict__[code](self,w,*args)
                ROOT.gPad.Update()
                # For some strange reason, this works only for .eps, but not e.g. for gif files...???
                for o in self.gPadSaveAsList:
                    if o[0]=='.':
                        ROOT.gPad.SaveAs('%s-%s-%s%s' % (self.name,code,w,o))
                    else:
                        ROOT.gPad.SaveAs(o)
 
            # If we want to put some labels on an empty pad, add them now.
            if labels!=[] and self.allCanvasDivs[0]*self.allCanvasDivs[1] > len(self.whatList):
                iCanvas+=1
                c.cd(iCanvas)
                xtext=0.0
                ytext=0.8
                for label in labels:
                    drawText(xtext,ytext,0.06,label)
                    ytext=ytext-0.1
            elif labels!=[]:
                print ("ERROR: can't add labels unless we have an empty pad to use.  Ignoring labels.")
 
            for o in self.saveAsList:
                if o[0]=='.':
                    c.SaveAs('%s-%s-%s%s' % (self.name,code,what,o))
                else:
                    c.SaveAs(o)
 
        else:
            c = self.protect( MyCanvas(what,self.singleCanvasSize) )
            try:
                self.__class__.__dict__[code](self,what,*args)
            except Exception:
                self.__class__.__bases__[0].__dict__[code](self,what,*args)
            ROOT.gPad.Update()
            for o in self.saveAsList:
                if o[0]=='.':
                    c.SaveAs('%s-%s-%s%s' % (self.name,code,what,o))
                else:
                    c.SaveAs(o)
 

plot()

def python.ROOTUtils.PlotLibrary.plot	(		self,
			plotName = '',
		*	args
	)

Make one or all (if plotName=='') plots.

Definition at line 103 of file python/ROOTUtils.py.

    def plot(self, plotName='',*args):
        """Make one or all (if plotName=='') plots."""
        if plotName:
            self.__class__.__dict__[plotName](self,*args)
        else:
            for i in self.__class__.__dict__:
                if i[0]=='_': continue  # skip private methods
                if i in self.otherMethods: continue
                self.__class__.__dict__[i](self,*args)
 

protect()

def python.ROOTUtils.PlotLibrary.protect	(		self,
			obj
	)

Protect ROOT object from garbage collection.

Definition at line 98 of file python/ROOTUtils.py.

    def protect(self,obj):
        """Protect ROOT object from garbage collection."""
        self.rootObjects.append(obj)
        return obj
 

Member Data Documentation

allCanvasDivs

python.ROOTUtils.PlotLibrary.allCanvasDivs

Definition at line 94 of file python/ROOTUtils.py.

allCanvasSize

python.ROOTUtils.PlotLibrary.allCanvasSize

Definition at line 93 of file python/ROOTUtils.py.

gPadSaveAsList

python.ROOTUtils.PlotLibrary.gPadSaveAsList

Definition at line 96 of file python/ROOTUtils.py.

name

python.ROOTUtils.PlotLibrary.name

Definition at line 85 of file python/ROOTUtils.py.

otherMethods

python.ROOTUtils.PlotLibrary.otherMethods

Definition at line 86 of file python/ROOTUtils.py.

rootObjects

python.ROOTUtils.PlotLibrary.rootObjects

Definition at line 88 of file python/ROOTUtils.py.

saveAsList

python.ROOTUtils.PlotLibrary.saveAsList

Definition at line 95 of file python/ROOTUtils.py.

singleCanvasSize

python.ROOTUtils.PlotLibrary.singleCanvasSize

Definition at line 92 of file python/ROOTUtils.py.

whatList

python.ROOTUtils.PlotLibrary.whatList

Definition at line 91 of file python/ROOTUtils.py.

---

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

• python/ROOTUtils.py