load_multi_rmfs

sherpa.astro.ui.load_multi_rmfs(id, filenames, resp_ids=None)

Load multiple RMFs for a PHA data set.

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.

Parameters:
  • id (int or str, optional) – The data set to use. If not given then the default identifier is used, as returned by get_default_id.
  • filenames (iterable of str) – An array of file names.
  • resp_ids (iterable of int or str) – The identifiers for the RMF within this data set. The length should match the filenames argument.

See also

load_rmf()
Load a RMF from a file and add it to a PHA data set.
load_multi_arfs()
Load multiple ARFs for a PHA data set.

Notes

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.

Examples

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])

Load in the RMFs to the data set with the identifier ‘lowstate’:

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