show_bkg_source
- sherpa.astro.ui.show_bkg_source(id=None, bkg_id=None, outfile=None, clobber=False)
Display the background model expression for a data set.
This displays the background model for a data set, that is, the expression set by
set_bkg_model
orset_bkg_source
, as well as the parameter values for the model. Theshow_bkg_model
function displays the model that is fit to the data; that is, it includes any instrument responses.- Parameters:
id (int or str, optional) – The data set. If not given then all background expressions 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 notNone
, 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 andclobber
isFalse
.
See also
list_model_ids
List of all the data sets with a source expression.
set_bkg_model
Set the background model expression for a data set.
show_all
Report the current state of the Sherpa session.
show_model
Display the model expression used to fit a data set.
show_bkg_model
Display the background model expression used to fit a data set.