ARFPlot

class sherpa.astro.plot.ARFPlot[source] [edit on github]

Bases: sherpa.plot.HistogramPlot

Create plots of the ancillary response file (ARF).

histo_prefs

The preferences for the plot.

Type:dict
xlo, xhi

The lower and upper edges of each bin.

Type:array_like
y

The effective area (ARF) value for the bin.

Type:array_like
xlabel, ylabel, title

Plot labels.

Type:str

Attributes Summary

histo_prefs

Methods Summary

overplot(*args, **kwargs)
plot([overplot, clearwindow]) Plot the data.
prepare(arf[, data]) Fill the fields given the ARF.

Attributes Documentation

histo_prefs = {}

Methods Documentation

overplot(*args, **kwargs) [edit on github]
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 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(arf, data=None)[source] [edit on github]

Fill the fields given the ARF.

Parameters:
  • arf – The ARF to plot
  • data (DataPHA instance, optional) – The units attribute of this object is used to determine whether the X axis should be in Angstrom instead of KeV (the default).