show_filter

sherpa.ui.show_filter(id=None, outfile=None, clobber=False)

Show any filters applied to a data set.

Display any filters that have been applied to the independent axis or axes of the data set.

Parameters:
  • id (int or str, optional) – The data set. If not given then all data sets are displayed.
  • outfile (str, optional) – If not given the results are displayed to the screen, otherwise it is taken to be the name of the file to write the results to.
  • clobber (bool, optional) – If outfile 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).
Raises:

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

See also

ignore()
Exclude data from the fit.
sherpa.astro.ui.ignore2d()
Exclude a spatial region from an image.
list_data_ids()
List the identifiers for the loaded data sets.
notice()
Include data in the fit.
sherpa.astro.ui.notice2d()
Include a spatial region of an image.
show_all()
Report the current state of the Sherpa session.

Notes

When outfile is None, the text is displayed via an external program to support paging of the information. The program used is determined by the PAGER environment variable. If PAGER is not found then ‘/usr/bin/more’ is used.