sherpa.astro.ui.plot_bkg_resid(id=None, bkg_id=None, replot=False, overplot=False, clearwindow=True, **kwargs)

Plot the residual (data-model) values for the background of a PHA data set.

Display the residuals for the background of a PHA data set when it is being fit, rather than subtracted from the source.

Changed in version 4.12.0: The Y axis is now always drawn using a linear scale.

  • 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.

  • replot (bool, optional) – Set to True to use the values calculated by the last call to plot_bkg_resid. The default is False.

  • overplot (bool, optional) – If True then add the data to an existing plot, otherwise create a new plot. The default is False.

  • clearwindow (bool, optional) – Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?


See also


Return the data used by plot_bkg_resid.


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


Plot the ratio of residuals to error for the background of a PHA data set.


Plot the ratio of data to model values for the background of a PHA data set.


Set the background model expression for a PHA data set.


The ylog setting is ignored, and the Y axis is drawn using a linear scale.


>>> plot_bkg_resid()
>>> plot_bkg('jet')
>>> plot_bkg_resid('jet', bkg_id=1, overplot=True)
>>> plot_bkg_resid('jet', bkg_id=2, overplot=True)