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, 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 1236 of file plotting.py.

Constructor & Destructor Documentation

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

Definition at line 1238 of file plotting.py.

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

Member Function Documentation

def plotting.Frame.adjustMarginLeft (   self,
  adjust 
)

Definition at line 1270 of file plotting.py.

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

Definition at line 1276 of file plotting.py.

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

Definition at line 1306 of file plotting.py.

1306  def redrawAxis(self):
1307  self._pad.RedrawAxis()
1308 
def redrawAxis(self)
Definition: plotting.py:1306
def plotting.Frame.setGridx (   self,
  grid 
)

Definition at line 1264 of file plotting.py.

1264  def setGridx(self, grid):
1265  self._pad.SetGridx(grid)
1266 
def setGridx(self, grid)
Definition: plotting.py:1264
def plotting.Frame.setGridy (   self,
  grid 
)

Definition at line 1267 of file plotting.py.

1267  def setGridy(self, grid):
1268  self._pad.SetGridy(grid)
1269 
def setGridy(self, grid)
Definition: plotting.py:1267
def plotting.Frame.setLogx (   self,
  log 
)

Definition at line 1258 of file plotting.py.

1258  def setLogx(self, log):
1259  self._pad.SetLogx(log)
1260 
def setLogx(self, log)
Definition: plotting.py:1258
def plotting.Frame.setLogy (   self,
  log 
)

Definition at line 1261 of file plotting.py.

1261  def setLogy(self, log):
1262  self._pad.SetLogy(log)
1263 
def setLogy(self, log)
Definition: plotting.py:1261
def plotting.Frame.setTitle (   self,
  title 
)

Definition at line 1282 of file plotting.py.

1282  def setTitle(self, title):
1283  self._frame.SetTitle(title)
1284 
def setTitle(self, title)
Definition: plotting.py:1282
def plotting.Frame.setXLabelSize (   self,
  size 
)

Definition at line 1294 of file plotting.py.

1294  def setXLabelSize(self, size):
1295  self._frame.GetXaxis().SetLabelSize(size)
1296 
def setXLabelSize(self, size)
Definition: plotting.py:1294
def plotting.Frame.setXTitle (   self,
  title 
)

Definition at line 1285 of file plotting.py.

1285  def setXTitle(self, title):
1286  self._frame.GetXaxis().SetTitle(title)
1287 
def setXTitle(self, title)
Definition: plotting.py:1285
def plotting.Frame.setXTitleOffset (   self,
  offset 
)

Definition at line 1291 of file plotting.py.

1291  def setXTitleOffset(self, offset):
1292  self._frame.GetXaxis().SetTitleOffset(offset)
1293 
def setXTitleOffset(self, offset)
Definition: plotting.py:1291
def plotting.Frame.setXTitleSize (   self,
  size 
)

Definition at line 1288 of file plotting.py.

1288  def setXTitleSize(self, size):
1289  self._frame.GetXaxis().SetTitleSize(size)
1290 
def setXTitleSize(self, size)
Definition: plotting.py:1288
def plotting.Frame.setYTitle (   self,
  title 
)

Definition at line 1297 of file plotting.py.

1297  def setYTitle(self, title):
1298  self._frame.GetYaxis().SetTitle(title)
1299 
def setYTitle(self, title)
Definition: plotting.py:1297
def plotting.Frame.setYTitleOffset (   self,
  offset 
)

Definition at line 1303 of file plotting.py.

1303  def setYTitleOffset(self, offset):
1304  self._frame.GetYaxis().SetTitleOffset(offset)
1305 
def setYTitleOffset(self, offset)
Definition: plotting.py:1303
def plotting.Frame.setYTitleSize (   self,
  size 
)

Definition at line 1300 of file plotting.py.

1300  def setYTitleSize(self, size):
1301  self._frame.GetYaxis().SetTitleSize(size)
1302 
def setYTitleSize(self, size)
Definition: plotting.py:1300

Member Data Documentation

plotting.Frame._frame
private

Definition at line 1240 of file plotting.py.

plotting.Frame._pad
private

Definition at line 1239 of file plotting.py.