show_bkg

sherpa.astro.ui.show_bkg(id=None, bkg_id=None, outfile=None, clobber=False)

Show the details of the PHA background data sets.

This displays information about the background, or backgrounds, for the loaded data sets. This includes: any filters, the grouping settings, mission-specific header keywords, and the details of any associated instrument responses files (ARF, RMF).

Parameters:

• id (int or str, optional) – The data set. If not given then all background data sets are displayed.
• bkg_id (int or str, optional) – The background component to display. The default is all components.
• outfile (str, optional) – If not given the results are displayed to the screen, otherwise it is taken to be the name of the file to write the results to.
• clobber (bool, optional) – If outfile is not None, then this flag controls whether an existing file can be overwritten (True) or if it raises an exception (False, the default setting).

Raises:

sherpa.utils.err.IOErr – If outfile already exists and clobber is False.

See also

list_model_ids()

List of all the data sets with a source expression.

load_bkg()

Load the background from a file and add it to a PHA data set.

show_all()

Report the current state of the Sherpa session.

Notes

When outfile is None, the text is displayed via an external program to support paging of the information. The program used is determined by the PAGER environment variable. If PAGER is not found then ‘/usr/bin/more’ is used.