show_bkg

sherpa.astro.ui.show_bkg(id: IdType | None = None, bkg_id: IdType | None = None, outfile=None, clobber: bool = False) → None

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:

idint, str, or None, optional

The data set. If not given then all background data sets are displayed.

bkg_idint, str, or None, optional

The background component to display. The default is all components.

outfilestr, 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.

clobberbool, 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.