get_data_plot_prefs

Context: data

Synopsis

Return the preferences for plot_data.

Syntax

get_data_plot_prefs(id=None)

id - int or str, optional

Description

The plot preferences may depend on the data set, so it is now an optional argument.

Example

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

>>> prefs = get_data_plot_prefs()
>>> prefs['color'] = 'green'
>>> prefs['yerrorbars'] = False

PARAMETERS

The parameter for this function is:

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

Return value

The return value from this function is:

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

Notes

The meaning of the fields depend on the chosen plot backend. A value of none means to use the default value for that attribute, unless indicated otherwise. These preferences are used by the following commands: `plot_data` , `plot_bkg` , `plot_ratio` , and the "fit" variants, such as `plot_fit` , `plot_fit_resid` , and `plot_bkg_fit` .

The following preferences are recognized by the matplotlib backend:

Item	Definition
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). The default is none .
ecolor	The color to draw error bars. The default is none .
linestyle	How should the line connecting the data points be drawn. The default is 'None', which means no line is drawn.
marker	What style is used for the symbols. The default is '.' which indicates a point.
markerfacecolor	What color to draw the symbol representing the data points. The default is none .
markersize	What size is the symbol drawn. The default is none .
xerrorbars	Should error bars be drawn for the X axis. The default is False .
xlog	Should the X axis be drawn with a logarithmic scale? The default is False . This field can also be changed with the `set_xlog` and `set_xlinear` functions.
yerrorbars	Should error bars be drawn for the Y axis. The default is True .
ylog	Should the Y axis be drawn with a logarithmic scale? The default is False . This field can also be changed with the `set_ylog` and `set_ylinear` functions.

Changes in CIAO

Changed in CIAO 4.13

The id argument has been given.

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.