Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/get_data_plot_prefs.html
AHELP for CIAO 4.13 Sherpa v1

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 .
ratioline Should a horizontal line be drawn at y=1? The default is False .
xaxis The default is False
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.

See Also

confidence
get_conf, get_conf_results, get_covar, get_covar_opt, get_covar_results, get_covariance_results, get_int_proj, get_int_unc, get_proj, get_proj_opt, get_proj_results, get_projection_results, get_reg_proj, get_reg_unc
contrib
get_chart_spectrum, get_marx_spectrum
data
copy_data, dataspace1d, dataspace2d, datastack, delete_data, fake, get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_arf, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_rmf, get_bkg_scale, get_bkg_source, get_bkg_source_plot, get_coord, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_dep, get_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror, group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width, load_ascii, load_data, load_grouping, load_quality, set_data, set_quality, ungroup, unpack_ascii, unpack_data
filtering
get_filter, load_filter, set_filter
fitting
calc_stat_info, get_stat_info
info
get_default_id, list_data_ids, list_response_ids, list_stats
methods
get_draws, get_iter_method_name, get_iter_method_opt, get_method, get_method_name, get_method_opt
modeling
clean, get_model, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_response, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, image_source
plotting
get_split_plot, plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog
psfs
get_psf, get_psf_contour, get_psf_image, get_psf_plot
saving
save_error, save_filter, save_grouping, save_quality, save_staterror, save_syserror
statistics
get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
utilities
calc_data_sum, calc_data_sum2d, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum2d, calc_source_sum2d, get_analysis, get_rate
visualization
contour, contour_data, contour_ratio, histogram1d, histogram2d, image_data, image_getregion, rebin