# save_image¶

sherpa.astro.ui.save_image(id, filename=None, ascii=False, clobber=False)

Save the pixel values of a 2D data set 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 data to. The format is determined by the ascii argument.

• 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

sherpa.utils.err.IOErr – If filename already exists and clobber is False. If the data set does not contain 2D data.

save_data()

Save the data to a file.

save_model()

Save the model values to a file.

save_source()

Save the model values 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 pixel values to the file “img.fits”:

>>> save_image('resid.fits')


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

>>> save_image('jet', 'jet.img', clobber=True)