Last modified: December 2023

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


AHELP for CIAO 4.16 Sherpa

list_response_ids

Context: info

Synopsis

List all the response identifiers of a data set.

Syntax

list_response_ids(id=None, bkg_id=None)

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

Description

A PHA data set can contain multiple responses, that is, pairs of ARF and RMF, each of which has an identifier. This function returns a list of these identifiers for a data set.


PARAMETERS

The parameters for this function are:

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

Return value

The return value from this function is:

ids -- The identifiers for the response information 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
copy_data, dataspace1d, dataspace2d, datastack, delete_data, fake, get_arf, get_axes, 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, 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_quality, get_rmf, get_specresp, get_staterror, get_syserror, group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width, load_arf, load_ascii, load_bkg_arf, load_bkg_rmf, load_data, load_grouping, load_multi_arfs, load_multi_rmfs, load_quality, load_rmf, set_arf, set_data, set_quality, set_rmf, ungroup, unpack_arf, unpack_ascii, unpack_data, unpack_rmf
filtering
get_filter, load_filter, set_filter
info
get_default_id, get_functions, list_bkg_ids, list_data_ids, list_functions
methods
list_iter_methods, list_methods
modeling
clean, get_response
models
list_model_components, list_models
plotting
plot_arf, plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog
saving
save_error, save_filter, save_grouping, save_quality, save_staterror, save_syserror
statistics
list_priors, list_samplers
utilities
calc_data_sum, calc_data_sum2d, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum2d, calc_source_sum2d, get_rate
visualization
contour, contour_data, contour_ratio, histogram1d, histogram2d, image_data, rebin