get_bkg_plot

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

Return the data used by plot_bkg.

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:

data – An object representing the data used to create the plot by plot_data. The relationship between the returned values and the values in the data set depend on the analysis, filtering, and grouping settings of the data set.

Return type:

a sherpa.astro.plot.BkgDataPlot instance

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.

See also

get_default_id()

Return the default data set identifier.

plot_bkg()

Plot the background values for a PHA data set.