Last modified: December 2020

Jump to: Description · Examples · PARAMETERS · Notes · Bugs · See Also

AHELP for CIAO 4.13 Sherpa v1


Context: data


Load multiple RMFs for a PHA data set.


load_multi_rmfs(id, filenames, resp_ids=None)

id - int or str, optional
filenames - iterable of str
resp_ids - iterable of int or str


A grating observation - such as a Chandra HETG data set - may require multiple responses. This function lets the multiple RMFs for such a data set be loaded with one command. The `load_rmf` function can instead be used to load them in individually.


Example 1

Load two RMFs into the default data set, using response ids of 1 and 2 for 'm1.rmf' and 'p1.rmf' respectively:

>>> rmfs = ['m1.rmf', 'p1.rmf']
>>> load_multi_rmfs(rmfs, [1,2])

Example 2

Load in the RMFs to the data set with the identifier 'lowstate':

>>> load_multi_rmfs('lowstate', rmfs, [1,2])


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` .
filenames An array of file names.
resp_ids The identifiers for the RMF within this data set. The length should match the filenames argument.


The function does not follow the normal Python standards for parameter use, since it is designed for easy interactive use. When called with two arguments, they are assumed to be filenames and resp_ids , and three positional arguments means `id` , filenames , and resp_ids .

The `minimum_energy` setting of the `ogip` section of the Sherpa configuration file determines the behavior when an RMF with a minimum energy of 0 is read in. The default is to replace the 0 by the value 1e-10, which will also cause a warning message to be displayed.


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

See Also

dataspace1d, dataspace2d, datastack, fake, get_bkg, get_bkg_arf, get_bkg_model, get_bkg_rmf, get_bkg_source, get_rmf, load_arf, load_arrays, load_ascii, load_bkg, load_bkg_arf, load_bkg_rmf, load_data, load_grouping, load_image, load_multi_arfs, load_pha, load_quality, load_rmf, load_staterror, load_syserror, load_table, pack_image, pack_pha, pack_table, set_rmf, unpack_arf, unpack_arrays, unpack_ascii, unpack_bkg, unpack_data, unpack_image, unpack_pha, unpack_rmf, unpack_table
get_default_id, list_bkg_ids, list_data_ids, list_response_ids
add_model, add_user_pars, get_response, load_table_model, load_template_interpolator, load_template_model, load_user_model, save_model, save_source
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