get_arf_plot

Context: data

Synopsis

Return the data and preferences defining an ARF plot

Syntax

get_arf_plot( [id, resp_id] )

The get_arf_plot() command returns the data and preferences which define a plot of ARF (auxiliary response function) data in a Sherpa session. Once an ARF associated with a data set is loaded, this command can be used to list the x, y, x error, and y error data arrays used in the ARF plot created with plot_arf() or plot(), in addition to the values for the x label, y label, title, and other plotting preferences. The information returned by get_arf_plot() may be stored in a variable, or printed to the screen, as shown in the examples section.

id - the id of the dataset to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
resp_id - the id of the ARF to use, e.g. if more than one is associated with the data set; default is the first ARF loaded for the given data set ID (resp_id=1)

Attributes:

title - title of plot
xlabel - x axis label
ylabel - y axis label
units - units of grid
xlo - grid array, low bins
xhi - grid array, high bins
flux - unconvolved counts
y - convolved counts
plot_prefs - dictionary of plotting preferences

Example 1

sherpa> print(get_arf_plot())

When called with no arguments within the print() command, get_arf_plot() returns the data and preferences associated with the plot of the first ARF loaded for data set 1.

sherpa> print(get_arf_plot())
x      = [  0.305   0.315   0.325 ...,  10.975  10.985  10.995]
y      = [ 24.6003  59.3127  73.6197 ...,   0.6435   0.6227   0.6021]
yerr   = None
xerr   = [ 0.01  0.01  0.01 ...,  0.01  0.01  0.01]
xlabel = Energy (keV)
ylabel = cm^2
title  = source.arf
plot_prefs = {'symbolstyle': 0, 'linethickness': 3, 'linestyle': 1, 'linecolor': 'red'}

Example 2

sherpa> arf_plot=get_arf_plot(3, 2)

This command stores to the variable "arf_plot" the data and preferences defining the plot of the second ARF loaded for data set 3. The contents may be printed with 'print(arf_plot)'.

Example 3

sherpa> get_arf_plot().plot_prefs

This command lists the library of plotting preferences available for get_arf_plot(), and can be used to modify the plot settings:

sherpa> get_arf_plot().plot_prefs
            {'linecolor': 'red', 'linestyle': 1, 'linethickness': 3, 'symbolstyle': 0}

sherpa> get_arf_plot().plot_prefs["linestyle"]=3

sherpa> get_arf_plot().plot_prefs
            {'linecolor': 'red', 'linestyle': 3, 'linethickness': 3, 'symbolstyle': 0}

Bugs

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