plot_fit_delchi
- sherpa.astro.ui.plot_fit_delchi(id: IdType | None = None, replot=False, overplot=False, clearwindow=True, **kwargs) None
Plot the fit results, and the residuals, for a data set.
This creates two plots - the first from
plot_fit
and the second fromplot_delchi
- for a data set.Changed in version 4.12.2: The
overplot
option now works.Changed in version 4.12.0: The Y axis of the delchi plot is now always drawn using a linear scale.
- Parameters:
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 toplot_fit_delchi
. The default isFalse
.overplot (bool, optional) – If
True
then add the data to an existing plot, otherwise create a new plot. The default isFalse
.clearwindow (bool, optional) – Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?
- Raises:
sherpa.utils.err.IdentifierErr – If the data set does not exist or a source expression has not been set.
See also
get_fit_plot
Return the data used to create the fit plot.
get_default_id
Return the default data set identifier.
plot
Create one or more plot types.
plot_fit
Plot the fit results for a data set.
plot_fit_ratio
Plot the fit results, and the ratio of data to model, for a data set.
plot_fit_resid
Plot the fit results, and the residuals, for a data set.
plot_data
Plot the data values.
plot_delchi
Plot the ratio of residuals to error for a data set.
plot_model
Plot the model for a data set.
set_xlinear
New plots will display a linear X axis.
set_xlog
New plots will display a logarithmically-scaled X axis.
set_ylinear
New plots will display a linear Y axis.
set_ylog
New plots will display a logarithmically-scaled Y axis.
Notes
The additional arguments supported by
plot_fit_delchi
are the same as the keywords of the dictionary returned byget_data_plot_prefs
, and are applied to both plots.For the delchi plot, the ylog setting is ignored, and the Y axis is drawn using a linear scale.
Examples
Plot the results for the default data set:
>>> plot_fit_delchi()
Overplot the ‘core’ results on those from the ‘jet’ data set, using a logarithmic scale for the X axis:
>>> set_xlog() >>> plot_fit_delchi('jet') >>> plot_fit_delchi('core', overplot=True)
Additional arguments can be given that are passed to the plot backend: the supported arguments match the keywords of the dictionary returned by
get_data_plot_prefs
. The following sets the error bars to be drawn in gray when using the Matplotlib backend:>>> plot_fit_delchi(ecolor='gray')