get_plot_prefs

sherpa.astro.ui.get_plot_prefs(plottype: str, id: IdType | None = None, **kwargs) → PrefsType

Return the preferences for the given plot type.

Added in version 4.16.0.

Parameters:

plottypestr: The type of plt, such as “data”, “model”, or “resid”. The “fit” argument is not supported.
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 data plots. This dictionary will be empty if no plot backend is available.

See also

get_data_plot_prefs, get_model_plot_prefs
set_xlinear, set_xlog, set_ylinear, set_ylog

Notes

The “fit” argument can not be used, even though there is a get_fit_plot call. Either use the “data” or “model” arguments to access the desired plot type, or use get_fit_plot() and access the dataplot and modelplot attributes directly.

The meaning of the fields depend on the chosen plot backend. A value of None means to use the default value for that attribute, or not to use that setting.

The following preferences are recognized by the matplotlib backend:

alpha: The transparency value used to draw the line or symbol, where 0 is fully transparent and 1 is fully opaque.
barsabove: The barsabove argument for the matplotlib errorbar function.
capsize: The capsize argument for the matplotlib errorbar function.
color: The color to use (will be over-ridden by more-specific options below).
ecolor: The color to draw error bars.
linestyle: How should the line connecting the data points be drawn.
marker: What style is used for the symbols.
markerfacecolor: What color to draw the symbol representing the data points.
markersize: What size is the symbol drawn.
xerrorbars: Should error bars be drawn for the X axis.
xlog: Should the X axis be drawn with a logarithmic scale? This field can also be changed with the set_xlog and set_xlinear functions.
yerrorbars: Should error bars be drawn for the Y axis.
ylog: Should the Y axis be drawn with a logarithmic scale? This field can also be changed with the set_ylog and set_ylinear functions.

Examples

After these commands, any data plot will use a green symbol and not display Y error bars.

>>> prefs = get_plot_prefs("data")
>>> prefs['color'] = 'green'
>>> prefs['yerrorbars'] = False