Last modified: December 2023

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


AHELP for CIAO 4.16 Sherpa

get_bkg_source

Context: data

Synopsis

Return the model expression for the background of a PHA data set.

Syntax

get_bkg_source(id=None, bkg_id=None)

id - int or str, optional
bkg_id - int or str, optional

Description

This returns the model expression created by `set_bkg_model` or `set_bkg_source` . It does not include any instrument response.


Example

Return the background model expression for the default data set:

>>> bkg = get_bkg_source()
>>> len(bkg.pars)
2

PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set to use. If not given then the default identifier is used, as returned by `get_default_id` .
bkg_id Identify the background component to use, if there are multiple ones associated with the data set.

Return value

The return value from this function is:

model -- This can contain multiple model components. Changing attributes of this model changes the model used by the data set.


Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

confidence
get_conf, get_conf_results, get_covar, get_covar_opt, get_covar_results, get_covariance_results, get_int_proj, get_int_unc, get_proj, get_proj_opt, get_proj_results, get_projection_results, get_reg_proj, get_reg_unc
contrib
get_chart_spectrum, get_marx_spectrum
data
get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, 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_scale, get_bkg_source_plot, get_coord, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_data_plot_prefs, get_dep, get_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror, load_arf, load_bkg_arf, load_bkg_rmf, load_multi_arfs, load_multi_rmfs, load_rmf, set_arf, set_bkg, set_rmf, subtract, unpack_arf, unpack_rmf, unsubtract
filtering
get_filter
fitting
calc_stat_info, get_stat_info
info
get_default_id, list_bkg_ids, list_response_ids, list_stats, show_bkg_model, show_bkg_source
methods
get_draws, get_iter_method_name, get_iter_method_opt, get_method, get_method_name, get_method_opt
modeling
delete_bkg_model, get_model, 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_response, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, image_source
plotting
get_split_plot, plot_arf, 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
psfs
get_psf, get_psf_contour, get_psf_image, get_psf_plot
statistics
get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
utilities
get_analysis, get_rate
visualization
image_getregion