save_data

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

Save the data to a file.

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 data is written out as an ASCII file.

  • bkg_id (int, str, or None, optional) – Set if the background should be written out rather than the source (for a PHA data set).

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

  • clobber (bool, optional) – 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_arrays

Write a list of arrays to a file.

save_delchi

Save the ratio of residuals (data-model) to error to a file.

save_error

Save the errors to a file.

save_filter

Save the filter array to a file.

save_grouping

Save the grouping scheme to a file.

save_image

Save the pixel values of a 2D data set to a file.

save_pha

Save a PHA data set to a file.

save_quality

Save the quality array to a file.

save_resid

Save the residuals (data-model) to a file.

save_staterror

Save the statistical errors to a file.

save_syserror

Save the statistical errors to a file.

save_table

Save a data set to a file as a table.

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.

Examples

Write the default data set out to the ASCII file ‘src.dat’:

>>> save_data('src.dat')

Write the ‘rprof’ data out to the FITS file ‘prof.fits’, over-writing it if it already exists:

>>> save_data('rprof', 'prof.fits', clobber=True, ascii=True)