plot_fit

Context: plotting

Synopsis

Plot the fit results (data, model) for a data set.

Syntax

plot_fit(id=None, replot=False, overplot=False, clearwindow=True,
**kwargs)

Description

This function creates a plot containing the data and the model (including any instrument response) for a data set.

Examples

Example 1

Plot the fit results for the default data set:

>>> plot_fit()

Example 2

Overplot the 'core' results on those from the 'jet' data set, using a logarithmic scale for the X axis:

>>> set_xlog()
>>> plot_fit('jet')
>>> plot_fit('core', overplot=True)

Example 3

Keyword arguments can be given to override the plot preferences; for example the following sets the y axis to a log scale, but only for this plot:

>>> plot_fit(ylog=True)

Example 4

The color can be changed for both the data and model using (note that the keyword name and supported values depends on the plot backend; this example assumes that Matplotlib is being used):

>>> plot_fit(color='orange')

Example 5

Draw the fits for two datasets, setting the second one partially transparent (this assumes Matplotlib is used):

>>> plot_fit(1)
>>> plot_fit(2, alpha=0.7, overplot=True)

PARAMETERS

The parameters for this function are:

Parameter	Type information	Definition
id	int, str, or None, optional	The data set. If not given then the default identifier is used, as returned by `get_default_id` .
replot	bool, optional	Set to True to use the values calculated by the last call to `plot_fit` . The default is False .
overplot	bool, optional	If True then add the data to an existing plot, otherwise create a new plot. The default is False .
clearwindow	bool, optional	Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?

Notes

The additional arguments supported by `plot_fit` are the same as the keywords of the dictionary returned by `get_data_plot_prefs` .

Bugs

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