plot - plotting

`plot` - plotting#

Todo

Write this section.

Colors#

Helper Function for Plotting#

First, we define a helper function for making a table of colors (using the code from the matplotlib docu):

import fesslix as flx
flx.load_engine()
import fesslix.plot

import math

import matplotlib.pyplot as plt

import matplotlib.colors as mcolors
from matplotlib.patches import Rectangle


def plot_colortable(colors, *, ncols=4, sort_colors=True):

    cell_width = 212
    cell_height = 22
    swatch_width = 48
    margin = 12

    # Sort colors by hue, saturation, value and name.
    if sort_colors is True:
        names = sorted(
            colors, key=lambda c: tuple(mcolors.rgb_to_hsv(mcolors.to_rgb(c))))
    else:
        names = list(colors)

    n = len(names)
    nrows = math.ceil(n / ncols)

    width = cell_width * ncols + 2 * margin
    height = cell_height * nrows + 2 * margin
    dpi = 72

    fig, ax = plt.subplots(figsize=(width / dpi, height / dpi), dpi=dpi)
    fig.subplots_adjust(margin/width, margin/height,
                        (width-margin)/width, (height-margin)/height)
    ax.set_xlim(0, cell_width * ncols)
    ax.set_ylim(cell_height * (nrows-0.5), -cell_height/2.)
    ax.yaxis.set_visible(False)
    ax.xaxis.set_visible(False)
    ax.set_axis_off()

    for i, name in enumerate(names):
        row = i % nrows
        col = i // nrows
        y = row * cell_height

        swatch_start_x = cell_width * col
        text_pos_x = cell_width * col + swatch_width + 7

        ax.text(text_pos_x, y, name, fontsize=14,
                horizontalalignment='left',
                verticalalignment='center')

        ax.add_patch(
            Rectangle(xy=(swatch_start_x, y-9), width=swatch_width,
                      height=18, facecolor=colors[name], edgecolor='0.7')
        )

    return fig

def plot_color_seq(color_seq):
    cdict = {}
    for i, c in enumerate(color_seq):
        cdict[f"id={i+1}"] = c 
    plot_colortable(cdict, sort_colors=False)

Random Number Generator: MT19937 - initialized with rand()=1311423219;
Random Number Generator: MT19937 - initialized with 1000 initial calls.

Predefined colors#

The following colors are predefined:

flx_colors = {
    'color_era_1': fesslix.plot.color_era_1,
    'color_era_2': fesslix.plot.color_era_2,
    'color_era_3': fesslix.plot.color_era_3,
    'color_era_grey_1': fesslix.plot.color_era_grey_1,
    'color_era_grey_2': fesslix.plot.color_era_grey_2,
    'color_era_grey_3': fesslix.plot.color_era_grey_3,
    'color_tumblue': fesslix.plot.color_tumblue,
    'color_tumgreen': fesslix.plot.color_tumgreen,
    'color_tumorange': fesslix.plot.color_tumorange,
    'color_tumlightblue': fesslix.plot.color_tumlightblue,
    'color_tumdarkblue': fesslix.plot.color_tumdarkblue,
  }
plot_colortable(flx_colors, sort_colors=False)
plt.show()

../_images/0668e352c6813fe9b915816f48223ba764548e8e5ddd6e2fd994d784d91722c8.png

Color sequences#

Color sequences are used to automatically assign color values in case of consecutive plotting.

The following sequences are available in the plot-module:

## flx_plot.color_seq
plot_color_seq(fesslix.plot.color_seq)   

../_images/c814b5094189c42ee3fe1bde6bcf3a976a57310493099598e9a1df915a1a9314.png

## flx_plot.color_seq_era
plot_color_seq(fesslix.plot.color_seq_era)   

../_images/a842cbccb091308c4df38e6d38192fec2906a7a7780e4b0321f0f60e8b7fa692.png

## flx_plot.color_seq_tum
plot_color_seq(fesslix.plot.color_seq_tum)   

../_images/de49f94f3c570cfbb3b453a4957145549a3789f00dc17160fd1b223794798916.png

Configuration dictionary#

Some functions in the plot-module work with a configuration dictionary:

type flx_plot_config#

A collection of configuration properties.

The following keys are allowed:

x_low = None (float): Lower bound of an interval (e.g., for discretization).
x_up = None (float): Upper bound of an interval (e.g., for discretization).
q_low = None (float): Quantile of a lower bound. If x_low is not specified, q_low is used in connection with the associated random variable to set the value of x_low.
q_up = None (float): Quantile of an upper bound. If x_up is not specified, q_up is used in connection with the associated random variable to set the value of x_up.
q_bounds = 1e-3 (float): If q_low or q_up is not specified, q_bounds is used to set their value.
x_disc_N = int(1e3) (int): Number of points to use (e.g., for discretization).
x_disc_shift = False (bool): see parameter x_disc_shift of fesslix.tools.discretize_x().
x_disc_on_log = False (bool): see parameter x_disc_on_log of fesslix.tools.discretize_x().
label = None (bool): Assigns a label to an axis.

Functions for plotting#

fesslix.plot.draw_pdf()#

Syntax:: fesslix.plot.draw_pdf(ax, rv, config_dict={}, param_dict={}, reverse_axis=False)
Description:: Plots the PDF of the random variable rv on axis ax.

Parameters:

ax (matplotlib.axes.Axes) – axes object of matplotlib.
rv (flx.rv) – random variable
config_dict (flx_plot_config) – configuration dictionary » The parameters x_low, x_up, q_low, q_up, q_bounds, x_disc_N, x_disc_shift, x_disc_on_log, label are considered.
param_dict (dict) – A dictionary for plotting properties related to matplotlib.
reverse_axis (bool) – If set to True, the x- and the y-axis are reversed.

Returns:

The object returned by ax.plot(…) of matplotlib.

Example:

fig, ax = plt.subplots(figsize=(10, 4))

rv = flx.rv({'type':'stdn'})
config_dict = {}
param_dict = { 'lw':2 }
fesslix.plot.draw_pdf(ax,rv, config_dict=config_dict, param_dict=param_dict)
ax.set_ylim(bottom=0.)

(0.0, 0.41871903581662334)

../_images/e4e32170d18796c37be7561e8afcd210dfc42871fc0154aed7544aef3d09a405.png

fesslix.plot.draw_cdf()#

Syntax:: fesslix.plot.draw_cdf(ax, rv, config_dict={}, param_dict={}, reverse_axis=False)
Description:: Plots the CDF of the random variable rv on axis ax.