CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes
plotting.Frame Class Reference

Public Member Functions

def __init__ (self, pad, bounds, 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 1233 of file plotting.py.

Constructor & Destructor Documentation

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

Definition at line 1235 of file plotting.py.

1235  def __init__(self, pad, bounds, nrows, xbinlabels=None, xbinlabelsize=None, xbinlabeloption=None, ybinlabels=None):
1236  self._pad = pad
1237  self._frame = _drawFrame(pad, bounds, xbinlabels, xbinlabelsize, xbinlabeloption, ybinlabels)
1238 
1239  yoffsetFactor = 1
1240  xoffsetFactor = 1
1241  if nrows == 2:
1242  yoffsetFactor *= 2
1243  xoffsetFactor *= 2
1244  elif nrows >= 5:
1245  yoffsetFactor *= 1.5
1246  xoffsetFactor *= 1.5
1247  elif nrows >= 3:
1248  yoffsetFactor *= 4
1249  xoffsetFactor *= 3
1250 
1251  self._frame.GetYaxis().SetTitleOffset(self._frame.GetYaxis().GetTitleOffset()*yoffsetFactor)
1252  self._frame.GetXaxis().SetTitleOffset(self._frame.GetXaxis().GetTitleOffset()*xoffsetFactor)
1253 
1254 
def __init__(self, pad, bounds, nrows, xbinlabels=None, xbinlabelsize=None, xbinlabeloption=None, ybinlabels=None)
Definition: plotting.py:1235
def _drawFrame(pad, bounds, xbinlabels=None, xbinlabelsize=None, xbinlabeloption=None, ybinlabels=None, suffix="")
Definition: plotting.py:1183

Member Function Documentation

def plotting.Frame.adjustMarginLeft (   self,
  adjust 
)

Definition at line 1267 of file plotting.py.

1267  def adjustMarginLeft(self, adjust):
1268  self._pad.SetLeftMargin(self._pad.GetLeftMargin()+adjust)
1269  # Need to redraw frame after adjusting the margin
1270  self._pad.cd()
1271  self._frame.Draw("")
1272 
def adjustMarginLeft(self, adjust)
Definition: plotting.py:1267
def plotting.Frame.adjustMarginRight (   self,
  adjust 
)

Definition at line 1273 of file plotting.py.

1273  def adjustMarginRight(self, adjust):
1274  self._pad.SetRightMargin(self._pad.GetRightMargin()+adjust)
1275  # Need to redraw frame after adjusting the margin
1276  self._pad.cd()
1277  self._frame.Draw("")
1278 
def adjustMarginRight(self, adjust)
Definition: plotting.py:1273
def plotting.Frame.redrawAxis (   self)

Definition at line 1303 of file plotting.py.

1303  def redrawAxis(self):
1304  self._pad.RedrawAxis()
1305 
def redrawAxis(self)
Definition: plotting.py:1303
def plotting.Frame.setGridx (   self,
  grid 
)

Definition at line 1261 of file plotting.py.

1261  def setGridx(self, grid):
1262  self._pad.SetGridx(grid)
1263 
def setGridx(self, grid)
Definition: plotting.py:1261
def plotting.Frame.setGridy (   self,
  grid 
)

Definition at line 1264 of file plotting.py.

1264  def setGridy(self, grid):
1265  self._pad.SetGridy(grid)
1266 
def setGridy(self, grid)
Definition: plotting.py:1264
def plotting.Frame.setLogx (   self,
  log 
)

Definition at line 1255 of file plotting.py.

1255  def setLogx(self, log):
1256  self._pad.SetLogx(log)
1257 
def setLogx(self, log)
Definition: plotting.py:1255
def plotting.Frame.setLogy (   self,
  log 
)

Definition at line 1258 of file plotting.py.

1258  def setLogy(self, log):
1259  self._pad.SetLogy(log)
1260 
def setLogy(self, log)
Definition: plotting.py:1258
def plotting.Frame.setTitle (   self,
  title 
)

Definition at line 1279 of file plotting.py.

1279  def setTitle(self, title):
1280  self._frame.SetTitle(title)
1281 
def setTitle(self, title)
Definition: plotting.py:1279
def plotting.Frame.setXLabelSize (   self,
  size 
)

Definition at line 1291 of file plotting.py.

1291  def setXLabelSize(self, size):
1292  self._frame.GetXaxis().SetLabelSize(size)
1293 
def setXLabelSize(self, size)
Definition: plotting.py:1291
def plotting.Frame.setXTitle (   self,
  title 
)

Definition at line 1282 of file plotting.py.

1282  def setXTitle(self, title):
1283  self._frame.GetXaxis().SetTitle(title)
1284 
def setXTitle(self, title)
Definition: plotting.py:1282
def plotting.Frame.setXTitleOffset (   self,
  offset 
)

Definition at line 1288 of file plotting.py.

1288  def setXTitleOffset(self, offset):
1289  self._frame.GetXaxis().SetTitleOffset(offset)
1290 
def setXTitleOffset(self, offset)
Definition: plotting.py:1288
def plotting.Frame.setXTitleSize (   self,
  size 
)

Definition at line 1285 of file plotting.py.

1285  def setXTitleSize(self, size):
1286  self._frame.GetXaxis().SetTitleSize(size)
1287 
def setXTitleSize(self, size)
Definition: plotting.py:1285
def plotting.Frame.setYTitle (   self,
  title 
)

Definition at line 1294 of file plotting.py.

1294  def setYTitle(self, title):
1295  self._frame.GetYaxis().SetTitle(title)
1296 
def setYTitle(self, title)
Definition: plotting.py:1294
def plotting.Frame.setYTitleOffset (   self,
  offset 
)

Definition at line 1300 of file plotting.py.

1300  def setYTitleOffset(self, offset):
1301  self._frame.GetYaxis().SetTitleOffset(offset)
1302 
def setYTitleOffset(self, offset)
Definition: plotting.py:1300
def plotting.Frame.setYTitleSize (   self,
  size 
)

Definition at line 1297 of file plotting.py.

1297  def setYTitleSize(self, size):
1298  self._frame.GetYaxis().SetTitleSize(size)
1299 
def setYTitleSize(self, size)
Definition: plotting.py:1297

Member Data Documentation

plotting.Frame._frame
private

Definition at line 1237 of file plotting.py.

plotting.Frame._pad
private

Definition at line 1236 of file plotting.py.