CMS 3D CMS Logo

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

Public Member Functions

def __init__ (self)
 
def append (self, *args, **kwargs)
 
def appendTable (self, attachToFolder, *args, **kwargs)
 
def clear (self)
 
def getPlotFolder (self, name)
 
def getPlotFolderNames (self)
 
def getPlotFolders (self)
 
def readDirs (self, *files)
 

Private Attributes

 _plots
 

Detailed Description

Contains PlotFolders, i.e. the information what plots to do, and creates a helper object to actually produce the plots.

Definition at line 2962 of file plotting.py.

Constructor & Destructor Documentation

◆ __init__()

def plotting.Plotter.__init__ (   self)

Definition at line 2964 of file plotting.py.

2964  def __init__(self):
2965  self._plots = []
2966  _setStyle()
2967  ROOT.TH1.AddDirectory(False)
2968 

Member Function Documentation

◆ append()

def plotting.Plotter.append (   self,
args,
**  kwargs 
)
Append a plot folder to the plotter.

All arguments are forwarded to the constructor of PlotterItem.

Definition at line 2969 of file plotting.py.

2969  def append(self, *args, **kwargs):
2970  """Append a plot folder to the plotter.
2971 
2972  All arguments are forwarded to the constructor of PlotterItem.
2973  """
2974  self._plots.append(PlotterItem(*args, **kwargs))
2975 

References plotting.PlotGroup._plots, plotting.PlotOnSideGroup._plots, and plotting.Plotter._plots.

Referenced by diclist.diclist.add().

◆ appendTable()

def plotting.Plotter.appendTable (   self,
  attachToFolder,
args,
**  kwargs 
)

Definition at line 2976 of file plotting.py.

2976  def appendTable(self, attachToFolder, *args, **kwargs):
2977  for plotterItem in self._plots:
2978  if plotterItem.getName() == attachToFolder:
2979  plotterItem.appendTableCreator(PlotterTableItem(*args, **kwargs))
2980  return
2981  raise Exception("Did not find plot folder '%s' when trying to attach a table creator to it" % attachToFolder)
2982 

References plotting.PlotGroup._plots, plotting.PlotOnSideGroup._plots, and plotting.Plotter._plots.

◆ clear()

def plotting.Plotter.clear (   self)
Remove all plot folders and tables

Definition at line 2983 of file plotting.py.

2983  def clear(self):
2984  """Remove all plot folders and tables"""
2985  self._plots = []
2986 

References plotting.PlotGroup._plots, plotting.PlotOnSideGroup._plots, and plotting.Plotter._plots.

◆ getPlotFolder()

def plotting.Plotter.getPlotFolder (   self,
  name 
)

Definition at line 2993 of file plotting.py.

2993  def getPlotFolder(self, name):
2994  for item in self._plots:
2995  if item.getName() == name:
2996  return item.getPlotFolder()
2997  raise Exception("No PlotFolder named '%s'" % name)
2998 

References plotting.PlotGroup._plots, plotting.PlotOnSideGroup._plots, and plotting.Plotter._plots.

◆ getPlotFolderNames()

def plotting.Plotter.getPlotFolderNames (   self)

Definition at line 2987 of file plotting.py.

2987  def getPlotFolderNames(self):
2988  return [item.getName() for item in self._plots]
2989 

References plotting.PlotGroup._plots, plotting.PlotOnSideGroup._plots, and plotting.Plotter._plots.

◆ getPlotFolders()

def plotting.Plotter.getPlotFolders (   self)

Definition at line 2990 of file plotting.py.

2990  def getPlotFolders(self):
2991  return [item.getPlotFolder() for item in self._plots]
2992 

References plotting.PlotGroup._plots, plotting.PlotOnSideGroup._plots, and plotting.Plotter._plots.

◆ readDirs()

def plotting.Plotter.readDirs (   self,
files 
)
Returns PlotterInstance object, which knows how exactly to produce the plots for these files

Definition at line 2999 of file plotting.py.

2999  def readDirs(self, *files):
3000  """Returns PlotterInstance object, which knows how exactly to produce the plots for these files"""
3001  return PlotterInstance([plotterItem.readDirs(files) for plotterItem in self._plots])

References plotting.PlotGroup._plots, plotting.PlotOnSideGroup._plots, and plotting.Plotter._plots.

Member Data Documentation

◆ _plots

plotting.Plotter._plots
private
plotting._setStyle
def _setStyle()
Definition: plotting.py:22
clear
void clear(HadCaloObj &c)
Definition: data.h:124
Exception
mps_setup.append
append
Definition: mps_setup.py:85