get_model_plot_prefs

sherpa.astro.ui.get_model_plot_prefs(id: IdType | None = None) → PrefsType

Return the preferences for plot_model.

The plot preferences may depend on the data set, so it is now an optional argument. The get_plot_prefs routine should be used instead.

Changed in version 4.12.2: The id argument has been given.

Parameters:

idint, str, or None, optional

The data set that provides the data. If not given then the default identifier is used, as returned by get_default_id.

Returns:

prefsdict

Changing the values of this dictionary will change any new model plots. This dictionary will be empty if no plot backend is available.

See also

get_plot_prefs, plot_model, set_xlinearm, set_xlog, set_ylinear

set_ylog

Notes

These preferences are used by the following commands: plot_model, plot_ratio, plot_bkg_model, and the “fit” variants, such as plot_fit, plot_fit_resid, and plot_bkg_fit.

The preferences recognized by the matplotlib backend are the same as for get_plot_prefs.

Examples

After these commands, any model plot will use a green line to display the model:

>>> prefs = get_model_plot_prefs()
>>> prefs['color'] = 'green'