17.2.5.4. cis.plotting package

17.2.5.4.1. cis.plotting.plot module

Class for plotting graphs. Also contains a dictionary for the valid plot types. All plot types need to be imported and added to the plot_types dictionary in order to be used.

class cis.plotting.plot.Plotter(packed_data_items, plot_type=None, out_filename=None, *mplargs, **mplkwargs)

Bases: object

output_to_file_or_screen(out_filename=None)

Outputs to screen unless a filename is given

Parameters:out_filename – The filename of the file to save the plot to. Various file extensions can be used, with png being the default

plot_types = {'contourf': <class 'cis.plotting.contourf_plot.Contourf_Plot'>, 'heatmap': <class 'cis.plotting.heatmap.Heatmap'>, 'comparativescatter': <class 'cis.plotting.comparative_scatter.Comparative_Scatter'>, 'overlay': <class 'cis.plotting.overlay.Overlay'>, 'line': <class 'cis.plotting.line_plot.Line_Plot'>, 'histogram2d': <class 'cis.plotting.histogram2d.Histogram_2D'>, 'histogram3d': <class 'cis.plotting.histogram3d.Histogram_3D'>, 'contour': <class 'cis.plotting.contour_plot.Contour_Plot'>, 'scatter': <class 'cis.plotting.scatter_plot.Scatter_Plot'>}

remove_unassigned_arguments()

Removes arguments from the mplkwargs if they are equal to None

set_default_plot_type(data)

Sets the default plot type based on the number of dimensions of the data :param data: A list of packed data items :return: The default plot type as a string