save_data¶
-
sherpa.ui.
save_data
(id, filename=None, fields=None, sep=' ', comment='#', clobber=False, linebreak='\n', format='%g')¶ 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.
fields (array of str, optional) – The attributes of the data set to write out. If
None
, write out all the columns.sep (str, optional) – The separator character. The default is
' '
.comment (str, optional) – The comment character. The default is
'#'
.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).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
sherpa.utils.err.IdentifierErr – If there is no matching data set.
sherpa.utils.err.IOErr – If filename already exists and clobber is
False
.
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_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.
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')
Only write out the x, y, and staterror columns for data set ‘rprof’ to the file ‘prof.out’, over-writing it if it already exists:
>>> save_data('rprof', 'prof.out', clobber=True, ... fields=['x', 'y', 'staterror'])