plot_arf

Context: plotting

Synopsis

Plot the ARF associated with a data set.

Syntax

plot_arf(id: int | str | Sequence[int | str] | None = None, resp_id:
int | str | None = None, replot: bool = False, overplot: bool = False,
clearwindow: bool = True, **kwargs)

No return value.

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	Type information	Definition
id	int, str, sequence of int or str, or None, 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, str, or None, 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 to `plot_data` . The default is False .
overplot	bool, optional	If True then add the data to an existing plot, otherwise create a new plot. The default is False .
clearwindow	bool, optional	Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?

Changes in CIAO

Changed in CIAO 4.18

Multiple data sets can be displayed by using a list of identifiers. Per-plot options can now be given by using a list of values.

Bugs

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