save_rmf

sherpa.astro.ui.save_rmf(id, filename=None, resp_id=None, bkg_id: IdType | None = None, clobber=False) → None

Save an RMF data set to a file.

Added in version 4.16.0.

Parameters:

idint or str: The identifier for the data set containing the RMF or the filename (the latter is used when filename is set to None, and in this case the id is set to the default identifier, as returned by get_default_id).
filenamestr or None: The name of the file to write the RMF to (when the id value is explicitly given). Note that the format is always FITS.
resp_idint, str, or None, optional: The identifier for the RMF within this data set, if there are multiple responses.
bkg_idint, str, or None, optional: Set if the background RMF should be written out rather than the source RMF.
clobberbool, optional: This flag controls whether an existing file can be overwritten (True) or if it raises an exception (False).

Raises:

sherpa.utils.err.ArgumentErr: If the data set does not contain a RMF.
sherpa.utils.err.IOErr: If filename already exists and clobber is False.

See also

create_rmf, load_arf, save_arf, save_pha

Notes

The function does not follow the normal Python standards for parameter use, since it is designed for easy interactive use. When called with a single un-named argument, it is taken to be the filename parameter. If given two un-named arguments, then they are interpreted as the id and filename parameters, respectively. The remaining parameters must be given as named arguments.

Examples

Write out the RMF data from the default data set to the file ‘src.rmf’:

>>> save_rmf('src.rmf')

Over-write the file it it already exists, and take the data from the data set “jet”:

>>> save_rmf('jet', 'out.rmf', clobber=True)