get_arf_plot

sherpa.astro.ui.get_arf_plot(id=None, resp_id=None, recalc=True)

Return the data used by plot_arf.

Parameters:
  • id (int or str, optional) – The data set with an ARF. If not given then the default identifier is used, as returned by get_default_id.

  • resp_id (int or str, optional) – Which ARF to use in the case that multiple ARFs are associated with a data set. The default is None, which means the first one.

  • recalc (bool, optional) – If False then the results from the last call to plot_arf (or get_arf_plot) are returned, otherwise the data is re-generated.

Returns:

arf_plot

Return type:

a sherpa.astro.plot.ARFPlot instance

Raises:

sherpa.utils.err.ArgumentErr – If the data set does not contain PHA data.

See also

plot

Create one or more plot types.

plot_arf

Plot the ARF associated with a data set.

Examples

Return the ARF plot data for the default data set:

>>> aplot = get_arf_plot()
>>> aplot.y.max()
676.95794677734375

Return the ARF data for the second response of the data set labelled ‘histate’, and then plot it:

>>> aplot = get_arf_plot('histate', 2)
>>> aplot.plot()