ChisqrPlot

class sherpa.plot.ChisqrPlot[source] [edit on github]

Bases: sherpa.plot.ModelPlot

Create plots of the chi-square value per point.

The value of ((data-model)/error)^2 is plotted for each point.

plot_prefs

The preferences for the plot.

Type:dict
x

The X value for each point.

Type:array_like
y

The Y value for each point: ((data-model)/error)^2

Type:array_like
xerr

The half-width of each X “bin”, if set.

Type:array_like
yerr

The error on the Y value. Will be None here.

Type:array_like
xlabel, ylabel, title

Plot labels.

Type:str

Attributes Summary

plot_prefs

Methods Summary

hline(y[, xmin, xmax, linecolor, linestyle, …]) Draw a line at constant y, extending over the plot.
overplot(*args, **kwargs) Add the data to an existing plot.
plot([overplot, clearwindow]) Plot the data.
prepare(data, model, stat) Create the data to plot
vline(x[, ymin, ymax, linecolor, linestyle, …]) Draw a line at constant x, extending over the plot.

Attributes Documentation

plot_prefs = {}

Methods Documentation

static hline(y, xmin=0, xmax=1, linecolor=None, linestyle=None, linewidth=None, overplot=False, clearwindow=True) [edit on github]

Draw a line at constant y, extending over the plot.

overplot(*args, **kwargs) [edit on github]

Add the data to an existing plot.

This is the same as calling the plot method with overplot set to True.

See also

plot()

plot(overplot=False, clearwindow=True, **kwargs)[source] [edit on github]

Plot the data.

This will plot the data sent to the prepare method.

Parameters:
  • overplot (bool, optional) – If True then add the data to an exsiting plot, otherwise create a new plot.
  • clearwindow (bool, optional) – Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?
  • **kwargs – These values are passed on to the plot backend, and must match the names of the keys of the object’s plot_prefs dictionary.

See also

prepare(), overplot()

prepare(data, model, stat)[source] [edit on github]

Create the data to plot

Parameters:
  • data – The Sherpa data object to display (it is assumed to be one dimensional). This defines the grid over which the model is displayed.
  • model – The Sherpa model expression to evaluate and display.
  • stat (optional) – This parameter is unused.

See also

plot()

static vline(x, ymin=0, ymax=1, linecolor=None, linestyle=None, linewidth=None, overplot=False, clearwindow=True) [edit on github]

Draw a line at constant x, extending over the plot.