Inheritance diagram for Plotter:

[legend]

Public Member Functions
def	__init__ (self, figure=None, axis=None)

def	add_subplot (self, gridspecs)

def	save (self, filename)

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

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

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

def	set_fill_options (self, fill_kwargs=None)

def	add (self, args, *kwargs)

def	finish (self, args, *kwargs)

def	scale_limits (self)

Public Attributes
	figure
	create figure

	axis
	divide figure into subplots

	plots
	create empty list for plots

	labels
	create empty list for labels

	xmax
	set x limits

	ymax
	set y limits

	yscale
	y limit scale

	xscale
	x limit scale

	plot_kwargs
	Default keyword arguments for plot function.

	errorbar_kwargs
	Default keyword arguments for errorbar function.

	errorband_kwargs
	Default keyword arguments for errorband function.

	fill_kwargs
	Default keyword arguments for fill_between function.

	prop_cycler
	Property cycler used to give plots unique colors.

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

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

None	xmin = None
	Minimum x value.

None	xmax = None
	Maximum x value.

None	ymin = None
	Minimum y value.

None	ymax = None
	Maximum y value.

float	yscale = 0.0
	limit scale

float	xscale = 0.0
	limit scale

None	figure = None
	figure which is used to draw

None	axis = None
	Main axis which is used to draw.

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

Detailed Description

Base class for all Plotters.

Definition at line 44 of file plotting.py.

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		figure = `None`,
		axis = `None`
	)

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

Reimplemented in Multiplot, Overtraining, Correlation, CorrelationMatrix, Box, VerboseDistribution, Difference, and Distribution.

Definition at line 78 of file plotting.py.

    def __init__(self, figure=None, axis=None):
        """
        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
        """
        b2.B2INFO("Create new figure for class " + str(type(self)))
        if figure is None:
            
            self.figure = matplotlib.figure.Figure(figsize=(32, 18))
            self.figure.set_tight_layout(False)
        else:
            self.figure = figure
 
        if axis is None:
            
            self.axis = self.figure.add_subplot(1, 1, 1)
        else:
            self.axis = axis
 
        
        self.plots = []
        
        self.labels = []
        
        self.xmin, self.xmax = float(0), float(1)
        
        self.ymin, self.ymax = float(0), float(1)
        
        self.yscale = 0.1
        
        self.xscale = 0.0
 
        
        self.plot_kwargs = None
        
        self.errorbar_kwargs = None
        
        self.errorband_kwargs = None
        
        self.fill_kwargs = None
 
        self.set_plot_options()
        self.set_errorbar_options()
        self.set_errorband_options()
        self.set_fill_options()
 
        
        self.prop_cycler = itertools.cycle(plt.rcParams["axes.prop_cycle"])
 

Member Function Documentation

◆ _plot_datapoints()

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

protected

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 183 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))
            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()

def add	(		self,
		*	args,
		**	kwargs
	)

Add a new plot to this plotter

Reimplemented in Correlation, Box, Distribution, VerboseDistribution, Difference, Diagonal, PurityOverEfficiency, RejectionOverEfficiency, PurityAndEfficiencyOverCut, SignalToNoiseOverCut, Overtraining, TSNE, CorrelationMatrix, Importance, and Multiplot.

Definition at line 254 of file plotting.py.

    def add(self, *args, **kwargs):
        """
        Add a new plot to this plotter
        """
        return NotImplemented
 

◆ add_subplot()

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

Definition at line 128 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()

def finish	(		self,
		*	args,
		**	kwargs
	)

Finish plotting and set labels, legends and stuff

Reimplemented in PurityAndEfficiencyOverCut, SignalToNoiseOverCut, PurityOverEfficiency, RejectionOverEfficiency, Multiplot, Diagonal, Distribution, Box, Overtraining, VerboseDistribution, Correlation, TSNE, Importance, CorrelationMatrix, and Difference.

Definition at line 260 of file plotting.py.

    def finish(self, *args, **kwargs):
        """
        Finish plotting and set labels, legends and stuff
        """
        return NotImplemented
 

◆ save()

def save	(	self,
		filename
	)

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

Definition at line 140 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=50)
        return self
 

◆ scale_limits()

def scale_limits ( self )

Scale limits to increase distance to boundaries

Definition at line 266 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()

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

Definition at line 167 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()

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

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 159 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()

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

Definition at line 175 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()

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

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

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

Member Data Documentation

◆ axis [1/2]

None axis = None

static

Main axis which is used to draw.

Definition at line 76 of file plotting.py.

◆ axis [2/2]

axis

divide figure into subplots

Definition at line 94 of file plotting.py.

◆ errorband_kwargs

errorband_kwargs

Default keyword arguments for errorband function.

Definition at line 116 of file plotting.py.

◆ errorbar_kwargs

errorbar_kwargs

Default keyword arguments for errorbar function.

Definition at line 114 of file plotting.py.

◆ figure [1/2]

None figure = None

static

figure which is used to draw

Definition at line 74 of file plotting.py.

◆ figure [2/2]

figure

create figure

Definition at line 87 of file plotting.py.

◆ fill_kwargs

fill_kwargs

Default keyword arguments for fill_between function.

Definition at line 118 of file plotting.py.

◆ labels [1/2]

None labels = None

static

Labels of the plots added so far.

Definition at line 62 of file plotting.py.

◆ labels [2/2]

labels

create empty list for labels

Definition at line 101 of file plotting.py.

◆ plot_kwargs

plot_kwargs

Default keyword arguments for plot function.

Definition at line 112 of file plotting.py.

◆ plots [1/2]

None plots = None

static

Plots added to the axis so far.

Definition at line 60 of file plotting.py.

◆ plots [2/2]

plots

create empty list for plots

Definition at line 99 of file plotting.py.

◆ prop_cycler

prop_cycler

Property cycler used to give plots unique colors.

Definition at line 126 of file plotting.py.

◆ xmax [1/2]

None xmax = None

static

Maximum x value.

Definition at line 66 of file plotting.py.

◆ xmax [2/2]

xmax

set x limits

Definition at line 103 of file plotting.py.

◆ xmin

None xmin = None

static

Minimum x value.

Definition at line 64 of file plotting.py.

◆ xscale [1/2]

xscale = 0.0

static

limit scale

Definition at line 72 of file plotting.py.

◆ xscale [2/2]

xscale

x limit scale

Definition at line 109 of file plotting.py.

◆ ymax [1/2]

None ymax = None

static

Maximum y value.

Definition at line 70 of file plotting.py.

◆ ymax [2/2]

ymax

set y limits

Definition at line 105 of file plotting.py.

◆ ymin

None ymin = None

static

Minimum y value.

Definition at line 68 of file plotting.py.

◆ yscale [1/2]

yscale = 0.0

static

limit scale

Definition at line 71 of file plotting.py.

◆ yscale [2/2]

yscale

y limit scale

Definition at line 107 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()

Member Data Documentation

◆ axis [1/2]

◆ axis [2/2]

◆ errorband_kwargs

◆ errorbar_kwargs

◆ figure [1/2]

◆ figure [2/2]

◆ fill_kwargs

◆ labels [1/2]

◆ labels [2/2]

◆ plot_kwargs

◆ plots [1/2]

◆ plots [2/2]

◆ prop_cycler

◆ xmax [1/2]

◆ xmax [2/2]

◆ xmin

◆ xscale [1/2]

◆ xscale [2/2]

◆ ymax [1/2]

◆ ymax [2/2]

◆ ymin

◆ yscale [1/2]

◆ yscale [2/2]

◆ init()