API reference#

Figure and MultiFigure#

Figure

This class implements a general figure object.

MultiFigure

This class implements the "canvas" on which multiple plots are displayed.

Plottables#

Arrow

This class implements an arrow object.

Circle

This class implements a Circle object with a given center and radius.

Contour

This class implements contour plots.

Curve

This class implements a general continuous curve.

FitFromExponential

Create a curve fit (continuous Curve) from an existing Curve object using an exponential fit.

FitFromFOTF

Create a curve fit (continuous Curve) from an existing Curve object using a first order transfer function (FOTF) fit.

FitFromFunction

Create a curve fit (continuous Curve) from a Curve object using an arbitrary function passed as an argument.

FitFromGaussian

Create a curve fit (continuous Curve) from an existing Curve object using a gaussian fit.

FitFromLog

Create a curve fit (continuous Curve) from an existing Curve object using a logarithmic fit.

FitFromPolynomial

Creates a curve fit (continuous Curve) from an existing curve object using a polynomial fit.

FitFromSine

Create a curve fit (continuous Curve) from an existing Curve object using a sinusoidal fit.

FitFromSquareRoot

Create a curve fit (continuous Curve) from an existing Curve object using a square root fit.

Heatmap

The class implements heatmaps.

Histogram

This class implements a general histogram.

Hlines

This class implements simple horizontal lines.

Line

This class implements a line object.

Point

This class implements a point object.

Polygon

This class implements a Polygon object.

Rectangle

This class implements a Rectangle object with a given bottom left corner, width and height.

Scatter

This class implements a general scatter plot.

Stream

This class implements stream plots.

Table

This class allows to plot a table inside a Figure or MultiFigure.

Text

This class allows text to be plotted.

VectorField

This class implements vector fields.

Vlines

This class implements simple vertical lines.

Utility functions#

get_color

Returns a color from the specified style (user created, GL, or Matplotlib style).

get_colors

Returns a list of colors from the specified style (user created, GL, or Matplotlib style).

get_default_style

Returns the default style.

get_styles

Returns a list or dict of available styles.

set_default_style

Sets the default style.