Multiplot Class Reference

Inheritance diagram for Multiplot:

Public Member Functions
def	__init__ (self, cls, number_of_plots, figure=None)
def	add (self, i, *args, **kwargs)
def	finish (self)

Public Attributes
	figure
	create figure
	sub_plots
	the subplots which are displayed in the grid
	axis
	the axis of the first subplot

Static Public Attributes
None	figure = None
	figure which is used to draw
None	axis = None
	Main axis.

Detailed Description

Plots multiple other plots into a grid 3x?

Definition at line 487 of file plotting.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			cls,
			number_of_plots,
			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 496 of file plotting.py.

    def __init__(self, cls, number_of_plots, 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
 
        if number_of_plots == 1:
            gs = matplotlib.gridspec.GridSpec(1, 1)
        elif number_of_plots == 2:
            gs = matplotlib.gridspec.GridSpec(1, 2)
        elif number_of_plots == 3:
            gs = matplotlib.gridspec.GridSpec(1, 3)
        else:
            gs = matplotlib.gridspec.GridSpec(int(numpy.ceil(number_of_plots / 3)), 3)
 
        
        self.sub_plots = [cls(self.figure, self.figure.add_subplot(gs[i // 3, i % 3])) for i in range(number_of_plots)]
        
        self.axis = self.sub_plots[0].axis
        super().__init__(self.figure, self.axis)
 

Member Function Documentation

add()

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

Call add function of ith subplot
@param i position of the subplot

Reimplemented from Plotter.

Definition at line 523 of file plotting.py.

    def add(self, i, *args, **kwargs):
        """
        Call add function of ith subplot
        @param i position of the subplot
        """
        self.sub_plots[i].add(*args, **kwargs)
 

finish()

def finish

(

self

)

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

Reimplemented from Plotter.

Definition at line 530 of file plotting.py.

    def finish(self):
        """
        Sets limits, title, axis-labels and legend of the plot
        """
        for plot in self.sub_plots:
            plot.finish()
        return self
 
 

Member Data Documentation

axis [1/2]

None axis = None

static

Main axis.

Definition at line 494 of file plotting.py.

axis [2/2]

axis

the axis of the first subplot

Definition at line 520 of file plotting.py.

figure [1/2]

None figure = None

static

figure which is used to draw

Definition at line 492 of file plotting.py.

figure [2/2]

figure

create figure

Definition at line 503 of file plotting.py.

sub_plots

sub_plots

the subplots which are displayed in the grid

Definition at line 518 of file plotting.py.

---

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

• mva/scripts/basf2_mva_evaluation/plotting.py