plot.py

#
# Shared plotting code.
#
# This file is part of Pints Functional Testing.
#  Copyright (c) 2017-2019, University of Oxford.
#  For licensing information, see the LICENSE file distributed with the Pints
#  functional testing software package.
#
import numpy as np

import matplotlib
matplotlib.use('Agg')
import matplotlib.pyplot as plt

import pfunk


def variable(results, variable, title, ylabel, threshold=None):
    """
    Creates and returns a default plot for a variable vs commits.

    Parameters
    ----------
    results : ResultsDatabaseResultsSet
        Results for this plot
    variable : str
        The variable to plot
    title : str
        A title for this plot
    ylabel : str
        A y-axis label
    threshold : float
        An optional pass/fail threshold: if given, a horizontal line will be
        drawn at this value.
    """
    fig = plt.figure(figsize=(11, 4.5))
    plt.suptitle(title + ' : ' + pfunk.date())

    r = 0.3

    # Left plot: Variable per commit, all data
    plt.subplot(1, 2, 1)
    plt.ylabel(ylabel)
    plt.xlabel('Commit')
    fig.autofmt_xdate()
    x, y, u, m, s = pfunk.gather_statistics_per_commit(results, variable)
    if len(x) == 0:
        plt.text(0.5, 0.5, 'No data')
    else:
        xlookup = dict(zip(u, np.arange(len(u))))
        x = np.array([xlookup[i] for i in x], dtype=float)
        x += np.random.uniform(-r, r, x.shape)
        plt.plot(u, m, 'ko-', alpha=0.5)
        plt.plot(x, y, 'x', alpha=0.75)
        if threshold:
            plt.axhline(threshold)
        try:
            y = np.array(y)
            ymax = np.max(y[np.isfinite(y)])
        except ValueError:
            ymax = 1

    # Right plot: Same, but with outliers removed, to achieve a "zoom" on the
    # most common, recent data.
    plt.subplot(1, 2, 2)
    plt.ylabel(ylabel)
    plt.xlabel('Commit')
    fig.autofmt_xdate()
    x, y, u, m, s = pfunk.gather_statistics_per_commit(
        results, variable, remove_outliers=True, n=10)
    if len(x) == 0:
        plt.text(0.5, 0.5, 'No data')
    else:
        xlookup = dict(zip(u, np.arange(len(u))))
        x = np.array([xlookup[i] for i in x], dtype=float)
        x += np.random.uniform(-r, r, x.shape)
        plt.plot(u, m, 'ko-', alpha=0.5)
        plt.plot(x, y, 'x', alpha=0.75)
        if threshold:
            # Show threshold line only if it doesn't change the zoom
            if threshold <= np.max(y) and threshold >= np.min(y):
                plt.axhline(threshold)
        y = np.array(y)
        try:
            y = np.array(y)
            ymax = max(ymax, np.max(y[np.isfinite(y)]))
        except ValueError:
            pass

        if ymax > 1000:
            plt.subplots_adjust(0.1, 0.16, 0.99, 0.92, 0.2, 0)
        else:
            plt.subplots_adjust(0.07, 0.16, 0.99, 0.92, 0.17, 0)

    return fig