get_rmf

sherpa.astro.ui.get_rmf(id=None, resp_id=None, bkg_id=None)

Return the RMF associated with a PHA data set.

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.
• resp_id (int or str, optional) – The identifier for the RMF within this data set, if there are multiple responses.
• bkg_id (int or str, optional) – Set this to return the given background component.

Returns:

rmf – This is a reference to the RMF, rather than a copy, so that changing the fields of the object will change the values in the data set.

Return type:

a sherpa.astro.instrument.RMF1D instance

See also

fake_pha()

Simulate a PHA data set from a model.

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.

set_arf()

Set the ARF for use by a PHA data set.

set_rmf()

Set the RMF for use by a PHA data set.

unpack_rmf()

Read in a RMF from a file.

Examples

Copy the RMF from the default data set to data set 2:

>>> rmf1 = get_rmf()
>>> set_rmf(2, rmf1)

Retrieve the RMF associated to the second background component of the ‘core’ data set:

>>> bgrmf = get_rmf('core', 'bkg.rmf', bkg_id=2)