Inheritance diagram for PlotUtils.PlotUtils:

Collaboration diagram for PlotUtils.PlotUtils:

Public Member Functions
def	__init__ (self, size=18, status="Internal", lumi=1., sqrts="13", normalizedToUnity=False)

def	DrawTLatex (self, x, y, text, size=18, font=43, align=11, ndc=True, color=-1)

def	GetStatus (self)

def	GetLumi (self)

def	DrawAtlas (self, x, y, align=11)

def	DrawLumiSqrtS (self, x, y, align=11, lumi=1.)

def	DrawSqrtS (self, x, y, align=11)

def	CreateLegend (self, x1, y1, x2, y2, textsize=22)

def	GetLegend (self, x1=0, y1=1., x2=1., y2=1.)

def	AddToLegend (self, Items, Style="FL")

def	DrawLegend (self, NperCol=3)

def	DrawSource (self, probe, x, y, align=11)

def	Prepare1PadCanvas (self, cname, width=800, height=600, isQuad=False)

def	GetCanvas (self)

def	Prepare2PadCanvas (self, cname, width=800, height=600, isQuad=False, DoLogX=False)

def	GetTopPad (self)

def	GetBottomPad (self)

def	AdaptLabelsTopPad (self, histos)

def	AdaptLabelsBottomPad (self, histos, scale=1.)

def	drawStyling (self, Template, ymin, ymax, TopPad=True, RemoveLabel=False)

def	addValuesInText (self, histo, on_top=True, off_set_y=0.005)

def	saveHisto (self, name, outputfiletypes)

Private Member Functions
def	__AddItemToLegend (self, Item, Style)

Private Attributes
	__Status

	__Size

	__Lumi

	__SqrtS

	__VerticalCanvasSplit

	__Canvas

	__Pad1

	__Pad2

	__Styling

	__RatStyling

	__Legend

	__NLegEnt

	__normalizedToUnity

	__Objects

Detailed Description

Definition at line 97 of file PlotUtils.py.

Constructor & Destructor Documentation

◆ init()

def PlotUtils.PlotUtils.__init__	(	self,
		size = `18`,
		status = `"Internal"`,
		lumi = `1.`,
		sqrts = `"13"`,
		normalizedToUnity = `False`
	)

Definition at line 98 of file PlotUtils.py.

     def __init__(self, size=18, status="Internal", lumi=1., sqrts="13", normalizedToUnity=False):
         self.__Status = status
         self.__Size = size
         self.__Lumi = lumi  # in fb^-1
         self.__SqrtS = sqrts
         self.__VerticalCanvasSplit = 0.4
         self.__Canvas = None
         self.__Pad1 = None        
         self.__Pad2 = None
         self.__Styling = None
         self.__RatStyling = None
         self.__Legend = None
         self.__NLegEnt = 0
         self.__normalizedToUnity = normalizedToUnity
         self.__Objects = []
  

Member Function Documentation

◆ __AddItemToLegend()

def PlotUtils.PlotUtils.__AddItemToLegend	(	self,
		Item,
		Style
	)

private

Definition at line 173 of file PlotUtils.py.

     def __AddItemToLegend(self, Item, Style):
         try:
             self.__Legend.AddEntry(Item, Item.GetTitle(), Style)
         except:
             self.__Legend.AddEntry(Item.get(), Item.GetTitle(), Style)
  
         self.__NLegEnt += 1
  

◆ AdaptLabelsBottomPad()

def PlotUtils.PlotUtils.AdaptLabelsBottomPad	(	self,
		histos,
		scale = `1.`
	)

Definition at line 238 of file PlotUtils.py.

     def AdaptLabelsBottomPad(self, histos, scale=1.):
         if self.__VerticalCanvasSplit == 0:
             labelscalefact = 1.
         else:
             labelscalefact = 1. / (scale * self.__VerticalCanvasSplit)
         for hist in histos:
             hist.GetXaxis().SetTitleSize(labelscalefact * hist.GetXaxis().GetTitleSize())
             hist.GetYaxis().SetTitleSize(labelscalefact * hist.GetYaxis().GetTitleSize())
             hist.GetXaxis().SetLabelSize(labelscalefact * hist.GetXaxis().GetLabelSize())
             hist.GetYaxis().SetLabelSize(labelscalefact * hist.GetYaxis().GetLabelSize())
             hist.GetXaxis().SetTitleOffset(2.2 / labelscalefact * hist.GetXaxis().GetTitleOffset())
             hist.GetYaxis().SetTitleOffset(1.05 / labelscalefact * hist.GetYaxis().GetTitleOffset())
  

◆ AdaptLabelsTopPad()

def PlotUtils.PlotUtils.AdaptLabelsTopPad	(	self,
		histos
	)

Definition at line 228 of file PlotUtils.py.

     def AdaptLabelsTopPad(self, histos):
         labelscalefact = 1. / (1. - self.__VerticalCanvasSplit)
         for hist in histos:
             hist.GetXaxis().SetTitleSize(labelscalefact * hist.GetXaxis().GetTitleSize())
             hist.GetYaxis().SetTitleSize(labelscalefact * hist.GetYaxis().GetTitleSize())
             hist.GetXaxis().SetLabelSize(labelscalefact * hist.GetXaxis().GetLabelSize())
             hist.GetYaxis().SetLabelSize(labelscalefact * hist.GetYaxis().GetLabelSize())
             hist.GetXaxis().SetTitleOffset(1. / labelscalefact * hist.GetXaxis().GetTitleOffset())
             hist.GetYaxis().SetTitleOffset(1. / labelscalefact * hist.GetYaxis().GetTitleOffset())
  

◆ AddToLegend()

def PlotUtils.PlotUtils.AddToLegend	(	self,
		Items,
		Style = `"FL"`
	)

Definition at line 166 of file PlotUtils.py.

     def AddToLegend(self, Items, Style="FL"):
         if isinstance(Items, list):
             for I in Items:
                 self.__AddItemToLegend(I, Style)
         else:
             self.__AddItemToLegend(Items, Style)
  

◆ addValuesInText()

def PlotUtils.PlotUtils.addValuesInText	(	self,
		histo,
		on_top = `True`,
		off_set_y = `0.005`
	)

Definition at line 260 of file PlotUtils.py.

     def addValuesInText(self, histo, on_top=True, off_set_y=0.005):
         plot_range_x = (histo.GetXaxis().GetBinUpEdge(histo.GetNbinsX()) - histo.GetXaxis().GetBinLowEdge(1)) / (
             (1 - self.GetCanvas().GetRightMargin()) - self.GetCanvas().GetLeftMargin())
         plot_range_y = (histo.GetMaximum() - histo.GetMinimum())
  
         left_margin = self.GetCanvas().GetLeftMargin()
         bottom_margin = 0
         if on_top and self.__Pad1:
             plot_range_y /= (1 - self.__Pad1.GetTopMargin() - self.__Pad1.GetBottomMargin())
             bottom_margin = self.__Pad1.GetBottomMargin()
  
         elif on_top and self.GetCanvas():
             plot_range_y /= (1 - self.GetCanvas().GetTopMargin() - self.GetCanvas().GetBottomMargin())
             bottom_margin = self.GetCanvas().GetBottomMargin()
         elif not on_top and self.__Pad2:
             plot_range_y /= (1 - self.__Pad2.GetTopMargin() - self.__Pad2.GetBottomMargin())
             bottom_margin = self.__Pad2.GetBottomMargin()
  
         for i in range(1, histo.GetNbinsX() + 1):
             tex = self.DrawTLatex(
                 left_margin + ((histo.GetBinCenter(i) - histo.GetXaxis().GetBinLowEdge(1)) / plot_range_x),
                 bottom_margin + (histo.GetBinContent(i) + off_set_y - histo.GetMinimum()) / plot_range_y,
                 "%.3f" % (histo.GetBinContent(i)),
                 size=10,
                 align=21,
                 color=histo.GetLineColor(),
             )

◆ CreateLegend()

def PlotUtils.PlotUtils.CreateLegend	(	self,
		x1,
		y1,
		x2,
		y2,
		textsize = `22`
	)

Definition at line 151 of file PlotUtils.py.

     def CreateLegend(self, x1, y1, x2, y2, textsize=22):
         if self.__Legend:
             print "WARNING: There already exists a legend. Will delete the old one"
             del self.__Legend
         self.__Legend = ROOT.TLegend(x1, y1, x2, y2)
         self.__Legend.SetFillStyle(0)
         self.__Legend.SetBorderSize(0)
         self.__Legend.SetTextFont(43)
         self.__Legend.SetTextSize(textsize)
         return self.__Legend
  

◆ DrawAtlas()

def PlotUtils.PlotUtils.DrawAtlas	(	self,
		x,
		y,
		align = `11`
	)

Definition at line 130 of file PlotUtils.py.

     def DrawAtlas(self, x, y, align=11):
         # print "Size is %.2f"%self.__Size
         self.DrawTLatex(x, y, "#font[72]{ATLAS} %s" % self.__Status, self.__Size, 43, align)
  

◆ DrawLegend()

def PlotUtils.PlotUtils.DrawLegend	(	self,
		NperCol = `3`
	)

Definition at line 181 of file PlotUtils.py.

     def DrawLegend(self, NperCol=3):
         if not self.__Legend:
             print "No legend has been defined yet"
             return
         N = self.__NLegEnt
         Col = int((N - N % NperCol) / NperCol + (N % NperCol > 0))
         if Col < 1: Col = 1
         self.__Legend.SetNColumns(Col)
         self.__Legend.Draw()
  

◆ DrawLumiSqrtS()

def PlotUtils.PlotUtils.DrawLumiSqrtS	(	self,
		x,
		y,
		align = `11`,
		lumi = `1.`
	)

Definition at line 134 of file PlotUtils.py.

     def DrawLumiSqrtS(self, x, y, align=11, lumi=1.):
         if self.__normalizedToUnity: self.DrawTLatex(x, y, "#sqrt{s} = %s TeV" % (self.__SqrtS), self.__Size, 43, align)
         elif self.__Lumi >= 999999999: self.DrawTLatex(x, y, "#sqrt{s} = %s TeV, ?? pb^{-1}" % (self.__SqrtS), self.__Size, 43, align)
         elif self.__Lumi < 1.e-6:
             lumiToPrint = "%.0f" % (self.__Lumi * 1e6)
             self.DrawTLatex(x, y, "#sqrt{s} = %s TeV, %s nb^{-1}" % (self.__SqrtS, lumiToPrint), self.__Size, 43, align)
         elif self.__Lumi < 1.e-3:
             lumiToPrint = "%.0f" % (self.__Lumi * 1e3)
             self.DrawTLatex(x, y, "#sqrt{s} = %s TeV, %s pb^{-1}" % (self.__SqrtS, lumiToPrint), self.__Size, 43, align)
         else:
             lumiToPrint = "%.1f" % (self.__Lumi)
             self.DrawTLatex(x, y, "#sqrt{s} = %s TeV, %s fb^{-1}" % (self.__SqrtS, lumiToPrint), self.__Size, 43, align)
  

◆ DrawSource()

def PlotUtils.PlotUtils.DrawSource	(	self,
		probe,
		x,
		y,
		align = `11`
	)

Definition at line 191 of file PlotUtils.py.

     def DrawSource(self, probe, x, y, align=11):
         self.DrawTLatex(x, y, self.ProbeName(probe), self.__Size, 43, align)
  

◆ DrawSqrtS()

def PlotUtils.PlotUtils.DrawSqrtS	(	self,
		x,
		y,
		align = `11`
	)

Definition at line 147 of file PlotUtils.py.

     def DrawSqrtS(self, x, y, align=11):
         self.DrawTLatex(x, y, "#sqrt{s} = %s TeV" % (self.__SqrtS), self.__Size, 43, align)

◆ drawStyling()

def PlotUtils.PlotUtils.drawStyling	(	self,
		Template,
		ymin,
		ymax,
		TopPad = `True`,
		RemoveLabel = `False`
	)

Definition at line 251 of file PlotUtils.py.

     def drawStyling(self, Template, ymin, ymax, TopPad=True, RemoveLabel=False):
         self.__Styling = Template.Clone("Style" + Template.GetName())
         self.__Styling.SetMinimum(ymin)
         self.__Styling.SetMaximum(ymax)
  
         if RemoveLabel == True: self.__Styling.GetXaxis().SetLabelOffset(10.)
         if TopPad: self.AdaptLabelsTopPad([self.__Styling])
         self.__Styling.Draw("AXIS")
  

◆ DrawTLatex()

def PlotUtils.PlotUtils.DrawTLatex	(	self,
		x,
		y,
		text,
		size = `18`,
		font = `43`,
		align = `11`,
		ndc = `True`,
		color = `-1`
	)

Definition at line 114 of file PlotUtils.py.

     def DrawTLatex(self, x, y, text, size=18, font=43, align=11, ndc=True, color=-1):
         tex = ROOT.TLatex()
         tex.SetTextAlign(align)
         tex.SetTextSize(size)
         tex.SetTextFont(font)
         if ndc: tex.SetNDC()
         if color > -1: tex.SetTextColor(color)
         self.__Objects.append(tex)
         tex.DrawLatex(x, y, text)
  

◆ GetBottomPad()

def PlotUtils.PlotUtils.GetBottomPad ( self )

Definition at line 226 of file PlotUtils.py.

226 def GetBottomPad(self):

227 return self.__Pad2

◆ GetCanvas()

def PlotUtils.PlotUtils.GetCanvas ( self )

Definition at line 204 of file PlotUtils.py.

     def GetCanvas(self):
         if not self.__Canvas: print "WARNING: No Canvas has been created yet. Please call CreateXPadCanvas() before"
         return self.__Canvas
  

◆ GetLegend()

def PlotUtils.PlotUtils.GetLegend	(	self,
		x1 = `0`,
		y1 = `1.`,
		x2 = `1.`,
		y2 = `1.`
	)

Definition at line 162 of file PlotUtils.py.

     def GetLegend(self, x1=0, y1=1., x2=1., y2=1.):
         if not self.__Legend: return CreateLegend(x1, y1, x2, y2)
         return self.__Legend
  

◆ GetLumi()

def PlotUtils.PlotUtils.GetLumi ( self )

Definition at line 127 of file PlotUtils.py.

     def GetLumi(self):
         return self.__Lumi
  

◆ GetStatus()

def PlotUtils.PlotUtils.GetStatus ( self )

Definition at line 124 of file PlotUtils.py.

     def GetStatus(self):
         return self.__Status
  

◆ GetTopPad()

def PlotUtils.PlotUtils.GetTopPad ( self )

Definition at line 224 of file PlotUtils.py.

224 def GetTopPad(self):

225 return self.__Pad1

◆ Prepare1PadCanvas()

def PlotUtils.PlotUtils.Prepare1PadCanvas	(	self,
		cname,
		width = `800`,
		height = `600`,
		isQuad = `False`
	)

Definition at line 194 of file PlotUtils.py.

     def Prepare1PadCanvas(self, cname, width=800, height=600, isQuad=False):
         if isQuad: height = width
         if self.__Canvas:
             if self.__Canvas.GetName() != cname: self.__Canvas = None
             else:
                 print "INFO Already found a canvas named: " + cname
                 return self.__Canvas
         self.__Canvas = ROOT.TCanvas(cname, cname, width, height)
         self.__Canvas.cd()
     

◆ Prepare2PadCanvas()

def PlotUtils.PlotUtils.Prepare2PadCanvas	(	self,
		cname,
		width = `800`,
		height = `600`,
		isQuad = `False`,
		DoLogX = `False`
	)

Definition at line 208 of file PlotUtils.py.

     def Prepare2PadCanvas(self, cname, width=800, height=600, isQuad=False, DoLogX=False):
         self.Prepare1PadCanvas(cname, width, height, isQuad)
  
         self.__Pad1 = ROOT.TPad(cname+"Pad1", cname, 0.0, self.__VerticalCanvasSplit - 0.03, 1.0, 1.0)
         self.__Pad2 = ROOT.TPad(cname+"Pad2", cname, 0.0, 0.0, 1.0, self.__VerticalCanvasSplit - 0.03)
         if DoLogX:
             self.__Pad1.SetLogx()
             self.__Pad2.SetLogx()
         self.__Pad1.SetBottomMargin(0.03)  # set to 0 for space between top and bottom pad
         self.__Pad1.SetTopMargin(0.09)
         self.__Pad1.Draw()
         self.__Pad2.SetTopMargin(0.01)  # set to 0 for space between top and bottom pad
         self.__Pad2.SetBottomMargin(0.35)
         self.__Pad2.SetGridy()
         self.__Pad2.Draw()
  

◆ saveHisto()

def PlotUtils.PlotUtils.saveHisto	(	self,
		name,
		outputfiletypes
	)

Definition at line 287 of file PlotUtils.py.

     def saveHisto(self, name, outputfiletypes):
         Path = RemoveSpecialChars(name)
         if Path.find("/") != -1: 
             dir_name = Path[ : Path.rfind("/") ]
             os.system("mkdir -p %s"%(dir_name))
         if "png" in outputfiletypes:
             # need a 'pdf' file for using 'convert' to create a 'png'
             if not "pdf" in outputfiletypes:
                 outputfiletypes.append("pdf")
             a, b = outputfiletypes.index('pdf'), outputfiletypes.index('png')
             outputfiletypes[b], outputfiletypes[a] = outputfiletypes[a], outputfiletypes[b]
         if self.GetBottomPad(): self.GetBottomPad().RedrawAxis()
         if self.GetTopPad(): self.GetTopPad().RedrawAxis()
  
         for otype in outputfiletypes:
             if otype != "png":
                 self.__Canvas.SaveAs("%s.%s" % (Path, otype))
             else:
                 # due to problems in png creation, convert pdfs to pngs manually
                 os.system("convert -density 300 %s.pdf %s.png" % (Path, Path))

Member Data Documentation

◆ __Canvas

PlotUtils.PlotUtils.__Canvas

private

Definition at line 104 of file PlotUtils.py.

◆ __Legend

PlotUtils.PlotUtils.__Legend

private

Definition at line 109 of file PlotUtils.py.

◆ __Lumi

PlotUtils.PlotUtils.__Lumi

private

Definition at line 101 of file PlotUtils.py.

◆ __NLegEnt

PlotUtils.PlotUtils.__NLegEnt

private

Definition at line 110 of file PlotUtils.py.

◆ __normalizedToUnity

PlotUtils.PlotUtils.__normalizedToUnity

private

Definition at line 111 of file PlotUtils.py.

◆ __Objects

PlotUtils.PlotUtils.__Objects

private

Definition at line 112 of file PlotUtils.py.

◆ __Pad1

PlotUtils.PlotUtils.__Pad1

private

Definition at line 105 of file PlotUtils.py.

◆ __Pad2

PlotUtils.PlotUtils.__Pad2

private

Definition at line 106 of file PlotUtils.py.

◆ __RatStyling

PlotUtils.PlotUtils.__RatStyling

private

Definition at line 108 of file PlotUtils.py.

◆ __Size

PlotUtils.PlotUtils.__Size

private

Definition at line 100 of file PlotUtils.py.

◆ __SqrtS

PlotUtils.PlotUtils.__SqrtS

private

Definition at line 102 of file PlotUtils.py.

◆ __Status

PlotUtils.PlotUtils.__Status

private

Definition at line 99 of file PlotUtils.py.

◆ __Styling

PlotUtils.PlotUtils.__Styling

private

Definition at line 107 of file PlotUtils.py.

◆ __VerticalCanvasSplit

PlotUtils.PlotUtils.__VerticalCanvasSplit

private

Definition at line 103 of file PlotUtils.py.

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

PlotUtils.py

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __AddItemToLegend()

◆ AdaptLabelsBottomPad()

◆ AdaptLabelsTopPad()

◆ AddToLegend()

◆ addValuesInText()

◆ CreateLegend()

◆ DrawAtlas()

◆ DrawLegend()

◆ DrawLumiSqrtS()

◆ DrawSource()

◆ DrawSqrtS()

◆ drawStyling()

◆ DrawTLatex()

◆ GetBottomPad()

◆ GetCanvas()

◆ GetLegend()

◆ GetLumi()

◆ GetStatus()

◆ GetTopPad()

◆ Prepare1PadCanvas()

◆ Prepare2PadCanvas()

◆ saveHisto()

Member Data Documentation

◆ __Canvas

◆ __Legend

◆ __Lumi

◆ __NLegEnt

◆ __normalizedToUnity

◆ __Objects

◆ __Pad1

◆ __Pad2

◆ __RatStyling

◆ __Size

◆ __SqrtS

◆ __Status

◆ __Styling

◆ __VerticalCanvasSplit

◆ init()