save_pha

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

Save a PHA data set to a file.

Parameters:

idint 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.

filenamestr

The name of the file to write the array to. The format is determined by the ascii argument.

bkg_idint, str, or None, optional

Set if the background should be written out rather than the source.

asciibool, 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).

clobberbool, 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.ArgumentErr

If the data set does not contain PHA data.

sherpa.utils.err.IOErr

If filename already exists and clobber is False.

See also

load_pha, save_arf, save_rmf

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 out the PHA data from the default data set to the file ‘src.pi’:

>>> save_pha('src.pi')

Over-write the file it it already exists, and take the data from the data set “jet”:

>>> save_pha('jet', 'out.pi', clobber=True)

Write the data out as an ASCII file:

>>> save_pha('pi.dat', ascii=True)