unpack_rmf

sherpa.astro.ui.unpack_rmf(arg)

Create a RMF data structure.

Changed in version 4.16.0: 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).

Parameters:

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.

Returns:

rmf

Return type:

a sherpa.astro.instrument.RMF1D instance

See also

get_rmf

Return the RMF associated with a PHA data set.

load_arf

Load a RMF from a file and add it to a PHA data set.

load_bkg_rmf

Load a RMF from a file and add it to the background of a PHA data set.

load_multi_rmfs

Load multiple RMFs for a PHA data set.

load_pha

Load a file as a PHA data set.

load_rmf

Load a RMF from a file and add it to a PHA data set.

set_full_model

Define the convolved model expression for a data set.

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.

Examples

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

Read in a RMF using Crates:

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

Read in a RMF using AstroPy:

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