Last modified: December 2020

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


AHELP for CIAO 4.13 Sherpa v1

list_bkg_ids

Context: info

Synopsis

List all the background identifiers for a data set.

Syntax

list_bkg_ids(id=None)

id - int or str, optional

Description

A PHA data set can contain multiple background datasets, each identified by an integer or string. This function returns a list of these identifiers for a data set.


PARAMETERS

The parameter for this function is:

Parameter Definition
id The data set to query. If not given then the default identifier is used, as returned by `get_default_id` .

Return value

The return value from this function is:

ids -- The identifiers for the backround data sets for the data set. In many cases this will just be [1] .


Bugs

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

See Also

data
dataspace1d, dataspace2d, datastack, fake, get_bkg, get_bkg_arf, get_bkg_model, get_bkg_rmf, get_bkg_source, load_arf, load_arrays, load_ascii, load_bkg, load_bkg_arf, load_bkg_rmf, load_data, load_grouping, load_image, load_multi_arfs, load_multi_rmfs, load_pha, load_quality, load_rmf, load_staterror, load_syserror, load_table, pack_image, pack_pha, pack_table, set_bkg, subtract, unpack_arf, unpack_arrays, unpack_ascii, unpack_bkg, unpack_data, unpack_image, unpack_pha, unpack_rmf, unpack_table, unsubtract
filtering
load_filter, show_filter
info
get_default_id, get_functions, list_data_ids, list_functions, list_response_ids, show_all, show_bkg_model, 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, delete_bkg_model, load_table_model, load_template_interpolator, load_template_model, load_user_model, save_model, save_source
plotting
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
saving
save_arrays, save_data, save_delchi, save_error, save_filter, save_grouping, save_image, save_pha, save_quality, save_resid, save_staterror, save_syserror, save_table
statistics
load_user_stat