plotting.FrameRatio Class Reference

Public Member Functions
def	__init__ (self, pad, bounds, zmax, ratioBounds, ratioFactor, nrows, xbinlabels=None, xbinlabelsize=None, xbinlabeloption=None, ratioYTitle=_ratioYTitle)
def	adjustMarginLeft (self, adjust)
def	adjustMarginRight (self, adjust)
def	redrawAxis (self)
def	setGridx (self, grid)
def	setGridy (self, grid)
def	setLogx (self, log)
def	setLogy (self, log)
def	setTitle (self, title)
def	setXLabelSize (self, size)
def	setXTitle (self, title)
def	setXTitleOffset (self, offset)
def	setXTitleSize (self, size)
def	setYTitle (self, title)
def	setYTitleOffset (self, offset)
def	setYTitleRatio (self, title)
def	setYTitleSize (self, size)

Private Attributes
	_coverPad
	_frame
	_frameRatio
	_pad
	_padRatio
	_parentPad

Detailed Description

Class for creating and managing a frame for a ratio plot with two subpads

Definition at line 1311 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def plotting.FrameRatio.__init__	(		self,
			pad,
			bounds,
			zmax,
			ratioBounds,
			ratioFactor,
			nrows,
			xbinlabels = None,
			xbinlabelsize = None,
			xbinlabeloption = None,
			ratioYTitle = _ratioYTitle
	)

Definition at line 1313 of file plotting.py.

    def __init__(self, pad, bounds, zmax, ratioBounds, ratioFactor, nrows, xbinlabels=None, xbinlabelsize=None, xbinlabeloption=None, ratioYTitle=_ratioYTitle):
        self._parentPad = pad
        self._pad = pad.cd(1)
        if xbinlabels is not None:
            self._frame = _drawFrame(self._pad, bounds, zmax, [""]*len(xbinlabels))
        else:
            self._frame = _drawFrame(self._pad, bounds, zmax)
        self._padRatio = pad.cd(2)
        self._frameRatio = _drawFrame(self._padRatio, ratioBounds, zmax, xbinlabels, xbinlabelsize, xbinlabeloption)
 
        self._frame.GetXaxis().SetLabelSize(0)
        self._frame.GetXaxis().SetTitleSize(0)
 
        yoffsetFactor = ratioFactor
        divisionPoint = 1-1/ratioFactor
        xoffsetFactor = 1/divisionPoint #* 0.6
 
        if nrows == 1:
            xoffsetFactor *= 0.6
        elif nrows == 2:
            yoffsetFactor *= 2
            xoffsetFactor *= 1.5
        elif nrows == 3:
            yoffsetFactor *= 4
            xoffsetFactor *= 2.3
        elif nrows >= 4:
            yoffsetFactor *= 5
            xoffsetFactor *= 3
 
        self._frame.GetYaxis().SetTitleOffset(self._frameRatio.GetYaxis().GetTitleOffset()*yoffsetFactor)
        self._frameRatio.GetYaxis().SetLabelSize(int(self._frameRatio.GetYaxis().GetLabelSize()*0.8))
        self._frameRatio.GetYaxis().SetTitleOffset(self._frameRatio.GetYaxis().GetTitleOffset()*yoffsetFactor)
        self._frameRatio.GetXaxis().SetTitleOffset(self._frameRatio.GetXaxis().GetTitleOffset()*xoffsetFactor)
 
        self._frameRatio.GetYaxis().SetNdivisions(4, 5, 0)
 
        self._frameRatio.GetYaxis().SetTitle(ratioYTitle)
 

Member Function Documentation

adjustMarginLeft()

def plotting.FrameRatio.adjustMarginLeft	(		self,
			adjust
	)

Definition at line 1366 of file plotting.py.

    def adjustMarginLeft(self, adjust):
        self._pad.SetLeftMargin(self._pad.GetLeftMargin()+adjust)
        self._padRatio.SetLeftMargin(self._padRatio.GetLeftMargin()+adjust)
        # Need to redraw frame after adjusting the margin
        self._pad.cd()
        self._frame.Draw("")
        self._padRatio.cd()
        self._frameRatio.Draw("")
 

References plotting.Frame._frame, plotting.FrameRatio._frame, plotting.FrameRatio._frameRatio, plotting.Frame._pad, plotting.FrameRatio._pad, plotting.FrameRatio._padRatio, and hippyaddtobaddatafiles.cd().

adjustMarginRight()

def plotting.FrameRatio.adjustMarginRight	(		self,
			adjust
	)

Definition at line 1375 of file plotting.py.

    def adjustMarginRight(self, adjust):
        self._pad.SetRightMargin(self._pad.GetRightMargin()+adjust)
        self._padRatio.SetRightMargin(self._padRatio.GetRightMargin()+adjust)
        # Need to redraw frames after adjusting the margin
        self._pad.cd()
        self._frame.Draw("")
        self._padRatio.cd()
        self._frameRatio.Draw("")
 

References plotting.Frame._frame, plotting.FrameRatio._frame, plotting.FrameRatio._frameRatio, plotting.Frame._pad, plotting.FrameRatio._pad, plotting.FrameRatio._padRatio, and hippyaddtobaddatafiles.cd().

redrawAxis()

def plotting.FrameRatio.redrawAxis

(

self

)

Definition at line 1413 of file plotting.py.

    def redrawAxis(self):
        self._padRatio.RedrawAxis()
        self._pad.RedrawAxis()
 
        self._parentPad.cd()
 
        # pad to hide the lowest y axis label of the main pad
        xmin=0.065
        ymin=0.285
        xmax=0.128
        ymax=0.33
        self._coverPad = ROOT.TPad("coverpad", "coverpad", xmin, ymin, xmax, ymax)
        self._coverPad.SetBorderMode(0)
        self._coverPad.Draw()
 
        self._pad.cd()
        self._pad.Pop() # Move the first pad on top
 

References plotting.Frame._pad, plotting.FrameRatio._pad, plotting.FrameRatio._padRatio, plotting.FrameRatio._parentPad, and hippyaddtobaddatafiles.cd().

setGridx()

def plotting.FrameRatio.setGridx	(		self,
			grid
	)

Definition at line 1358 of file plotting.py.

    def setGridx(self, grid):
        self._pad.SetGridx(grid)
        self._padRatio.SetGridx(grid)
 

References plotting.Frame._pad, plotting.FrameRatio._pad, and plotting.FrameRatio._padRatio.

setGridy()

def plotting.FrameRatio.setGridy	(		self,
			grid
	)

Definition at line 1362 of file plotting.py.

    def setGridy(self, grid):
        self._pad.SetGridy(grid)
        self._padRatio.SetGridy(grid)
 

References plotting.Frame._pad, plotting.FrameRatio._pad, and plotting.FrameRatio._padRatio.

setLogx()

def plotting.FrameRatio.setLogx	(		self,
			log
	)

Definition at line 1351 of file plotting.py.

    def setLogx(self, log):
        self._pad.SetLogx(log)
        self._padRatio.SetLogx(log)
 

References plotting.Frame._pad, plotting.FrameRatio._pad, and plotting.FrameRatio._padRatio.

setLogy()

def plotting.FrameRatio.setLogy	(		self,
			log
	)

Definition at line 1355 of file plotting.py.

    def setLogy(self, log):
        self._pad.SetLogy(log)
 

References plotting.Frame._pad, and plotting.FrameRatio._pad.

setTitle()

def plotting.FrameRatio.setTitle	(		self,
			title
	)

Definition at line 1384 of file plotting.py.

    def setTitle(self, title):
        self._frame.SetTitle(title)
 

References plotting.Frame._frame, and plotting.FrameRatio._frame.

setXLabelSize()

def plotting.FrameRatio.setXLabelSize	(		self,
			size
	)

Definition at line 1396 of file plotting.py.

    def setXLabelSize(self, size):
        self._frameRatio.GetXaxis().SetLabelSize(size)
 

References plotting.FrameRatio._frameRatio.

setXTitle()

def plotting.FrameRatio.setXTitle	(		self,
			title
	)

Definition at line 1387 of file plotting.py.

    def setXTitle(self, title):
        self._frameRatio.GetXaxis().SetTitle(title)
 

References plotting.FrameRatio._frameRatio.

setXTitleOffset()

def plotting.FrameRatio.setXTitleOffset	(		self,
			offset
	)

Definition at line 1393 of file plotting.py.

    def setXTitleOffset(self, offset):
        self._frameRatio.GetXaxis().SetTitleOffset(offset)
 

References plotting.FrameRatio._frameRatio.

setXTitleSize()

def plotting.FrameRatio.setXTitleSize	(		self,
			size
	)

Definition at line 1390 of file plotting.py.

    def setXTitleSize(self, size):
        self._frameRatio.GetXaxis().SetTitleSize(size)
 

References plotting.FrameRatio._frameRatio.

setYTitle()

def plotting.FrameRatio.setYTitle	(		self,
			title
	)

Definition at line 1399 of file plotting.py.

    def setYTitle(self, title):
        self._frame.GetYaxis().SetTitle(title)
 

References plotting.Frame._frame, and plotting.FrameRatio._frame.

setYTitleOffset()

def plotting.FrameRatio.setYTitleOffset	(		self,
			offset
	)

Definition at line 1409 of file plotting.py.

    def setYTitleOffset(self, offset):
        self._frame.GetYaxis().SetTitleOffset(offset)
        self._frameRatio.GetYaxis().SetTitleOffset(offset)
 

References plotting.Frame._frame, plotting.FrameRatio._frame, and plotting.FrameRatio._frameRatio.

setYTitleRatio()

def plotting.FrameRatio.setYTitleRatio	(		self,
			title
	)

Definition at line 1402 of file plotting.py.

    def setYTitleRatio(self, title):
        self._frameRatio.GetYaxis().SetTitle(title)
 

References plotting.FrameRatio._frameRatio.

setYTitleSize()

def plotting.FrameRatio.setYTitleSize	(		self,
			size
	)

Definition at line 1405 of file plotting.py.

    def setYTitleSize(self, size):
        self._frame.GetYaxis().SetTitleSize(size)
        self._frameRatio.GetYaxis().SetTitleSize(size)
 

References plotting.Frame._frame, plotting.FrameRatio._frame, and plotting.FrameRatio._frameRatio.

Member Data Documentation

_coverPad

plotting.FrameRatio._coverPad

private

Definition at line 1424 of file plotting.py.

_frame

plotting.FrameRatio._frame

private

Definition at line 1317 of file plotting.py.

Referenced by plotting.FrameRatio.adjustMarginLeft(), plotting.FrameRatio.adjustMarginRight(), plotting.FrameRatio.setTitle(), plotting.FrameRatio.setYTitle(), plotting.FrameRatio.setYTitleOffset(), and plotting.FrameRatio.setYTitleSize().

_frameRatio

plotting.FrameRatio._frameRatio

private

Definition at line 1321 of file plotting.py.

Referenced by plotting.FrameRatio.adjustMarginLeft(), plotting.FrameRatio.adjustMarginRight(), plotting.FrameRatio.setXLabelSize(), plotting.FrameRatio.setXTitle(), plotting.FrameRatio.setXTitleOffset(), plotting.FrameRatio.setXTitleSize(), plotting.FrameRatio.setYTitleOffset(), plotting.FrameRatio.setYTitleRatio(), and plotting.FrameRatio.setYTitleSize().

_pad

plotting.FrameRatio._pad

private

Definition at line 1315 of file plotting.py.

Referenced by plotting.FrameRatio.adjustMarginLeft(), plotting.FrameRatio.adjustMarginRight(), plotting.FrameTGraph2D.adjustMarginRight(), plotting.FrameRatio.redrawAxis(), plotting.FrameTGraph2D.redrawAxis(), plotting.FrameRatio.setGridx(), plotting.FrameRatio.setGridy(), plotting.FrameRatio.setLogx(), and plotting.FrameRatio.setLogy().

_padRatio

plotting.FrameRatio._padRatio

private

Definition at line 1320 of file plotting.py.

Referenced by plotting.FrameRatio.adjustMarginLeft(), plotting.FrameRatio.adjustMarginRight(), plotting.FrameRatio.redrawAxis(), plotting.FrameRatio.setGridx(), plotting.FrameRatio.setGridy(), and plotting.FrameRatio.setLogx().

_parentPad

plotting.FrameRatio._parentPad

private

Definition at line 1314 of file plotting.py.

Referenced by plotting.FrameRatio.redrawAxis().