get_resid_prof_prefs

Context: contrib

Synopsis

The plot preferences for radial or elliptical profiles of the residuals (data - model) to imaging data.

Syntax

get_resid_prof_prefs()

The get_resid_prof_prefs() command returns the preferences for the residuals in plots created by the prof_resid() and prof_fit_resid() commands. Changing the values will not change existing plots, only new plots created after the change was made. For example

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

will cause any new plots to use logarithmic scaling for the X axis. A list of all the preferences is given below.

Loading the routine

The routine can be loaded into Sherpa by saying:

from sherpa_contrib.profiles import *

Plot defaults

The following table lists the allowed keys and values for the object returned by get_resid_prof_prefs().

Key	Allowed values
xlog	False, True
ylog	False, True
xaxis	False, True
yerrorbars	False, True
errstyle	"line" or "capped"
errcolor	Any valid ChIPS color (e.g. "red")
errthickness	0.5 to 10
symbolstyle	chips_circle, chips_cross, chips_diamond, chips_none, chips_plus, chips_square, chips_point_type, chips_uptriangle, chips_downtriangle
symbolcolor	Any valid ChIPS color (e.g. "red")
symbolfill	False, True
symbolsize	1 to 100
linecolor	Any valid ChIPS color (e.g. "red")
linethickness	0.5 to 10
linestyle	chips_solid, chips_dot, chips_noline, chips_longdash, chips_shortdash, chips_dotlongdash, chips_dotshortdash, chips_shortdashlongdash

Example

sherpa> prof_resid()
sherpa> log_scale(X_AXIS)
...
sherpa> prefs = get_resid_prof_prefs()
sherpa> prefs["xlog"] = True
sherpa> prefs["axis"] = False
sherpa> prof_resid()

The preferences are set so that the x axis should be drawn using log scaling and no line is drawn at y=0. Setting the get_resid_prof_prefs values only affects plots made after the change; to change an existing plot you need to use ChIPS commands such as log_scale() and linear_scale().

Bugs

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