plot_bkg_fit

sherpa.astro.ui.plot_bkg_fit(id: IdType | IdTypes | None = None, bkg_id: IdType | None = None, replot: bool = False, overplot: bool = False, clearwindow: bool = True, **kwargs) → None

Plot the fit results (data, model) for the background of a PHA data set.

Changed in version 4.18.0: Multiple data sets can be displayed by using a list of identifiers. Per-plot options can now be given by using a list of values.

Parameters:

  • id (int, str, sequence of int or 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.

  • bkg_id (int, str, or None, 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_fit. 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)?

Raises:

See also

get_bkg_fit_plot

Return the data used by plot_bkg_fit.

plot

Create one or more plot types.

plot_bkg

Plot the background values for a PHA data set.

plot_bkg_model

Plot the model for the background of a PHA data set.

plot_bkg_fit_delchi

Plot the fit results, and the residuals, for the background of a PHA data set.

plot_bkg_fit_ratio

Plot the fit results, and the data/model ratio, for the background of a PHA data set.

plot_bkg_fit_resid

Plot the fit results, and the residuals, for the background of a PHA data set.

plot_fit

Plot the fit results (data, model) for a data set.

set_analysis

Set the units used when fitting and displaying spectral data.

Examples

Plot the background fit to the default data set:

>>> plot_bkg_fit()