Last modified: December 2023

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/unpack_rmf.html
AHELP for CIAO 4.16 Sherpa

unpack_rmf

Context: data

Synopsis

Create a RMF data structure.

Syntax

unpack_rmf(arg)

Description


Examples

Example 1

>>> rmf1 = unpack_rmf("rmf1.fits")
>>> rmf2 = unpack_rmf("rmf2.fits")

Example 2

Read in a RMF using Crates:

>>> acr = pycrates.read_rmf("src.rmf")
>>> rmf = unpack_rmf(acr)

Example 3

Read in a RMF using AstroPy:

>>> hdus = astropy.io.fits.open("src.rmf")
>>> rmf = unpack_rmf(hdus)

PARAMETERS

The parameter for this function is:

Parameter Definition
arg Identify the RMF: a file name, or a data structure representing the data to use, as used by the I/O backend in use by Sherpa: a rmfcratedataset for crates, as used by CIAO, or a list of AstroPy HDU objects.

Notes

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.

Changes in CIAO

Changed in CIAO 4.16

This command does not support multi-matrix RMF files and will warn the user when given such a file (as only the first matrix is read in, the results will not be correct).


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, 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_multi_rmfs, 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_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
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