load_syserror

sherpa.ui.load_syserror(id, filename=None, ncols=2, *args, **kwargs) None

Load the systematic errors from an ASCII file.

Read in a column or image from a file and use the values as the systematic errors for a data set.

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 ASCII file to read in.

ncolsint, optional

The number of columns to read in (the first ncols columns in the file).

colkeysarray of str, optional

An array of the column name to read in. The default is None.

sepstr, optional

The separator character. The default is ' '.

commentstr, optional

The comment character. The default is '#'.

See also

get_syserror

Return the systematic error on the dependent axis of a data set.

load_staterror

Load the statistical errors from a file.

set_syserror

Set the systematic errors on the dependent axis of a data set.

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.

See unpack_data for a description of the supported file format.

Examples

Read in the first column from ‘tbl.dat’:

>>> load_syserror('tbl.dat')

Use the column labelled ‘col3’

>>> load_syserror('tbl.dat', colkeys=['col3'])

Read in the first column from the file ‘errors.dat’ as the systematic errors for the ‘core’ data set:

>>> load_syserror('core', 'errors.dat')