Inheritance diagram for Difference:

Public Member Functions
	__init__ (self, figure=None, axis=None, normed=False, shift_to_zero=False)

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

	finish (self, line_color='black')

	add_subplot (self, gridspecs)

	save (self, filename)

	set_plot_options (self, plot_kwargs={ 'linestyle':''})

	set_errorbar_options (self, errorbar_kwargs={ 'fmt':'.', 'elinewidth':3, 'alpha':1})
	Overrides default errorbar options for datapoint errorbars.

	set_errorband_options (self, errorband_kwargs={ 'alpha':0.5})

	set_fill_options (self, fill_kwargs=None)

	setAxisLimits (self, factor=0.0)

	scale_limits (self)

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

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

	x_axis_label = column
	Label on x axis.

	dpi = dpi
	set default dpi

	plot_kwargs = None
	create figure

	errorbar_kwargs = None
	Default keyword arguments for errorbar function.

	errorband_kwargs = None
	Default keyword arguments for errorband function.

	fill_kwargs = None
	Default keyword arguments for fill_between function.

	prop_cycler = itertools.cycle(plt.rcParams["axes.prop_cycle"])
	Property cycler used to give plots unique colors.

Static Public Attributes
list	plots = None
	Plots added to the axis so far.

list	labels = None
	Labels of the plots added so far.

	xmin = None
	Minimum x value.

	xmax = None
	Maximum x value.

	ymin = None
	Minimum y value.

	ymax = None
	Maximum y value.

float	yscale = 0.0
	create figure

float	xscale = 0.0
	create figure

	figure = None
	figure which is used to draw

	axis = None
	Main axis which is used to draw.

Protected Member Functions
	_plot_datapoints (self, axis, x, y, xerr=None, yerr=None)

Detailed Description

Plots the difference between two histograms

Definition at line 1078 of file plotting.py.

Constructor & Destructor Documentation

◆ init()

__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

Definition at line 1095 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

◆ _plot_datapoints()

_plot_datapoints	(	self,
		axis,
		x,
		y,
		xerr = None,
		yerr = None )

protectedinherited

Plot the given datapoints, with plot, errorbar and make a errorband with fill_between
@param x coordinates of the data points
@param y coordinates of the data points
@param xerr symmetric error on x data points
@param yerr symmetric error on y data points

Definition at line 184 of file plotting.py.

    def _plot_datapoints(self, axis, x, y, xerr=None, yerr=None):
        """
        Plot the given datapoints, with plot, errorbar and make a errorband with fill_between
        @param x coordinates of the data points
        @param y coordinates of the data points
        @param xerr symmetric error on x data points
        @param yerr symmetric error on y data points
        """
        p = e = f = None
        plot_kwargs = copy.copy(self.plot_kwargs)
        errorbar_kwargs = copy.copy(self.errorbar_kwargs)
        errorband_kwargs = copy.copy(self.errorband_kwargs)
        fill_kwargs = copy.copy(self.fill_kwargs)
 
        if plot_kwargs is None or 'color' not in plot_kwargs:
            color = next(self.prop_cycler)
            color = color['color']
            plot_kwargs['color'] = color
        else:
            color = plot_kwargs['color']
        color = matplotlib.colors.ColorConverter().to_rgb(color)
        patch = matplotlib.patches.Patch(color=color, alpha=0.5)
        patch.get_color = patch.get_facecolor
        patches = [patch]
 
        if plot_kwargs is not None:
            p, = axis.plot(x, y, rasterized=True, **plot_kwargs)
            patches.append(p)
 
        if errorbar_kwargs is not None and (xerr is not None or yerr is not None):
            if 'color' not in errorbar_kwargs:
                errorbar_kwargs['color'] = color
            if 'ecolor' not in errorbar_kwargs:
                errorbar_kwargs['ecolor'] = [0.5 * x for x in color]
 
            # fully mask nan values.
            # Needed until https://github.com/matplotlib/matplotlib/pull/23333 makes it into the externals.
            # TODO: remove in release 8.
            if not isinstance(xerr, (numpy.ndarray, list)):
                xerr = xerr*numpy.ones(len(x))
            if not isinstance(yerr, (numpy.ndarray, list)):
                yerr = yerr*numpy.ones(len(y))
            mask = numpy.logical_and.reduce([numpy.isfinite(v) for v in [x, y, xerr, yerr]])
 
            e = axis.errorbar(
                x[mask], y[mask], xerr=numpy.where(
                    xerr[mask] < 0, 0.0, xerr[mask]), yerr=numpy.where(
                    yerr[mask] < 0, 0.0, yerr[mask]), rasterized=True, **errorbar_kwargs)
            patches.append(e)
 
        if errorband_kwargs is not None and yerr is not None:
            if 'color' not in errorband_kwargs:
                errorband_kwargs['color'] = color
            if xerr is not None:
                # Ensure that xerr and yerr are iterable numpy arrays
                xerr = x + xerr - x
                yerr = y + yerr - y
                for _x, _y, _xe, _ye in zip(x, y, xerr, yerr):
                    axis.add_patch(matplotlib.patches.Rectangle((_x - _xe, _y - _ye), 2 * _xe, 2 * _ye, rasterized=True,
                                                                **errorband_kwargs))
            else:
                f = axis.fill_between(x, y - yerr, y + yerr, interpolate=True, rasterized=True, **errorband_kwargs)
 
        if fill_kwargs is not None:
            # to fill the last bin of a histogram
            x = numpy.append(x, x[-1]+2*xerr[-1])
            y = numpy.append(y, y[-1])
            xerr = numpy.append(xerr, xerr[-1])
 
            axis.fill_between(x-xerr, y, 0, rasterized=True, **fill_kwargs)
 
        return (tuple(patches), p, e, f)
 

◆ add()

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 1113 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 = numpy.nanmin(
            numpy.append(
                hists.bin_centers, self.xmin)), numpy.nanmax(
            numpy.append(
                hists.bin_centers, self.xmax))
        self.ymin, self.ymax = numpy.nanmin(numpy.append(difference - difference_error, self.ymin)
                                            ), numpy.nanmax(numpy.append(difference + difference_error, self.ymax))
 
        self.set_errorbar_options({'fmt': '-o'})
        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
 

◆ add_subplot()

add_subplot	(		self,
			gridspecs )

inherited

Adds a new subplot to the figure, updates all other axes
according to the given gridspec
@param gridspecs gridspecs for all axes including the new one

Definition at line 129 of file plotting.py.

    def add_subplot(self, gridspecs):
        """
        Adds a new subplot to the figure, updates all other axes
        according to the given gridspec
        @param gridspecs gridspecs for all axes including the new one
        """
        for gs, ax in zip(gridspecs[:-1], self.figure.axes):
            ax.set_position(gs.get_position(self.figure))
            ax.set_subplotspec(gs)
        axis = self.figure.add_subplot(gridspecs[-1], sharex=self.axis)
        return axis
 

◆ finish()

finish	(		self,
			line_color = 'black' )

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

Reimplemented from Plotter.

Definition at line 1156 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.setAxisLimits(factor=0.01)
        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('Diff.')
        self.axis.legend([x[0] for x in self.plots], self.labels, loc='best', fancybox=True, framealpha=0.5)
        return self
 
 

◆ save()

save	(		self,
			filename )

inherited

Save the figure into a file
@param filename of the file

Definition at line 141 of file plotting.py.

    def save(self, filename):
        """
        Save the figure into a file
        @param filename of the file
        """
        b2.B2INFO("Save figure for class " + str(type(self)))
        from matplotlib.backends.backend_agg import FigureCanvasAgg as FigureCanvas
        canvas = FigureCanvas(self.figure)
        canvas.print_figure(filename, dpi=self.dpi, bbox_inches='tight')
        return self
 

◆ scale_limits()

scale_limits ( self )

inherited

Scale limits to increase distance to boundaries

Definition at line 281 of file plotting.py.

    def scale_limits(self):
        """
        Scale limits to increase distance to boundaries
        """
        self.ymin *= 1.0 - math.copysign(self.yscale, self.ymin)
        self.ymax *= 1.0 + math.copysign(self.yscale, self.ymax)
        self.xmin *= 1.0 - math.copysign(self.xscale, self.xmin)
        self.xmax *= 1.0 + math.copysign(self.xscale, self.xmax)
        return self
 
 

◆ set_errorband_options()

set_errorband_options	(		self,
			errorband_kwargs = {'alpha': 0.5} )

inherited

Overrides default errorband options for datapoint errorband
@param errorbar_kwargs keyword arguments for the fill_between function

Definition at line 168 of file plotting.py.

    def set_errorband_options(self, errorband_kwargs={'alpha': 0.5}):
        """
        Overrides default errorband options for datapoint errorband
        @param errorbar_kwargs keyword arguments for the fill_between function
        """
        self.errorband_kwargs = copy.copy(errorband_kwargs)
        return self
 

◆ set_errorbar_options()

set_errorbar_options	(		self,
			errorbar_kwargs = {'fmt': '.', 'elinewidth': 3, 'alpha': 1} )

inherited

Overrides default errorbar options for datapoint errorbars.

Overrides default errorbar options for datapoint errorbars
@param errorbar_kwargs keyword arguments for the errorbar function

Definition at line 160 of file plotting.py.

    def set_errorbar_options(self, errorbar_kwargs={'fmt': '.', 'elinewidth': 3, 'alpha': 1}):
        """
        Overrides default errorbar options for datapoint errorbars
        @param errorbar_kwargs keyword arguments for the errorbar function
        """
        self.errorbar_kwargs = copy.copy(errorbar_kwargs)
        return self
 

◆ set_fill_options()

set_fill_options	(		self,
			fill_kwargs = None )

inherited

Overrides default fill_between options for datapoint errorband
@param fill_kwargs keyword arguments for the fill_between function

Definition at line 176 of file plotting.py.

    def set_fill_options(self, fill_kwargs=None):
        """
        Overrides default fill_between options for datapoint errorband
        @param fill_kwargs keyword arguments for the fill_between function
        """
        self.fill_kwargs = copy.copy(fill_kwargs)
        return self
 

◆ set_plot_options()

set_plot_options	(		self,
			plot_kwargs = {'linestyle': ''} )

inherited

Overrides default plot options for datapoint plot
@param plot_kwargs keyword arguments for the plot function

Definition at line 152 of file plotting.py.

    def set_plot_options(self, plot_kwargs={'linestyle': ''}):
        """
        Overrides default plot options for datapoint plot
        @param plot_kwargs keyword arguments for the plot function
        """
        self.plot_kwargs = copy.copy(plot_kwargs)
        return self
 

◆ setAxisLimits()

setAxisLimits	(		self,
			factor = 0.0 )

inherited

Sets the limits of the axis with an optional expansion factor.

Parameters:
    factor (float): Fraction by which to expand the axis limits beyond the data range.

Definition at line 263 of file plotting.py.

    def setAxisLimits(self, factor=0.0):
        """
        Sets the limits of the axis with an optional expansion factor.
 
        Parameters:
            factor (float): Fraction by which to expand the axis limits beyond the data range.
        """
        dx = self.xmax - self.xmin
        dy = self.ymax - self.ymin
        self.axis.set_xlim((self.xmin - factor*dx, self.xmax + factor*dx))
        self.axis.set_ylim((self.ymin - factor*dy, self.ymax + factor*dy))
 

Member Data Documentation

◆ axis

axis = None

staticinherited

Main axis which is used to draw.

divide figure into subplots

Definition at line 75 of file plotting.py.

◆ dpi

dpi = dpi

inherited

set default dpi

Definition at line 86 of file plotting.py.

◆ errorband_kwargs

errorband_kwargs = None

inherited

Default keyword arguments for errorband function.

Definition at line 117 of file plotting.py.

◆ errorbar_kwargs

errorbar_kwargs = None

inherited

Default keyword arguments for errorbar function.

Definition at line 115 of file plotting.py.

◆ figure

figure = None

staticinherited

figure which is used to draw

Definition at line 73 of file plotting.py.

◆ fill_kwargs

fill_kwargs = None

inherited

Default keyword arguments for fill_between function.

Definition at line 119 of file plotting.py.

◆ labels

list labels = None

staticinherited

Labels of the plots added so far.

divide figure into subplots

create empty list for plots

create empty list for labels

Definition at line 61 of file plotting.py.

◆ normed

normed = normed

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

Definition at line 1104 of file plotting.py.

◆ plot_kwargs

plot_kwargs = None

inherited

create figure

divide figure into subplots

create empty list for plots

create empty list for labels

set x limits

set y limits

y limit scale

x limit scale

Default keyword arguments for plot function

Definition at line 113 of file plotting.py.

◆ plots

list plots = None

staticinherited

Plots added to the axis so far.

divide figure into subplots

create empty list for plots

Definition at line 59 of file plotting.py.

◆ prop_cycler

prop_cycler = itertools.cycle(plt.rcParams["axes.prop_cycle"])

inherited

Property cycler used to give plots unique colors.

Definition at line 127 of file plotting.py.

◆ shift_to_zero

shift_to_zero = shift_to_zero

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

Definition at line 1105 of file plotting.py.

◆ x_axis_label

x_axis_label = column

Label on x axis.

Definition at line 1153 of file plotting.py.

◆ xmax

xmax = None

staticinherited

Maximum x value.

divide figure into subplots

create empty list for plots

create empty list for labels

set x limits

Definition at line 65 of file plotting.py.

◆ xmin

xmin = None

staticinherited

Minimum x value.

create figure

divide figure into subplots

create empty list for plots

create empty list for labels

set x limits

Definition at line 63 of file plotting.py.

◆ xscale

float xscale = 0.0

staticinherited

create figure

limit scale

divide figure into subplots

create empty list for plots

create empty list for labels

set x limits

set y limits

y limit scale

x limit scale

Definition at line 71 of file plotting.py.

◆ ymax

ymax = None

staticinherited

Maximum y value.

divide figure into subplots

create empty list for plots

create empty list for labels

set x limits

set y limits

Definition at line 69 of file plotting.py.

◆ ymin

ymin = None

staticinherited

Minimum y value.

create figure

divide figure into subplots

create empty list for plots

create empty list for labels

set x limits

set y limits

Definition at line 67 of file plotting.py.

◆ yscale

float yscale = 0.0

staticinherited

create figure

limit scale

divide figure into subplots

create empty list for plots

create empty list for labels

set x limits

set y limits

y limit scale

Definition at line 70 of file plotting.py.

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

mva/scripts/basf2_mva_evaluation/plotting.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _plot_datapoints()

◆ add()

◆ add_subplot()

◆ finish()

◆ save()

◆ scale_limits()

◆ set_errorband_options()

◆ set_errorbar_options()

◆ set_fill_options()

◆ set_plot_options()

◆ setAxisLimits()

Member Data Documentation

◆ axis

◆ dpi

◆ errorband_kwargs

◆ errorbar_kwargs

◆ figure

◆ fill_kwargs

◆ labels

◆ normed

◆ plot_kwargs

◆ plots

◆ prop_cycler

◆ shift_to_zero

◆ x_axis_label

◆ xmax

◆ xmin

◆ xscale

◆ ymax

◆ ymin

◆ yscale

◆ init()