save_source

sherpa.astro.ui.save_source(id, filename=None, bkg_id: IdType | None = None, ascii=False, clobber=False) → None

Save the model values to a file.

The model is evaluated on the grid of the data set, but does not include any instrument response (such as a PSF or ARF and RMF).

Parameters:

  • id (int or str, optional) – The identifier for the data set to use. If not given then the default identifier is used, as returned by get_default_id.

  • filename (str) – The name of the file to write the array to. The format is determined by the ascii argument.

  • bkg_id (int, str, or None, optional) – Set if the background model should be written out rather than the source.

  • ascii (bool, optional) – If False then the data is written as a FITS format binary table. The default is False. The exact format of the output file depends on the I/O library in use (Crates or AstroPy).

  • clobber (bool, optional) – If outfile is not None, then this flag controls whether an existing file can be overwritten (True) or if it raises an exception (False, the default setting).

Raises:

See also

save_data

Save the data to a file.

save_model

Save the model values to a file.

set_model

Set the source model expression for a data set.

set_full_model

Define the convolved model expression for a data set.

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 are expected to be given as named arguments.

The output file contains the columns X and SOURCE for 1D data sets. The residuals array respects any filter or (for PHA files), grouping settings.

Examples

Write the model values for the default data set to the file “model.fits”:

>>> save_source('model.fits')

Write the model from the data set ‘jet’ to the ASCII file “model.dat”:

>>> save_source('jet', "model.dat", ascii=True)

For 2D (image) data sets, the model is written out as an image:

>>> save_source('img', 'model.img')