Synopsis
Save an RMF data set to a file.
Syntax
save_rmf(id, filename=None, resp_id=None, bkg_id=None, clobber=False) id - int or str filename - str or None resp_id - int or str, optional bkg_id - int or str, optional clobber - bool, optional
Description
Examples
Example 1
Write out the RMF data from the default data set to the file 'src.rmf':
>>> save_rmf('src.rmf')
Example 2
Over-write the file it it already exists, and take the data from the data set "jet":
>>> save_rmf('jet', 'out.rmf', clobber=True)
PARAMETERS
The parameters for this function are:
Parameter | Definition |
---|---|
id | 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` ). |
filename | 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_id | The identifier for the RMF within this data set, if there are multiple responses. |
bkg_id | Set if the background RMF should be written out rather than the source RMF. |
clobber | This flag controls whether an existing file can be overwritten ( True ) or if it raises an exception ( False ). |
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.
Changes in CIAO
Added in CIAO 4.16
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- data
- create_rmf
- saving
- save_pha
- sherpaish
- save_arf