Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/show_bkg_model.html
Jump to: Description · PARAMETERS · Bugs · See Also


AHELP for CIAO 4.13 Sherpa v1

show_bkg_model

Context: info

Synopsis

Display the background model expression used to fit a data set.

Syntax

show_bkg_model(id=None, bkg_id=None, outfile=None, clobber=False)

id - int or str, optional
bkg_id - int or str, optional
outfile - str, optional
clobber - bool, optional

Description

This displays the model used to the the background data set, that is, the expression set by `set_bkg_model` or `set_bkg_source` combined with any instrumental responses, together with the parameter values for the model. The `show_bkg_source` function displays just the background model, without the instrument components (if any).


PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set. If not given then all background expressions are displayed.
bkg_id The background component to display. The default is all components.
outfile 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 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

data
get_bkg, get_bkg_arf, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_rmf, get_bkg_source, get_bkg_source_plot, set_bkg, subtract, unsubtract
filtering
show_filter
info
get_functions, list_bkg_ids, list_functions, list_model_ids, show_all, show_bkg_source, show_conf, show_covar, show_data, show_fit, show_method, show_model, show_proj, show_source, show_stat
modeling
add_model, add_user_pars, clean, create_model_component, delete_bkg_model, delete_model, delete_model_component, get_model, get_model_autoassign_func, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, get_xsabund, get_xscosmo, get_xsxsect, get_xsxset, image_model, image_model_component, image_source, image_source_component, integrate, link, load_table_model, load_template_interpolator, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_bkg_source, set_full_model, set_model, set_model_autoassign_func, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset, t_sample, uniform_sample
plotting
get_cdf_plot, get_pdf_plot, get_pvalue_plot, get_pvalue_results, plot_bkg, plot_bkg_chisqr, plot_bkg_delchi, plot_bkg_fit, plot_bkg_fit_delchi, plot_bkg_fit_resid, plot_bkg_model, plot_bkg_ratio, plot_bkg_resid, plot_bkg_source, plot_cdf, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace
psfs
delete_psf, load_conv
saving
save_delchi, save_resid
utilities
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth
visualization
contour_model, contour_ratio, contour_resid