GdtPlot

class gdt.core.plot.plot.GdtPlot(figsize=None, dpi=100, canvas=None, interactive=False, ax=None, **kwargs)[source]

Bases: object

Base class for plots in the GDT.

Note

This class is not intended to be instantiated directly by the user, rather it is inherited by different plot classes.

Parameters:
  • figsize ((float, float), optional) – The figure size (width, height)

  • dpi (int, optional) – The resolution of the plot. Default is 100

  • canvas (Canvas Backend object, optional) – If interfacing with a backend (e.g. Tk), pass the relavant Canvas Backend object and the master widget window. If not set, uses the default the matplotlib backend.

  • interactive (bool, optional) – If True, then enables interactive plotting (python environment is available while plot is displayed). Default is False. This is overriden if canvas is set.

  • ax (matplotlib.axes, optional) – An existing axes object to plot to. If not set, will create a new axes object.

  • **kwargs – Additional options for Figure.add_subplot.

Attributes Summary

ax

The matplotlib axes object for the plot

canvas

The plotting canvas, if set upon initialization.

fig

The matplotlib figure object

xlim

The plotting range of the x axis

xscale

The scale of the x axis, either 'linear' or 'log'.

ylim

The plotting range of the y axis.

yscale

The scale of the y axis, either 'linear' or 'log'.

Attributes Documentation

ax

The matplotlib axes object for the plot

Type:

(matplotlib.axes)

canvas

The plotting canvas, if set upon initialization.

Type:

(Canvas Backend object)

fig

The matplotlib figure object

Type:

(matplotlib.figure)

xlim

The plotting range of the x axis

Type:

(float, float)

xscale

The scale of the x axis, either ‘linear’ or ‘log’.

Type:

(str)

ylim

The plotting range of the y axis.

Type:

(float, float)

yscale

The scale of the y axis, either ‘linear’ or ‘log’.

Type:

(str)