plotting.Frame Class Reference

Public Member Functions
def	__init__ (self, pad, bounds, zmax, nrows, xbinlabels=None, xbinlabelsize=None, xbinlabeloption=None, ybinlabels=None)
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	setYTitleSize (self, size)

Private Attributes
	_frame
	_pad

Detailed Description

Class for creating and managing a frame for a simple, one-pad plot

Definition at line 1240 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def plotting.Frame.__init__	(		self,
			pad,
			bounds,
			zmax,
			nrows,
			xbinlabels = None,
			xbinlabelsize = None,
			xbinlabeloption = None,
			ybinlabels = None
	)

Definition at line 1242 of file plotting.py.

    def __init__(self, pad, bounds, zmax, nrows, xbinlabels=None, xbinlabelsize=None, xbinlabeloption=None, ybinlabels=None):
        self._pad = pad
        self._frame = _drawFrame(pad, bounds, zmax, xbinlabels, xbinlabelsize, xbinlabeloption, ybinlabels)
 
        yoffsetFactor = 1
        xoffsetFactor = 1
        if nrows == 2:
            yoffsetFactor *= 2
            xoffsetFactor *= 2
        elif nrows >= 5:
            yoffsetFactor *= 1.5
            xoffsetFactor *= 1.5
        elif nrows >= 3:
            yoffsetFactor *= 4
            xoffsetFactor *= 3
 
        self._frame.GetYaxis().SetTitleOffset(self._frame.GetYaxis().GetTitleOffset()*yoffsetFactor)
        self._frame.GetXaxis().SetTitleOffset(self._frame.GetXaxis().GetTitleOffset()*xoffsetFactor)
 
 

Member Function Documentation

adjustMarginLeft()

def plotting.Frame.adjustMarginLeft	(		self,
			adjust
	)

Definition at line 1274 of file plotting.py.

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

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

adjustMarginRight()

def plotting.Frame.adjustMarginRight	(		self,
			adjust
	)

Definition at line 1280 of file plotting.py.

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

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

redrawAxis()

def plotting.Frame.redrawAxis

(

self

)

Definition at line 1310 of file plotting.py.

    def redrawAxis(self):
        self._pad.RedrawAxis()
 

References plotting.Frame._pad.

setGridx()

def plotting.Frame.setGridx	(		self,
			grid
	)

Definition at line 1268 of file plotting.py.

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

References plotting.Frame._pad.

setGridy()

def plotting.Frame.setGridy	(		self,
			grid
	)

Definition at line 1271 of file plotting.py.

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

References plotting.Frame._pad.

setLogx()

def plotting.Frame.setLogx	(		self,
			log
	)

Definition at line 1262 of file plotting.py.

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

References plotting.Frame._pad.

setLogy()

def plotting.Frame.setLogy	(		self,
			log
	)

Definition at line 1265 of file plotting.py.

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

References plotting.Frame._pad.

setTitle()

def plotting.Frame.setTitle	(		self,
			title
	)

Definition at line 1286 of file plotting.py.

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

References plotting.Frame._frame.

setXLabelSize()

def plotting.Frame.setXLabelSize	(		self,
			size
	)

Definition at line 1298 of file plotting.py.

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

References plotting.Frame._frame.

setXTitle()

def plotting.Frame.setXTitle	(		self,
			title
	)

Definition at line 1289 of file plotting.py.

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

References plotting.Frame._frame.

setXTitleOffset()

def plotting.Frame.setXTitleOffset	(		self,
			offset
	)

Definition at line 1295 of file plotting.py.

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

References plotting.Frame._frame.

setXTitleSize()

def plotting.Frame.setXTitleSize	(		self,
			size
	)

Definition at line 1292 of file plotting.py.

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

References plotting.Frame._frame.

setYTitle()

def plotting.Frame.setYTitle	(		self,
			title
	)

Definition at line 1301 of file plotting.py.

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

References plotting.Frame._frame.

setYTitleOffset()

def plotting.Frame.setYTitleOffset	(		self,
			offset
	)

Definition at line 1307 of file plotting.py.

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

References plotting.Frame._frame.

setYTitleSize()

def plotting.Frame.setYTitleSize	(		self,
			size
	)

Definition at line 1304 of file plotting.py.

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

References plotting.Frame._frame.

Member Data Documentation

_frame

plotting.Frame._frame

private

Definition at line 1244 of file plotting.py.

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

_pad

plotting.Frame._pad

private

Definition at line 1243 of file plotting.py.

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