plot_arf¶
- sherpa.astro.ui.plot_arf(id=None, resp_id=None, replot=False, overplot=False, clearwindow=True, **kwargs)¶
Plot the ARF associated with a data set.
Display the effective area curve from the ARF component of a PHA data set.
- 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.replot (bool, optional) – Set to
True
to use the values calculated by the last call toplot_data
. 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.ArgumentErr – If the data set does not contain PHA data.
See also
get_arf_plot
Return the data used by plot_arf.
plot
Create one or more plot types.
Examples
Plot the ARF for the default data set:
>>> plot_arf()
Plot the ARF from data set 1 and overplot the ARF from data set 2:
>>> plot_arf(1) >>> plot_arf(2, overplot=True)
Plot the ARFs labelled “arf1” and “arf2” for the “src” data set:
>>> plot_arf("src", "arf1") >>> plot_arf("src", "arf2", overplot=True)
The following example requires that the Matplotlib backend is selected, since this determines what extra keywords
plot_arf
accepts. The ARFs from the default and data set 2 are drawn together, but the second curve is drawn with a dashed line.>>> plot_arf(ylog=True) >>> plot_arf(2, overplot=True, linestyle='dashed')