get_error

sherpa.astro.ui.get_error(id=None, filter=False, bkg_id=None)

Return the errors on the dependent axis of a data set.

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.
  • filter (bool, optional) – Should the filter attached to the data set be applied to the return value or not. The default is False.
  • bkg_id (int or str, optional) – Set if the values returned should be from the given background component, instead of the source data set.
Returns:

axis – The error for each data point, formed by adding the statistical and systematic errors in quadrature.
Return type:

array
Raises:

sherpa.utils.err.IdentifierErr – If the data set does not exist.

See also

get_dep()
Return the dependent axis of a data set.
get_staterror()
Return the statistical errors on the dependent axis of a data set.
get_syserror()
Return the systematic errors on the dependent axis of a data set.
list_data_ids()
List the identifiers for the loaded data sets.