prof_resid

Context: contrib

Synopsis

Plot a radial or elliptical profile of the residuals (data - model) to imaging data.

Syntax

prof_resid( [id], [model=None, rstep=None, rmin=None, rmax=None,
rlo=None, rhi=None, xpos=None, ypos=None, ellip=None, theta=None,
group_counts=None, group_snr=None, label=True, recalc=True,
overplot=False, clearwindow=True] )

Description

The prof_resid command calculates the radial - or elliptical - profile of the residuals to imaging data (data - model) and plots it. The profile is defined by the existing model compenents, although it is possible to over-ride these values.

The residual values are calculated as

data - model

The prof_delchi() command can be used if you want to plot

(data - model) / error

Loading the routine

The routine can be loaded into Sherpa by saying:

from sherpa_contrib.profiles import *

Argument options

The argument options are the same as for the prof_data() command, and are described in its ahelp page.

Changing the plot defaults

The get_resid_prof_prefs() returns the current plot preferences used by prof_resid(). Changing these settings will therefore change the appearance of any new plots created by prof_resid(). For example

sherpa> get_resid_prof_prefs()["xlog"] = True

will cause any new residual plots to use logarithmic scaling for the X axis. A full list of the preferences can be found by saying

unix% ahelp get_resid_prof_prefs

Examples

Example 1

sherpa> prof_resid()
...
sherpa> prefs = get_resid_prof_prefs()
sherpa> prefs["xlog"] = True
sherpa> prof_resid()

The preferences are set so that the x axis should be drawn using log scaling. Setting the get_resid_prof_prefs values only affects new plots made after the setting was changed.

Example 2

sherpa> prof_resid(group_snr=15)

The residuals are plotted after the bins have been grouped so that each bin has a signal to noise ratio of 15 or more, where the calculation is done using the data and not the residual values.

Example 3

sherpa> prof_resid(rlo=[0,10,20,40,60,100,200])

Calculate the residual profile in radial bins with low/high limits of 0-10, 10-20, 20-40, 40-60, 60-100, 100-200.

Bugs

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