IntervalUncertainty

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

Bases: Confidence1D

Attributes Summary

plot_prefs

Methods Summary

calc(fit, par[, methoddict, cache])

Evaluate the statistic for the parameter range.

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([min, max, nloop, delv, fac, log, ...])

Set 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

calc(fit, par, methoddict=None, cache=True)[source] [edit on github]

Evaluate the statistic for the parameter range.

This requires prepare to have been called, and must be called before plot is called.

Parameters:
  • fit – The Sherpa fit instance to use (defines the statistic and optimiser to use).

  • par – The parameter to iterate over.

See also

plot, prepare

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) [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 existing 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(min=None, max=None, nloop=20, delv=None, fac=1, log=False, numcores=None) [edit on github]

Set the data to plot.

This defines the range over which the statistic will be calculated, but does not perform the evaluation.

See also

calc

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.