Scatter plots

Inherits from PlotChecker.

class plotchecker.ScatterPlotChecker(axis)

A plot checker for scatter plots.

Parameters:

axis : matplotlib.axes.Axes object

A set of matplotlib axes (e.g. obtained through plt.gca())

assert_num_points(num_points)

Assert that the plot has the given number of points.

Parameters:num_points : int

x_data

The x-values of the plotted data (1-D array).

assert_x_data_equal(x_data)

Assert that the given x-data is equivalent to the plotted x_data.

Parameters:

x_data : 1-D array-like

The expected x-data. The number of elements should be equal to the (expected) number of plotted points.

y_data

The y-values of the plotted data (1-D array).

assert_y_data_equal(y_data)

Assert that the given y-data is equivalent to the plotted y_data.

Parameters:

y_data : 1-D array-like

The expected y-data. The number of elements should be equal to the (expected) number of plotted points.

colors

The colors of the plotted points. Columns correspond to RGB values.

assert_colors_equal(colors)

Assert that the given colors are equivalent to the plotted colors.

Parameters:

colors : single color, or list of expected line colors

Each color can be either a matplotlib color name (e.g. 'r' or 'red'), a hexcode (e.g. "#FF0000"), a 3-tuple RGB color, or a 4-tuple RGBA color.

alphas

The alpha values of the plotted points.

assert_alphas_equal(alphas)

Assert that the given alpha values are equivalent to the plotted alphas.

Parameters:

alphas :

The expected alpha values. This should either be a single number (which will apply to all the points) or an array with size equal to the number of (expected) points.

edgecolors

The edge colors of the plotted points. Columns correspond to RGB values.

assert_edgecolors_equal(edgecolors)

Assert that the given edge colors are equivalent to the plotted edgecolors.

Parameters:

edgecolors : single color, or list of expected edge colors

Each color can be either a matplotlib color name (e.g. 'r' or 'red'), a hexcode (e.g. "#FF0000"), a 3-tuple RGB color, or a 4-tuple RGBA color.

edgewidths

The edge widths of the plotted points.

assert_edgewidths_equal(edgewidths)

Assert that the given edge widths are equivalent to the plotted edgewidths.

Parameters:

edgewidths :

The expected edge widths. This should either be a single number (which will apply to all the points) or an array with size equal to the number of (expected) points.

sizes

The size of the plotted points. This is the square of markersizes.

assert_sizes_equal(sizes)

Assert that the given point sizes are equivalent to the plotted sizes.

Parameters:

sizes :

The expected point sizes. This should either be a single number (which will apply to all the points) or an array with size equal to the number of (expected) points.

markersizes

The marker size of the plotted points. This is the square root of sizes.

assert_markersizes_equal(markersizes)

Assert that the given marker sizes are equivalent to the plotted markersizes.

Parameters:

markersizes :

The expected marker sizes. This should either be a single number (which will apply to all the points) or an array with size equal to the number of (expected) points.

markers

The marker styles of the plotted points. Unfortunately, this information is currently unrecoverable from matplotlib, and so this attribute is not actually implemented.

assert_markers_equal(markers)

Assert that the given marker styles are equivalent to the plotted markers.

Note: information about marker style is currently unrecoverable from collections in matplotlib, so this method is not actually implemented.

Parameters:

markers :

The expected marker styles. This should either be a single style (which will apply to all the points) or an array with size equal to the number of (expected) points.