Inheritance diagram for python.rootplot.utilities.HistStack:

Public Member Functions
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
	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 310 of file utilities.py.

Constructor & Destructor Documentation

def python.rootplot.utilities.HistStack.__init__	(	self,
		hists = `None`,
		title = `None`,
		xlabel = `None`,
		ylabel = `None`
	)

Definition at line 317 of file utilities.py.

     def __init__(self, hists=None, title=None, xlabel=None, ylabel=None):
         self.hists  = []
         self.kwargs = []
         self.title  = title
         self.xlabel = xlabel
         self.ylabel = ylabel
         if hists:
             for hist in hists:
                 self.add(hist)

Member Function Documentation

def python.rootplot.utilities.HistStack.__getitem__	(	self,
		index
	)

Return indexth hist: x.__getitem__(y) <==> x[y]

Definition at line 326 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

     def __getitem__(self, index):
         """Return indexth hist: x.__getitem__(y) <==> x[y]"""
         return self.hists[index]

def python.rootplot.utilities.HistStack.__iter__ ( self )

Iterate through hists in the stack: x.__iter__() <==> iter(x)

Definition at line 335 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

     def __iter__(self):
         """Iterate through hists in the stack: x.__iter__() <==> iter(x)"""
         return iter(self.hists)

def python.rootplot.utilities.HistStack.__len__ ( self )

Return the number of hists in the stack: x.__len__() <==> len(x)

Definition at line 332 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

     def __len__(self):
         """Return the number of hists in the stack: x.__len__() <==> len(x)"""
         return len(self.hists)

def python.rootplot.utilities.HistStack.__setitem__	(	self,
		index,
		value
	)

Replace indexth hist with value: x.__setitem__(i, y) <==> x[i]=y

Definition at line 329 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

     def __setitem__(self, index, value):
         """Replace indexth hist with value: x.__setitem__(i, y) <==> x[i]=y"""
         self.hists[index] = value

def python.rootplot.utilities.HistStack.add	(	self,
		hist,
		kwargs
	)

Add a Hist object to this stack.

Any additional keyword arguments will be added to just this Hist
when the stack is plotted.

Definition at line 365 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

Referenced by counter.Counter.register().

     def add(self, hist, **kwargs):
         """
         Add a Hist object to this stack.
 
         Any additional keyword arguments will be added to just this Hist
         when the stack is plotted.
         """
         if "label" in kwargs:
             hist.label = kwargs['label']
             del kwargs['label']
         if len(self) > 0:
             if hist.xedges != self.hists[0].xedges:
                 raise ValueError("Cannot add %s to stack; all Hists must "
                                  "have the same binning." % hist.name)
         self.hists.append(hist)
         self.kwargs.append(kwargs)
 
 

def python.rootplot.utilities.HistStack.max ( self )

Return the value of the highest bin of all hists in the stack.

Definition at line 338 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

Referenced by python.rootplot.utilities.HistStack.stackmax().

     def max(self):
         """Return the value of the highest bin of all hists in the stack."""
         maxes = [max(x) for x in self.hists]
         try:
             return max(maxes)
         except ValueError:
             return 0

def python.rootplot.utilities.HistStack.min	(	self,
		threshold = `None`
	)

Return the value of the lowest bin of all hists in the stack.

If threshold is specified, only values above the threshold will be
considered.

Definition at line 356 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

     def min(self, threshold=None):
         """
         Return the value of the lowest bin of all hists in the stack.
 
         If threshold is specified, only values above the threshold will be
         considered.
         """
         mins = [x.min(threshold) for x in self.hists]
         return min(mins)

def python.rootplot.utilities.HistStack.scale	(	self,
		factor
	)

Scale all Hists by factor.

Definition at line 352 of file utilities.py.

References histograms.Histograms.hists, and python.rootplot.utilities.HistStack.hists.

     def scale(self, factor):
         """Scale all Hists by factor."""
         for hist in self.hists:
             hist.scale(factor)

def python.rootplot.utilities.HistStack.stackmax ( self )

Return the value of the highest bin in the addition of all hists.

Definition at line 345 of file utilities.py.

References histograms.Histograms.hists, python.rootplot.utilities.HistStack.hists, python.rootplot.utilities.HistStack.max(), and edm.print().

     def stackmax(self):
         """Return the value of the highest bin in the addition of all hists."""
         try:
             return max([sum([h[i] for h in self.hists])
                        for i in range(self.hists[0].nbins)])
         except:
             print([h.nbins for h in self.hists])