get_bkg_chisqr_plot

sherpa.astro.ui.get_bkg_chisqr_plot(id=None, bkg_id=None)

Return the data used by plot_bkg_chisqr.

Parameters
  • id (int or str, optional) – The data set that provides the data. If not given then the default identifier is used, as returned by get_default_id.

  • bkg_id (int or str, optional) – Identify the background component to use, if there are multiple ones associated with the data set.

Returns

source – An object representing the data used to create the plot by plot_bkg_chisqr.

Return type

a sherpa.astro.plot.BkgChisqrPlot instance

Raises

See also

get_bkg_delchi_plot()

Return the data used by plot_bkg_delchi.

get_bkg_ratio_plot()

Return the data used by plot_bkg_ratio.

get_bkg_resid_plot()

Return the data used by plot_bkg_resid.

plot_bkg_chisqr()

Plot the chi-squared value for each point of the background of a PHA data set.

Examples

>>> bplot = get_bkg_chisqr_plot()
>>> print(bplot)
>>> get_bkg_chisqr_plot('jet', bkg_id=1).plot()
>>> get_bkg_chisqr_plot('jet', bkg_id=2).overplot()