Inheritance diagram for python.rootplot.root2matplotlib.HistStack:

Public Member Functions
def	__init__ (self, args, kwargs)

def	bar (self, kwargs)

def	bar3d (self, kwargs)

def	barcluster (self, width=0.8, kwargs)

def	barh (self, width=0.8, kwargs)

def	barstack (self, kwargs)

def	errorbar (self, offset=False, kwargs)

def	errorbarh (self, kwargs)

def	hist (self, label_rotation=0, kwargs)

def	histstack (self, kwargs)

def	show_titles (self, kwargs)

Public Member Functions inherited from python.rootplot.utilities.HistStack
def	__getitem__ (self, index)

def	__init__ (self, hists=None, title=None, xlabel=None, ylabel=None)

def	__iter__ (self)

def	__len__ (self)

def	__setitem__ (self, index, value)

def	add (self, hist, kwargs)

def	max (self)

def	min (self, threshold=None)

def	scale (self, factor)

def	stackmax (self)

Public Attributes
	replacements

Public Attributes inherited from python.rootplot.utilities.HistStack
	hists

	kwargs

	title

	xlabel

	ylabel

Detailed Description

A container to hold Hist objects for plotting together.

When plotting, the title and the x and y labels of the last Hist added
will be used unless specified otherwise in the constructor.

Definition at line 228 of file root2matplotlib.py.

Constructor & Destructor Documentation

def python.rootplot.root2matplotlib.HistStack.__init__	(	self,
		args,
		kwargs
	)

Definition at line 235 of file root2matplotlib.py.

     def __init__(self, *args, **kwargs):
         if 'replacements' in kwargs:
             self.replacements = kwargs.pop('replacements')
         utilities.HistStack.__init__(self, *args, **kwargs)

Member Function Documentation

def python.rootplot.root2matplotlib.HistStack.bar	(	self,
		kwargs
	)

Make a bar plot, with all Hists in the stack overlaid.

Any additional keyword arguments will be passed to
:func:`matplotlib.pyplot.bar`.  You will probably want to set a 
transparency value (i.e. *alpha* = 0.5).

Definition at line 369 of file root2matplotlib.py.

     def bar(self, **kwargs):
         """
         Make a bar plot, with all Hists in the stack overlaid.
 
         Any additional keyword arguments will be passed to
         :func:`matplotlib.pyplot.bar`.  You will probably want to set a 
         transparency value (i.e. *alpha* = 0.5).
         """
         plots = []
         for i, hist in enumerate(self.hists):
             if self.title  is not None: hist.title  = self.title
             if self.xlabel is not None: hist.xlabel = self.xlabel
             if self.ylabel is not None: hist.ylabel = self.ylabel
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             bar = hist.bar(**all_kwargs)
             plots.append(bar)
         return plots

def python.rootplot.root2matplotlib.HistStack.bar3d	(	self,
		kwargs
	)

Definition at line 264 of file root2matplotlib.py.

References histograms.Histograms.hists, python.rootplot.utilities.HistStack.hists, personalPlayback.Applet.kwargs, python.rootplot.utilities.HistStack.kwargs, list(), classes.PlotData.title, EventStringOutputBranches::NamedBranchPtr.title, preexistingValidation.PreexistingValidation.title, TriggerOutputBranches::NamedBranchPtr.title, DB_ME.title, TableOutputBranches::NamedBranchPtr.title, cscdqm::HistoBookRequest.title, FWTriggerTableView::Column.title, DQMGenericClient::EfficOption.title, alignment.Alignment.title, DQMGenericClient::ProfileOption.title, dqmoffline::l1t::HistDefinition.title, SiPixelGenErrorHeader.title, python.rootplot.utilities.Hist2D.title, ecaldqm::binning::AxisSpecs.title, big::bigHeader.title, HistogramManager.title, SiPixelTemplateHeader2D.title, presentation.SubsectionBase.title, python.rootplot.utilities.Hist.title, Geometry.title, TkAlMap.TkAlMap.title, TrackerMap.title, SiPixelTemplateHeader.title, python.rootplot.utilities.HistStack.title, python.rootplot.utilities.Hist2D.xlabel, HistogramManager.xlabel, python.rootplot.utilities.Hist.xlabel, python.rootplot.utilities.HistStack.xlabel, python.rootplot.utilities.Hist2D.ylabel, HistogramManager.ylabel, python.rootplot.utilities.Hist.ylabel, python.rootplot.utilities.HistStack.ylabel, and rpcdqm::utils.ylabel.

     def bar3d(self, **kwargs):
         #### Not yet ready for primetime
         from mpl_toolkits.mplot3d import Axes3D
         fig = plt.figure()
         ax = Axes3D(fig)
         plots = []
         labels = []
         for i, hist in enumerate(self.hists):
             if self.title  is not None: hist.title  = self.title
             if self.xlabel is not None: hist.xlabel = self.xlabel
             if self.ylabel is not None: hist.ylabel = self.ylabel
             labels.append(hist.label)
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             bar = ax.bar(hist.x, hist.y, zs=i, zdir='y', width=hist.width,
                          **all_kwargs)
             plots.append(bar)
         from matplotlib.ticker import FixedLocator
         locator = FixedLocator(list(range(len(labels))))
         ax.w_yaxis.set_major_locator(locator)
         ax.w_yaxis.set_ticklabels(labels)
         ax.set_ylim3d(-1, len(labels))
         return plots

def python.rootplot.root2matplotlib.HistStack.barcluster	(	self,
		width = `0.8`,
		kwargs
	)

Make a clustered bar plot.

Any additional keyword arguments will be passed to
:func:`matplotlib.pyplot.bar`.

Definition at line 331 of file root2matplotlib.py.

     def barcluster(self, width=0.8, **kwargs):
         """
         Make a clustered bar plot.
 
         Any additional keyword arguments will be passed to
         :func:`matplotlib.pyplot.bar`.
         """
         plots = []
         spacer = (1. - width) / 2
         width = width / len(self.hists)
         for i, hist in enumerate(self.hists):
             if self.title  is not None: hist.title  = self.title
             if self.xlabel is not None: hist.xlabel = self.xlabel
             if self.ylabel is not None: hist.ylabel = self.ylabel
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             bar = hist.bar(xoffset=width*i + spacer, width=width, **all_kwargs)
             plots.append(bar)
         return plots

def python.rootplot.root2matplotlib.HistStack.barh	(	self,
		width = `0.8`,
		kwargs
	)

Make a horizontal clustered matplotlib bar plot.

Any additional keyword arguments will be passed to
:func:`matplotlib.pyplot.bar`.

Definition at line 350 of file root2matplotlib.py.

     def barh(self, width=0.8, **kwargs):
         """
         Make a horizontal clustered matplotlib bar plot.
 
         Any additional keyword arguments will be passed to
         :func:`matplotlib.pyplot.bar`.
         """
         plots = []
         spacer = (1. - width) / 2
         width = width / len(self.hists)
         for i, hist in enumerate(self.hists):
             if self.title  is not None: hist.title  = self.title
             if self.xlabel is not None: hist.ylabel = self.xlabel
             if self.ylabel is not None: hist.xlabel = self.ylabel
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             bar = hist.barh(yoffset=width*i + spacer, width=width, **all_kwargs)
             plots.append(bar)
         return plots

def python.rootplot.root2matplotlib.HistStack.barstack	(	self,
		kwargs
	)

Make a matplotlib bar plot, with each Hist stacked upon the last.

Any additional keyword arguments will be passed to
:func:`matplotlib.pyplot.bar`.

Definition at line 287 of file root2matplotlib.py.

     def barstack(self, **kwargs):
         """
         Make a matplotlib bar plot, with each Hist stacked upon the last.
 
         Any additional keyword arguments will be passed to
         :func:`matplotlib.pyplot.bar`.
         """
         bottom = None # if this is set to zeroes, it fails for log y
         plots = []
         for i, hist in enumerate(self.hists):
             if self.title  is not None: hist.title  = self.title
             if self.xlabel is not None: hist.xlabel = self.xlabel
             if self.ylabel is not None: hist.ylabel = self.ylabel
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             bar = hist.bar(bottom=bottom, **all_kwargs)
             plots.append(bar)
             if not bottom: bottom = [0. for i in range(self.hists[0].nbins)]
             bottom = [sum(pair) for pair in zip(bottom, hist.y)]
         return plots

def python.rootplot.root2matplotlib.HistStack.errorbar	(	self,
		offset = `False`,
		kwargs
	)

Make a matplotlib errorbar plot, with all Hists in the stack overlaid.

Passing 'offset=True' will slightly offset each dataset so overlapping
errorbars are still visible.  Any additional keyword arguments will
be passed to :func:`matplotlib.pyplot.errorbar`.

Definition at line 387 of file root2matplotlib.py.

     def errorbar(self, offset=False, **kwargs):
         """
         Make a matplotlib errorbar plot, with all Hists in the stack overlaid.
 
         Passing 'offset=True' will slightly offset each dataset so overlapping
         errorbars are still visible.  Any additional keyword arguments will
         be passed to :func:`matplotlib.pyplot.errorbar`.
         """
         plots = []
         for i, hist in enumerate(self.hists):
             if self.title  is not None: hist.title  = self.title
             if self.xlabel is not None: hist.xlabel = self.xlabel
             if self.ylabel is not None: hist.ylabel = self.ylabel
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             transform = plt.gca().transData
             if offset:
                 index_offset = (len(self.hists) - 1)/2.
                 pixel_offset = 1./72 * (i - index_offset)
                 transform = transforms.ScaledTranslation(
                     pixel_offset, 0, plt.gcf().dpi_scale_trans)
                 transform = plt.gca().transData + transform
             errorbar = hist.errorbar(transform=transform, **all_kwargs)
             plots.append(errorbar)
         return plots

def python.rootplot.root2matplotlib.HistStack.errorbarh	(	self,
		kwargs
	)

Make a horizontal matplotlib errorbar plot, with all Hists in the
stack overlaid.

Any additional keyword arguments will be passed to
:func:`matplotlib.pyplot.errorbar`.

Definition at line 412 of file root2matplotlib.py.

     def errorbarh(self, **kwargs):
         """
         Make a horizontal matplotlib errorbar plot, with all Hists in the
         stack overlaid.
 
         Any additional keyword arguments will be passed to
         :func:`matplotlib.pyplot.errorbar`.
         """
         plots = []
         for i, hist in enumerate(self.hists):
             if self.title  is not None: hist.title  = self.title
             if self.xlabel is not None: hist.ylabel = self.xlabel
             if self.ylabel is not None: hist.xlabel = self.ylabel
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             errorbar = hist.errorbarh(**all_kwargs)
             plots.append(errorbar)
         return plots
 

def python.rootplot.root2matplotlib.HistStack.hist	(	self,
		label_rotation = `0`,
		kwargs
	)

Make a matplotlib hist plot.

Any additional keyword arguments will be passed to
:func:`matplotlib.pyplot.hist`, which allows a vast array of
possibilities.  Particlularly, the *histtype* values such as
``'barstacked'`` and ``'stepfilled'`` give substantially different
results.  You will probably want to include a transparency value
(i.e. *alpha* = 0.5).

Definition at line 241 of file root2matplotlib.py.

References histograms.Histograms.hists, python.rootplot.utilities.HistStack.hists, personalPlayback.Applet.kwargs, and python.rootplot.utilities.HistStack.kwargs.

     def hist(self, label_rotation=0, **kwargs):
         """
         Make a matplotlib hist plot.
 
         Any additional keyword arguments will be passed to
         :func:`matplotlib.pyplot.hist`, which allows a vast array of
         possibilities.  Particlularly, the *histtype* values such as
         ``'barstacked'`` and ``'stepfilled'`` give substantially different
         results.  You will probably want to include a transparency value
         (i.e. *alpha* = 0.5).
         """
         contents = np.dstack([hist.y for hist in self.hists])
         xedges = self.hists[0].xedges
         x = np.dstack([hist.x for hist in self.hists])[0]
         labels = [hist.label for hist in self.hists]
         try:
             clist = [item['color'] for item in self.kwargs]
             plt.gca().set_color_cycle(clist)
             ## kwargs['color'] = clist # For newer version of matplotlib
         except:
             pass
         plot = plt.hist(x, weights=contents, bins=xedges,
                         label=labels, **kwargs)

def python.rootplot.root2matplotlib.HistStack.histstack	(	self,
		kwargs
	)

Make a matplotlib hist plot, with each Hist stacked upon the last.

Any additional keyword arguments will be passed to
:func:`matplotlib.pyplot.hist`.

Definition at line 307 of file root2matplotlib.py.

     def histstack(self, **kwargs):
         """
         Make a matplotlib hist plot, with each Hist stacked upon the last.
 
         Any additional keyword arguments will be passed to
         :func:`matplotlib.pyplot.hist`.
         """
         bottom = None # if this is set to zeroes, it fails for log y
         plots = []
         cumhist = None
         for i, hist in enumerate(self.hists):
             if cumhist:
                 cumhist = hist + cumhist
             else:
                 cumhist = copy.copy(hist)
             if self.title  is not None: cumhist.title  = self.title
             if self.xlabel is not None: cumhist.xlabel = self.xlabel
             if self.ylabel is not None: cumhist.ylabel = self.ylabel
             all_kwargs = copy.copy(kwargs)
             all_kwargs.update(self.kwargs[i])
             zorder = 0 + float(len(self) - i)/len(self) # plot in reverse order
             plot = cumhist.hist(zorder=zorder, **all_kwargs)
             plots.append(plot)
         return plots