save_model

sherpa.ui.save_model(id, filename=None, clobber=False, sep=' ', comment='#', linebreak='\n', format='%g')

Save the model values to a file.

The model is evaluated on the grid of the data set, including any instrument response (such as a PSF).

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.
  • clobber (bool, optional) – If filename 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).
  • sep (str, optional) – The separator character. The default is ' '.
  • comment (str, optional) – The comment character. The default is '#'.
  • linebreak (str, optional) – Indicate a new line. The default is '\n'.
  • format (str, optional) – The format used to write out the numeric values. The default is '%g%'.
Raises:

See also

save_data()
Save the data to a file.
save_source()
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 MODEL (for 1D data). The residuals array respects any filter setting for the data set.

Examples

Write the model to the file “model.dat”:

>>> save_model('model.dat')

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

>>> save_model('jet', "jet.mdl", clobber=True)