Synopsis
Show the details of the PHA background data sets.
Syntax
show_bkg(id=None, bkg_id=None, outfile=None, clobber=False)
Description
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
The parameters for this function are:
| Parameter | Type information | Definition |
|---|---|---|
| id | int, str, or None, optional | The data set. If not given then all background data sets are displayed. |
| bkg_id | int, str, or None, 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). |
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- info
- show_all