save_filter

sherpa.ui.save_filter(id, filename=None, clobber=False, sep=' ', comment='#', linebreak='\n', format='%g') → None

Save the filter array 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.

• 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).

• sep (str, optional) – The separator character. The default is ' '.

• comment (str, optional) – The comment character. The default is '#'.

• 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.DataErr – If the data set has not been filtered.

• sherpa.utils.err.IOErr – If filename already exists and clobber is False.

See also

load_filter

Load the filter array from a file and add to a data set.

save_data

Save the data 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.

The output file contains the columns X and FILTER.

Examples

Write the filter from the default data set as an ASCII file:

>>> save_filter('filt.dat')