model.HydrostaticEquilibrium.panel_plot#

HydrostaticEquilibrium.panel_plot(fields='all', r_min=None, r_max=None, fig=None, axes=None, aspect_ratio=1, base_length=3, gs_kwargs=None, **kwargs)#

Plot all of the selected fields in a grid of axes. Useful for checking for non-physical issues and getting a general impression of the generated model.

Parameters:

  • fields (list or str) – The fields to include in the plot. If fields="all", then all of the fields available will be plotted. Otherwise, fields should be a list of field names.

  • r_min (float or int, optional) – The minimum radius (kpc) from which to plot. Determined if not specified.

  • r_max (float or int, optional) – The maximum radius (kpc) from which to plot. Determined if not specified.

  • fig (Figure, optional) –

    A Figure instance onto which to place the plots. If not specified, a fresh one will be generated.

    Warning

    If a figure is specified but the axes are not specified, then this will overwrite / cover up any pre-existing plots on those axes.

  • axes (dict of str: Axes, optional) – The axes onto which the plots should be drawn. These should be organized as a dictionary with keys corresponding to the field name belonging to the plot and the corresponding axes on which that plot is drawn. If not specified, a grid is generated on the figure and subdivided to facilitate the drawing.

  • aspect_ratio (float, optional) – The aspect ratio of the individual subplots.

  • base_length (float, optional) – The base length of each plot. Used to determine rest of the geometry.

  • gs_kwargs (dict, optional) – additional kwargs to pass to the matplotlib.figure.GridSpec instance.

  • **kwargs –

    Additional keyword arguments which are to be passed directly to matplotlib.pyplot.plot(). There are several formatting options for these keyword arguments and the behavior depends on their format.

    • If the kwarg values are dict, then they should have keys corresponding to the different fields and those kwargs will be passed to the field plot. If a key is missing, then no kwargs are passed for that setting.

    • If kwarg values are not dictionaries, they will be applied uniformly across all of the subplots.

Returns:

  • Figure – The figure corresponding to the plot.

  • Axes – The axes dictionary corresponding to the plot