Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/plot_arf.html
AHELP for CIAO 4.13 Sherpa v1

plot_arf

Context: plotting

Synopsis

Plot the ARF associated with a data set.

Syntax

plot_arf(id=None, resp_id=None, replot=False, overplot=False,
clearwindow=True, **kwargs)

id - int or str, optional
resp_id - int or str, optional
replot - bool, optional
overplot - bool, optional
clearwindow - bool, optional

Description

Display the effective area curve from the ARF component of a PHA data set.


Examples

Example 1

Plot the ARF for the default data set:

>>> plot_arf()

Example 2

Plot the ARF from data set 1 and overplot the ARF from data set 2:

>>> plot_arf(1)
>>> plot_arf(2, overplot=True)

Example 3

Plot the ARFs labelled "arf1" and "arf2" for the "src" data set:

>>> plot_arf("src", "arf1")
>>> plot_arf("src", "arf2", overplot=True)

Example 4

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')

PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set with an ARF. If not given then the default identifier is used, as returned by `get_default_id` .
resp_id 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 Set to True to use the values calculated by the last call to `plot_data` . The default is False .
overplot If True then add the data to an existing plot, otherwise create a new plot. The default is False .
clearwindow Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

contrib
get_data_prof, get_data_prof_prefs, get_delchi_prof, get_delchi_prof_prefs, get_fit_prof, get_model_prof, get_model_prof_prefs, get_resid_prof, get_resid_prof_prefs, get_source_prof, get_source_prof_prefs, plot_chart_spectrum, plot_marx_spectrum, prof_data, prof_delchi, prof_fit, prof_fit_delchi, prof_fit_resid, prof_model, prof_resid, prof_source
data
get_arf, get_arf_plot, get_bkg, get_bkg_arf, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_rmf, get_bkg_source, get_bkg_source_plot, load_arf, load_bkg_arf, load_multi_arfs, set_arf, unpack_arf
info
list_response_ids
modeling
get_response, normal_sample, t_sample, uniform_sample
plotting
get_cdf_plot, get_energy_flux_hist, get_pdf_plot, get_photon_flux_hist, get_pvalue_plot, get_pvalue_results, get_split_plot, plot, plot_bkg, plot_bkg_chisqr, plot_bkg_delchi, plot_bkg_fit, plot_bkg_fit_delchi, plot_bkg_fit_resid, plot_bkg_model, plot_bkg_ratio, plot_bkg_resid, plot_bkg_source, plot_cdf, plot_chisqr, plot_data, plot_delchi, plot_energy_flux, plot_fit, plot_fit_delchi, plot_fit_resid, plot_model, plot_model_component, plot_order, plot_pdf, plot_photon_flux, plot_pvalue, plot_ratio, plot_resid, plot_scatter, plot_source, plot_source_component, plot_trace, set_xlinear, set_xlog, set_ylinear, set_ylog
psfs
plot_kernel
statistics
get_chisqr_plot, get_delchi_plot
visualization
contour_resid