Box Class Reference

Inheritance diagram for Box:

Collaboration diagram for Box:

Public Member Functions
def	__init__ (self, figure=None, axis=None)
def	add (self, data, column, mask=None, weight_column=None)
def	finish (self)

Public Attributes
	x_axis_label
	Label on x axis.

Detailed Description

Create a boxplot

Definition at line 695 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 from Plotter.

Definition at line 702 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
        """
        super().__init__(figure=figure, axis=axis)
 
        
        self.x_axis_label = ""
 

Member Function Documentation

add()

def add	(		self,
			data,
			column,
			mask = None,
			weight_column = None
	)

Add a new boxplot to the plots
@param data pandas.DataFrame containing all data
@param column which is used to calculate boxplot quantities
@param mask boolean numpy.array defining which events are used for the histogram
@param weight_column column in data containing the weights for each event

Reimplemented from Plotter.

Definition at line 713 of file plotting.py.

    def add(self, data, column, mask=None, weight_column=None):
        """
        Add a new boxplot to the plots
        @param data pandas.DataFrame containing all data
        @param column which is used to calculate boxplot quantities
        @param mask boolean numpy.array defining which events are used for the histogram
        @param weight_column column in data containing the weights for each event
        """
        if mask is None:
            mask = numpy.ones(len(data)).astype('bool')
        x = data[column][mask]
        if weight_column is not None:
            # weight = data[weight_column][mask]
            b2.B2WARNING("Weights are currently not used in boxplot, due to limitations in matplotlib")
 
        if len(x) == 0:
            b2.B2WARNING("Ignore empty boxplot.")
            return self
 
        p = self.axis.boxplot(x, sym='k.', whis=1.5, vert=False, patch_artist=True, showmeans=True, widths=1,
                              boxprops=dict(facecolor='blue', alpha=0.5),
                              # medianprobs=dict(color='blue'),
                              # meanprobs=dict(color='red'),
                              )
        self.plots.append(p)
        self.labels.append(column)
        self.x_axis_label = column
        r"""
        self.axis.text(0.1, 0.9, (r'$     \mu = {:.2f}$' + '\n' + r'$median = {:.2f}$').format(x.mean(), x.median()),
                       fontsize=28, verticalalignment='top', horizontalalignment='left', transform=self.axis.transAxes)
        self.axis.text(0.4, 0.9, (r'$  \sigma = {:.2f}$' + '\n' + r'$IQD = {:.2f}$').format(x.std(),
                                                                                            x.quantile(0.75) - x.quantile(0.25)),
                       fontsize=28, verticalalignment='top', horizontalalignment='left', transform=self.axis.transAxes)
        self.axis.text(0.7, 0.9, (r'$min = {:.2f}$' + '\n' + r'$max = {:.2f}$').format(x.min(), x.max()),
                       fontsize=28, verticalalignment='top', horizontalalignment='left', transform=self.axis.transAxes)
        """
 
        return self
 

finish()

def finish

(

self

)

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

Reimplemented from Plotter.

Definition at line 752 of file plotting.py.

    def finish(self):
        """
        Sets limits, title, axis-labels and legend of the plot
        """
        matplotlib.artist.setp(self.axis.get_yaxis(), visible=False)
        self.axis.get_xaxis().set_label_text(self.x_axis_label)
        self.axis.set_title("Box Plot")
        return self
 
 

Member Data Documentation

x_axis_label

x_axis_label

Label on x axis.

Definition at line 711 of file plotting.py.

---

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

• mva/scripts/basf2_mva_evaluation/plotting.py