plot_bkg_model
- sherpa.astro.ui.plot_bkg_model(id: IdType | None = None, bkg_id: IdType | None = None, replot=False, overplot=False, clearwindow=True, **kwargs) None
Plot the model for the background of a PHA data set.
This function plots the model for the background of a PHA data set, which includes any instrument response (the ARF and RMF).
- Parameters:
id (int, 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 toplot_bkg_model
. The default isFalse
.overplot (bool, optional) – If
True
then add the data to an existing plot, otherwise create a new plot. The default isFalse
.clearwindow (bool, optional) – Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?
- Raises:
sherpa.utils.err.ArgumentErr – If the data set does not contain PHA data.
sherpa.utils.err.IdentifierErr – If the
bkg_id
parameter is invalid.sherpa.utils.err.ModelErr – If no model expression has been created for the background data.
See also
get_bkg_model_plot
Return the data used by plot_bkg_model.
plot_bkg_source
Plot the model expression for the background of a PHA data set.
set_bkg_model
Set the background model expression for a PHA data set.
Examples
>>> plot_bkg_model()
>>> plot_bkg('jet') >>> plot_bkg_model('jet', bkg_id=1, overplot=True) >>> plot_bkg_model('jet', bkg_id=2, overplot=True)