Last modified: December 2020

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


AHELP for CIAO 4.13 Sherpa v1

load_multi_arfs

Context: data

Synopsis

Load multiple ARFs for a PHA data set.

Syntax

load_multi_arfs(id, filenames, resp_ids=None)

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

Description

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


Examples

Example 1

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

>>> arfs = ['m1.arf', 'p1.arf']
>>> load_multi_arfs(arfs, [1,2])

Example 2

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

>>> load_multi_arfs('lowstate', arfs, [1,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` .
filenames An array of file names.
resp_ids The identifiers for the ARF within this data set. The length should match the filenames argument.

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 ARF 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.


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_arf, 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_rmfs, load_pha, load_quality, load_rmf, load_staterror, load_syserror, load_table, pack_image, pack_pha, pack_table, set_arf, unpack_arf, unpack_arrays, unpack_ascii, unpack_bkg, unpack_data, unpack_image, unpack_pha, unpack_rmf, unpack_table
filtering
load_filter
info
get_default_id, list_bkg_ids, list_data_ids, list_response_ids
modeling
add_model, add_user_pars, get_response, load_table_model, load_template_interpolator, load_template_model, load_user_model, save_model, save_source
plotting
plot_arf
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