Difference Class Reference

Inheritance diagram for Difference:

Public Member Functions
def	__init__ (self, figure=None, axis=None, normed=False, shift_to_zero=False)
def	add (self, data, column, minuend_mask, subtrahend_mask, weight_column=None, label=None)
def	finish (self, line_color='black')

Public Attributes
	normed
	Minuend and subtrahend are normed before comparing them if this is true.
	shift_to_zero
	Mean difference is shifted to zero (removes constant offset) if this is true.
	ymin
	min y value
	ymax
	Maximum y value.
	xmax
	Maximum x value.
	x_axis_label
	Label on x axis.

Detailed Description

Plots the difference between two histograms

Definition at line 770 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			figure = None,
			axis = None,
			normed = False,
			shift_to_zero = False
	)

Creates a new figure and axis if None is given, sets the default plot parameters
@param figure default draw figure which is used
@param axis default draw axis which is used
@param normed normalize minuend and subtrahend before comparing them
@param shift_to_zero mean difference is shifted to zero, to remove constant offset due to e.g. different sample sizes

Reimplemented from Plotter.

Definition at line 787 of file plotting.py.

    def __init__(self, figure=None, axis=None, normed=False, shift_to_zero=False):
        """
        Creates a new figure and axis if None is given, sets the default plot parameters
        @param figure default draw figure which is used
        @param axis default draw axis which is used
        @param normed normalize minuend and subtrahend before comparing them
        @param shift_to_zero mean difference is shifted to zero, to remove constant offset due to e.g. different sample sizes
        """
        super().__init__(figure, axis)
        self.normed = normed
        self.shift_to_zero = shift_to_zero
        if self.normed:
            self.ymin = -0.01
            self.ymax = 0.01
        else:
            self.ymin = -1
            self.ymax = 1
 

Member Function Documentation

add()

def add	(		self,
			data,
			column,
			minuend_mask,
			subtrahend_mask,
			weight_column = None,
			label = None
	)

Add a new difference plot
@param data pandas.DataFrame containing all data
@param column which is used to calculate distribution histogram
@param minuend_mask boolean numpy.array defining which events are for the minuend histogram
@param subtrahend_mask boolean numpy.array defining which events are for the subtrahend histogram
@param weight_column column in data containing the weights for each event
@param label label for the legend if None, the column name is used

Reimplemented from Plotter.

Definition at line 805 of file plotting.py.

    def add(self, data, column, minuend_mask, subtrahend_mask, weight_column=None, label=None):
        """
        Add a new difference plot
        @param data pandas.DataFrame containing all data
        @param column which is used to calculate distribution histogram
        @param minuend_mask boolean numpy.array defining which events are for the minuend histogram
        @param subtrahend_mask boolean numpy.array defining which events are for the subtrahend histogram
        @param weight_column column in data containing the weights for each event
        @param label label for the legend if None, the column name is used
        """
        hists = histogram.Histograms(data, column, {'Minuend': minuend_mask, 'Subtrahend': subtrahend_mask},
                                     weight_column=weight_column, equal_frequency=False)
        minuend, minuend_error = hists.get_hist('Minuend')
        subtrahend, subtrahend_error = hists.get_hist('Subtrahend')
 
        difference_error = histogram.poisson_error(minuend + subtrahend)
        if self.normed:
            difference_error = difference_error / (numpy.sum(minuend) + numpy.sum(subtrahend))
            minuend = minuend / numpy.sum(minuend)
            subtrahend = subtrahend / numpy.sum(subtrahend)
        difference = minuend - subtrahend
 
        if self.shift_to_zero:
            difference = difference - numpy.mean(difference)
 
        self.xmin, self.xmax = min(hists.bin_centers.min(), self.xmin), max(hists.bin_centers.max(), self.xmax)
        self.ymin = min((difference - difference_error).min(), self.ymin)
        self.ymax = max((difference + difference_error).max(), self.ymax)
 
        p = self._plot_datapoints(self.axis, hists.bin_centers, difference, xerr=hists.bin_widths / 2, yerr=difference_error)
        self.plots.append(p)
        if label is None:
            self.labels.append(label)
        else:
            self.labels.append(column)
        self.x_axis_label = column
        return self
 

finish()

def finish	(		self,
			line_color = 'black'
	)

Sets limits, title, axis-labels and legend of the plot

Reimplemented from Plotter.

Definition at line 843 of file plotting.py.

    def finish(self, line_color='black'):
        """
        Sets limits, title, axis-labels and legend of the plot
        """
        self.axis.plot((self.xmin, self.xmax), (0, 0), color=line_color, linewidth=4, rasterized=True)
        self.scale_limits()
        self.axis.set_xlim((self.xmin, self.xmax))
        self.axis.set_ylim((self.ymin, self.ymax))
        self.axis.set_title("Difference Plot")
        self.axis.get_yaxis().set_major_locator(matplotlib.ticker.MaxNLocator(5))
        self.axis.get_xaxis().set_label_text(self.x_axis_label)
        self.axis.get_yaxis().set_label_text('Difference')
        self.axis.legend([x[0] for x in self.plots], self.labels, loc='best', fancybox=True, framealpha=0.5)
        return self
 
 

Member Data Documentation

normed

normed

Minuend and subtrahend are normed before comparing them if this is true.

Definition at line 796 of file plotting.py.

shift_to_zero

shift_to_zero

Mean difference is shifted to zero (removes constant offset) if this is true.

Definition at line 797 of file plotting.py.

x_axis_label

x_axis_label

Label on x axis.

Definition at line 840 of file plotting.py.

xmax

xmax

Maximum x value.

Definition at line 830 of file plotting.py.

ymax

ymax

Maximum y value.

Definition at line 800 of file plotting.py.

ymin

ymin

min y value

Definition at line 799 of file plotting.py.

---

The documentation for this class was generated from the following file:

• mva/scripts/basf2_mva_evaluation/plotting.py