act.plotting.DistributionDisplay.plot_scatter#

DistributionDisplay.plot_scatter(x_field, y_field, m_field=None, dsname=None, cbar_label=None, set_title=None, subplot_index=(0,), **kwargs)[source]#

This procedure will produce a scatter plot from 2 variables.

Parameters:

  • x_field (str) – The name of the field to display on the X axis.

  • y_field (str) – The name of the field to display on the Y axis.

  • m_field (str) – The name of the field to display on the markers.

  • cbar_label (str) – The desired name to plot for the colorbar

  • set_title (str) – The desired title for the plot. Default title is created from the datastream.

  • dsname (str or None) – The name of the datastream the field is contained in. Set to None to let ACT automatically determine this.

  • subplot_index (tuple) – The subplot index to place the plot in

  • Other keyword arguments will be passed into :func:`matplotlib.pyplot.scatter`.

Returns:

ax (matplotlib axis handle) – The matplotlib axis handle of the plot