python.ROOTUtils Namespace Reference

Classes
class	MyCanvas
class	PlotLibrary
class	StyleFactory

Functions
	protect (obj)
	drawAxisFrame (xmin, xmax, ymin, ymax, title='', xTitleOffset=None, yTitleOffset=None, doPlot=True, protectFrame=True)
	drawHorizontalBand (xmin, xmax, y, ywidth, color=33, protectBand=True, centralLine=False)
	drawText (x=0.74, y=0.87, dy=0.06, text='', font=62, color=1, align=11, linesep=';')
	drawLegend (x1, y1, x2, y2, legendList=[], fillColor=0, lineColor=0, textSize=None, protectLegend=True)
	moveStats (h, dx, dy, xw=0, yw=0, label='')
	atlasLabel (x, y, isPreliminary=False, color=1, offset=0.115, isForApproval=False, energy=8, customstring="", size=0.05)
	atlasStyle (protectStyle=True)
	setStyle (style=None)

Variables
str	__author__ = 'Juerg Beringer'
str	__version__ = '$Id: ROOTUtils.py 759047 2016-07-01 00:45:13Z beringer $'
list	protectedObjectList = []
dict	myCanvasSizes

Detailed Description

Miscellaneous utilities for PyROOT.

Function Documentation

atlasLabel()

python.ROOTUtils.atlasLabel	(		x,
			y,
			isPreliminary = False,
			color = 1,
			offset = 0.115,
			isForApproval = False,
			energy = 8,
			customstring = "",
			size = 0.05 )

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

def atlasLabel(x,y,isPreliminary=False,color=1,offset=0.115,isForApproval=False,energy=8,customstring="",size=0.05):
    if x is None or y is None:
        print ("Must set (x,y) position using --atlasx and --atlasy to add labels.  No ATLAS labels created.")
        return
    offset = offset/0.05*size
    l = ROOT.TLatex()
    l.SetNDC()
    l.SetTextFont(72)
    l.SetTextSize(size)
    l.SetTextColor(color)
    l.DrawLatex(x,y,"ATLAS")
 
    p = ROOT.TLatex()
    p.SetNDC()
    p.SetTextFont(42)
    p.SetTextSize(size)
    p.SetTextColor(color)
 
    if customstring != "":
        p.DrawLatex(x+offset,y,customstring)
    else:
        if (isPreliminary):
            p.DrawLatex(x+offset,y,"Preliminary")
        if (isForApproval):
            #p.DrawLatex(x+offset,y,"Internal for approval")
            p.DrawLatex(x+offset,y,"Internal")
    
    if energy:
        if float(energy)<15:
            p.DrawLatex(x, y-(0.07/0.05*size), "#sqrt{s} = %s TeV" % energy)
        else:
            p.DrawLatex(x, y-(0.07/0.05*size), "#sqrt{s} = %s GeV" % energy)
 
 
 

atlasStyle()

python.ROOTUtils.atlasStyle

(

protectStyle = True

)

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

def atlasStyle(protectStyle=True):
    s = ROOT.TStyle('ATLAS','ATLAS Style V2.02')
 
    # use plain black on white colors
    icol=0  # WHITE
    s.SetFrameBorderMode(icol)
    s.SetFrameFillColor(icol)
    s.SetCanvasBorderMode(icol)
    s.SetCanvasColor(icol)
    s.SetPadBorderMode(icol)
    s.SetPadColor(icol)
    s.SetStatColor(icol)
    #s.SetFillColor(icol) # don't use: white fill color floa *all* objects
 
    # set the paper & margin sizes
    s.SetPaperSize(20,26)
    s.SetPadTopMargin(0.05)
    s.SetPadRightMargin(0.05)
    s.SetPadBottomMargin(0.16)
    s.SetPadLeftMargin(0.16)
 
    # set title offsets (for axis label)
    s.SetTitleXOffset(1.4)
    s.SetTitleYOffset(1.4)
 
    # use large fonts
    #Int_t font=72 # Helvetica italics
    font = 42 # Helvetica
    tsize = 0.05
    s.SetTextFont(font)
 
    s.SetTextSize(tsize)
    s.SetLabelFont(font,"x")
    s.SetTitleFont(font,"x")
    s.SetLabelFont(font,"y")
    s.SetTitleFont(font,"y")
    s.SetLabelFont(font,"z")
    s.SetTitleFont(font,"z")
 
    s.SetLabelSize(tsize,"x")
    s.SetTitleSize(tsize,"x")
    s.SetLabelSize(tsize,"y")
    s.SetTitleSize(tsize,"y")
    s.SetLabelSize(tsize,"z")
    s.SetTitleSize(tsize,"z")
 
    # use bold lines and markers
    s.SetMarkerStyle(20)
    s.SetMarkerSize(1.2)
    s.SetHistLineWidth(2)
    s.SetLineStyleString(2,"[12 12]") # postscript dashes
 
    # get rid of X error bars and y error bar caps
    #s.SetErrorX(0.001)
 
    # get rid of error bar caps
    s.SetEndErrorSize(0.)
 
    # do not display any of the standard histogram decorations
    s.SetOptTitle(0)
    #s.SetOptStat(1111)
    s.SetOptStat(0)
    #s.SetOptFit(1111)
    s.SetOptFit(0)
 
    # put tick marks on top and RHS of plots
    s.SetPadTickX(1)
    s.SetPadTickY(1)
 
    if protectStyle:
        protect(s)
 
    return s
 
 

drawAxisFrame()

python.ROOTUtils.drawAxisFrame	(		xmin,
			xmax,
			ymin,
			ymax,
			title = '',
			xTitleOffset = None,
			yTitleOffset = None,
			doPlot = True,
			protectFrame = True )

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

def drawAxisFrame(xmin,xmax,ymin,ymax,title='',xTitleOffset=None,yTitleOffset=None,doPlot=True,protectFrame=True):
    frame = ROOT.TH2F('axisFrame',title,100,xmin,xmax,100,ymin,ymax)
    frame.SetStats(False)
    if xTitleOffset is not None:
        frame.GetXaxis().SetTitleOffset(xTitleOffset)
    if yTitleOffset is not None:
        frame.GetYaxis().SetTitleOffset(yTitleOffset)
    if doPlot:
        frame.Draw()
    if protectFrame:
        protect(frame)
    return frame
 
 

drawHorizontalBand()

python.ROOTUtils.drawHorizontalBand	(		xmin,
			xmax,
			y,
			ywidth,
			color = 33,
			protectBand = True,
			centralLine = False )

Draw a horizontal band of width +-ywidth. Nice colors are 19 and 33.

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

def drawHorizontalBand(xmin,xmax,y,ywidth,color=33,protectBand=True,centralLine=False):
    """Draw a horizontal band of width +-ywidth. Nice colors are 19 and 33."""
    b = ROOT.TH1F('band','band',1,xmin,xmax)
    b.SetBinContent(1,y)
    b.SetBinError(1,ywidth)
    b.SetFillColor(color)
    b.SetMarkerColor(color)
    b.SetMarkerSize(0.01)
    b.Draw('SAMEe2')
    if centralLine:
        b.Draw('SAMEL')
    if protectBand:
        protect(b)
    return b
 
 

drawLegend()

python.ROOTUtils.drawLegend	(		x1,
			y1,
			x2,
			y2,
			legendList = [],
			fillColor = 0,
			lineColor = 0,
			textSize = None,
			protectLegend = True )

Draw a legend with one or more entries. legendList is a list of lists,
   where each inner list defines the object, text and option of a legend entry.
   NOTE: Must store returned TLegend, otherwise legend will disappear!

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

def drawLegend(x1,y1,x2,y2,legendList=[],fillColor=0,lineColor=0,textSize=None,protectLegend=True):
    """Draw a legend with one or more entries. legendList is a list of lists,
       where each inner list defines the object, text and option of a legend entry.
       NOTE: Must store returned TLegend, otherwise legend will disappear!"""
    nlines = len(legendList)
    if not nlines:
        print ("ERROR: drawLegend called w/o any legend entries")
    #maxchar = 0
    #for e in legendList:
    #    maxchar = max(len(e[1]),maxchar)
    #l = ROOT.TLegend(x,y-nlines*s,x+(2+maxchar)*s/3.7,y)
    l = ROOT.TLegend(x1,y1,x2,y2)
    l.SetFillColor(fillColor)
    l.SetLineColor(lineColor)
    l.SetShadowColor(lineColor)
    if textSize:
        l.SetTextSize(textSize)
    for e in legendList:
        l.AddEntry(e[0],e[1],e[2])
    l.Draw()
    if protectLegend:
        protect(l)
    return l
 
 

drawText()

python.ROOTUtils.drawText	(		x = 0.74,
			y = 0.87,
			dy = 0.06,
			text = '',
			font = 62,
			color = 1,
			align = 11,
			linesep = ';' )

Draw a variable number of lines of text.

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

def drawText(x=0.74,y=0.87,dy=0.06,text='',font=62,color=1,align=11,linesep=';'):
    """Draw a variable number of lines of text."""
    t = ROOT.TLatex()
    t.SetNDC()
    t.SetTextFont(font)
    t.SetTextColor(color)
    t.SetTextAlign(align)
    t.SetTextSize(dy/1.2)
    for line in text.split(linesep):
        t.DrawLatex(x,y,line)
        y = y-dy
    # Seems TLatex text doesn't need to be protected - why not?
    return t
 
 
#def drawLegend(x=0.18,y=0.9,s=0.07,legendList=[],fillColor=0,lineColor=0):

moveStats()

python.ROOTUtils.moveStats	(		h,
			dx,
			dy,
			xw = 0,
			yw = 0,
			label = '' )

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

def moveStats(h,dx,dy,xw=0,yw=0,label=''):
    if not h:
        return
    ROOT.gPad.Update()    
    st = h.GetListOfFunctions().FindObject('stats')
    if not st:
        print ('ERROR: No stats found - cannot move it')
        return
    st.SetTextColor(h.GetLineColor())
    st.SetX1NDC(st.GetX1NDC()+dx)
    st.SetY1NDC(st.GetY1NDC()+dy)
    st.SetX2NDC(st.GetX2NDC()+xw if xw!=0 else st.GetX2NDC()+dx)
    st.SetY2NDC(st.GetY2NDC()+yw if yw!=0 else st.GetY2NDC()+dy)
    if not label:
        h.SetName(label)
    ROOT.gPad.Modified()
    ROOT.gPad.Update
 
 

protect()

python.ROOTUtils.protect

(

obj

)

Utility function to prevent ROOT objects from being garbage-collected,
   (thus disappearing from plots) when they go out of scope.

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

def protect(obj):
    """Utility function to prevent ROOT objects from being garbage-collected,
       (thus disappearing from plots) when they go out of scope."""
    protectedObjectList.append(obj)
    return obj
 
 
# Define a set of useful canvas sizes for different purposes

setStyle()

python.ROOTUtils.setStyle

(

style = None

)

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

def setStyle(style = None):
    if not style:
        style = atlasStyle()
    print ('\nApplying style %s (%s) ...\n' % (style.GetName(),style.GetTitle()))
    ROOT.gROOT.SetStyle(style.GetName())
    ROOT.gROOT.ForceStyle()

Variable Documentation

__author__

str python.ROOTUtils.__author__ = 'Juerg Beringer'

private

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

__version__

str python.ROOTUtils.__version__ = '$Id: ROOTUtils.py 759047 2016-07-01 00:45:13Z beringer $'

private

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

myCanvasSizes

dict python.ROOTUtils.myCanvasSizes

Initial value:

=  { 'default': (700, 500),
                  'default2d': (545, 500),
                  'slide1': (900,560),
                  'slide2': (450,560),
                  'slide2text': (400,500),
                  'fig1': (700, 500),
                  'fig2': (1400, 500),
                  'page': (750,1000),
                  'landscape': (1600,1000),
                  'wide': (1000,500),
                  'extrawide': (1500,500),
                  'square': (700,700)
                  }

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

protectedObjectList

list python.ROOTUtils.protectedObjectList = []

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