Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/get_resid_plot.html
Jump to: · Examples · PARAMETERS · Bugs · See Also


AHELP for CIAO 4.13 Sherpa v1

get_resid_plot

Context: plotting

Synopsis

Return the data used by plot_resid.

Syntax

get_resid_plot(id=None, recalc=True)

id - int or str, optional
recalc - bool, optional

Examples

Example 1

Return the residual data for the default data set:

>>> rplot = get_resid_plot()
>>> np.min(rplot.y)
-2.9102595936209896
>>> np.max(rplot.y)
4.0897404063790104

Example 2

Display the contents of the residuals plot for data set 2:

>>> print(get_resid_plot(2))

Example 3

Overplot the residuals plot from the 'core' data set on the 'jet' data set:

>>> r1 = get_resid_plot('jet')
>>> r2 = get_resid_plot('core')
>>> r1.plot()
>>> r2.overplot()

PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set. If not given then the default identifier is used, as returned by `get_default_id` .
recalc If False then the results from the last call to `plot_resid` (or `get_resid_plot` ) are returned, otherwise the data is re-generated.

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

plotting
get_ratio_plot, plot_resid
statistics
get_chisqr_plot, get_delchi_plot