Last modified: December 2023

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/save_data.html
Jump to: · Examples · PARAMETERS · Notes · Bugs · See Also


AHELP for CIAO 4.16 Sherpa

save_data

Context: saving

Synopsis

Save the data to a file.

Syntax

save_data(id, filename=None, bkg_id=None, ascii=True, clobber=False)

id - int or str, optional
filename - str
bkg_id - int or str, optional
ascii - bool, optional
clobber - bool, optional

Examples

Example 1

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

>>> save_data('src.dat')

Example 2

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)

PARAMETERS

The parameters for this function are:

Parameter Definition
id The identifier for the data set to use. If not given then the default identifier is used, as returned by `get_default_id` .
filename The name of the file to write the array to. The data is written out as an ASCII file.
bkg_id Set if the background should be written out rather than the source (for a PHA data set).
ascii 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 This flag controls whether an existing file can be overwritten ( True ) or if it raises an exception ( False , the default setting).

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.


Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

contrib
save_chart_spectrum, save_marx_spectrum
data
dataspace1d, dataspace2d, datastack, fake, load_arf, load_arrays, load_ascii, load_bkg, load_bkg_arf, load_bkg_rmf, load_data, load_grouping, load_image, load_multi_arfs, load_multi_rmfs, load_pha, load_quality, load_rmf, load_staterror, load_syserror, load_table, pack_image, pack_pha, pack_table, unpack_arf, unpack_arrays, unpack_ascii, unpack_bkg, unpack_data, unpack_image, unpack_pha, unpack_rmf, unpack_table
filtering
load_filter
info
get_default_id, list_bkg_ids, list_data_ids
modeling
add_model, add_user_pars, load_table_model, load_template_interpolator, load_template_model, load_user_model, save_model, save_source
saving
restore, save, save_all, save_arrays, save_delchi, save_error, save_filter, save_grouping, save_image, save_pha, save_quality, save_resid, save_staterror, save_syserror, save_table, script
statistics
load_user_stat