CorrelationMatrix Class Reference

Inheritance diagram for CorrelationMatrix:

Public Member Functions
def	__init__ (self, figure=None)
def	add (self, data, columns, signal_mask, bckgrd_mask)
def	finish (self)

Public Attributes
	figure
	create figure
	signal_axis
	add signal subplot
	bckgrd_axis
	add background subplot
	colorbar_axis
	Colorbar axis contains the colorbar.
	axis
	Usual axis object which every Plotter object needs, here it is just a dummy.

Static Public Attributes
None	figure = None
	figure which is used to draw
None	signal_axis = None
	Main axis which shows the correlation of the signal samples.
None	bckgrd_axis = None
	Axis which shows the correlation of the background samples.

Detailed Description

Plots correlation matrix

Definition at line 1245 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			figure = None
	)

Creates a new figure if None is given, sets the default plot parameters
@param figure default draw figure which is used

Reimplemented from Plotter.

Definition at line 1256 of file plotting.py.

    def __init__(self, figure=None):
        """
        Creates a new figure if None is given, sets the default plot parameters
        @param figure default draw figure which is used
        """
        if figure is None:
            
            self.figure = matplotlib.figure.Figure(figsize=(12, 8), dpi=120)
            self.figure.set_tight_layout(True)
        else:
            self.figure = figure
 
        gs = matplotlib.gridspec.GridSpec(8, 2)
        
        self.signal_axis = self.figure.add_subplot(gs[:6, 0])
        
        self.bckgrd_axis = self.figure.add_subplot(gs[:6, 1], sharey=self.signal_axis)
        
        self.colorbar_axis = self.figure.add_subplot(gs[7, :])
        
        self.axis = self.signal_axis
 
        super().__init__(self.figure, self.axis)
 

Member Function Documentation

add()

def add	(		self,
			data,
			columns,
			signal_mask,
			bckgrd_mask
	)

Add a new correlation plot.
@param data pandas.DataFrame containing all data
@param columns which are used to calculate the correlations

Reimplemented from Plotter.

Definition at line 1280 of file plotting.py.

    def add(self, data, columns, signal_mask, bckgrd_mask):
        """
        Add a new correlation plot.
        @param data pandas.DataFrame containing all data
        @param columns which are used to calculate the correlations
        """
        signal_corr = numpy.corrcoef(numpy.vstack([data[column][signal_mask] for column in columns])) * 100
        bckgrd_corr = numpy.corrcoef(numpy.vstack([data[column][bckgrd_mask] for column in columns])) * 100
 
        signal_heatmap = self.signal_axis.pcolor(signal_corr, cmap=plt.cm.RdBu, vmin=-100.0, vmax=100.0)
        self.bckgrd_axis.pcolor(bckgrd_corr, cmap=plt.cm.RdBu, vmin=-100.0, vmax=100.0)
 
        self.signal_axis.invert_yaxis()
        self.signal_axis.xaxis.tick_top()
        self.bckgrd_axis.invert_yaxis()
        self.bckgrd_axis.xaxis.tick_top()
 
        # put the major ticks at the middle of each cell
        self.signal_axis.set_xticks(numpy.arange(signal_corr.shape[0]) + 0.5, minor=False)
        self.signal_axis.set_yticks(numpy.arange(signal_corr.shape[1]) + 0.5, minor=False)
 
        self.signal_axis.set_xticklabels(columns, minor=False, rotation=90)
        self.signal_axis.set_yticklabels(columns, minor=False)
 
        # put the major ticks at the middle of each cell
        self.bckgrd_axis.set_xticks(numpy.arange(bckgrd_corr.shape[0]) + 0.5, minor=False)
        self.bckgrd_axis.set_yticks(numpy.arange(bckgrd_corr.shape[1]) + 0.5, minor=False)
 
        self.bckgrd_axis.set_xticklabels(columns, minor=False, rotation=90)
        self.bckgrd_axis.set_yticklabels(columns, minor=False)
 
        for y in range(signal_corr.shape[0]):
            for x in range(signal_corr.shape[1]):
                txt = self.signal_axis.text(x + 0.5, y + 0.5, f'{signal_corr[y, x]:.0f}',
                                            size=14,
                                            horizontalalignment='center',
                                            verticalalignment='center',
                                            color='w')
                txt.set_path_effects([PathEffects.withStroke(linewidth=3, foreground='k')])
 
        for y in range(bckgrd_corr.shape[0]):
            for x in range(bckgrd_corr.shape[1]):
                txt = self.bckgrd_axis.text(x + 0.5, y + 0.5, f'{bckgrd_corr[y, x]:.0f}',
                                            size=14,
                                            horizontalalignment='center',
                                            verticalalignment='center',
                                            color='w')
                txt.set_path_effects([PathEffects.withStroke(linewidth=3, foreground='k')])
 
        cb = self.figure.colorbar(signal_heatmap, cax=self.colorbar_axis, ticks=[-100, 0, 100], orientation='horizontal')
        cb.solids.set_rasterized(True)
        cb.ax.set_xticklabels(['negative', 'uncorrelated', 'positive'])
 
        self.signal_axis.text(0.5, -1.0, "Signal", horizontalalignment='center')
        self.bckgrd_axis.text(0.5, -1.0, "Background", horizontalalignment='center')
 
        # remove whitespace
        self.signal_axis.set_xlim(0, signal_corr.shape[0])
        self.signal_axis.set_ylim(0, signal_corr.shape[1])
        self.bckgrd_axis.set_xlim(0, bckgrd_corr.shape[0])
        self.bckgrd_axis.set_ylim(0, bckgrd_corr.shape[1])
        return self
 

finish()

def finish

(

self

)

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

Reimplemented from Plotter.

Definition at line 1343 of file plotting.py.

    def finish(self):
        """
        Sets limits, title, axis-labels and legend of the plot
        """
        matplotlib.artist.setp(self.bckgrd_axis.get_yticklabels(), visible=False)
        return self
 
 

Member Data Documentation

axis

axis

Usual axis object which every Plotter object needs, here it is just a dummy.

Definition at line 1276 of file plotting.py.

bckgrd_axis [1/2]

None bckgrd_axis = None

static

Axis which shows the correlation of the background samples.

Definition at line 1254 of file plotting.py.

bckgrd_axis [2/2]

bckgrd_axis

add background subplot

Definition at line 1272 of file plotting.py.

colorbar_axis

colorbar_axis

Colorbar axis contains the colorbar.

Definition at line 1274 of file plotting.py.

figure [1/2]

None figure = None

static

figure which is used to draw

Definition at line 1250 of file plotting.py.

figure [2/2]

figure

create figure

Definition at line 1263 of file plotting.py.

signal_axis [1/2]

None signal_axis = None

static

Main axis which shows the correlation of the signal samples.

Definition at line 1252 of file plotting.py.

signal_axis [2/2]

signal_axis

add signal subplot

Definition at line 1270 of file plotting.py.

---

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

• mva/scripts/basf2_mva_evaluation/plotting.py