Changing the look of Sherpa plots using setplot.sl

Getting Started

unix% grep Id $ASCDS_CONTRIB/share/slsh/local-packages/setplot.sl
% $Id: setplot.sl,v 1.3 2004/11/02 16:19:23 dburke Exp $

sherpa> () = evalfile("setplot.sl");

() = evalfile("setplot.sl");

sherpa> data source_grouped_pi.fits
The inferred file type is PHA.  If this is not what you want, please
specify the type explicitly in the data command.
WARNING: statistical errors specified in the PHA file.
         These are currently IGNORED.  To use them, type:
         READ ERRORS "<filename>[cols CHANNEL,STAT_ERR]" fitsbin
RMF is being input from:
  /data/ciao/rmf.fits
ARF is being input from:
  /data/ciao/arf.fits
sherpa> ignore energy :0.5,8:
sherpa> source = xswabs[abs] * powlaw1d[p1]
abs.nH parameter value [0.1]
p1.gamma parameter value [1]
p1.ref parameter value [4]
p1.ampl parameter value [0.000149261]
sherpa> fit
 LVMQT: V2.0
 LVMQT: initial statistic value = 4583.05
 LVMQT: final statistic value = 83.2873 at iteration 8
           abs.nH  2.4061  10^22/cm^2  
            p1.gamma  1.51851     
            p1.ampl  0.000241434     

Background Information

Plots are created in Sherpa by the LPLOT command.

Many aspects of the appearance of the plots can be changed by setting values in the Sherpa configuration variables (state objects). This is discussed in the Configuration of Sherpa with Sherpa State Objects section of ahelp sherpa, and the variables relevant to plotting are: sherpa.plot, sherpa.dataplot, sherpa.fitplot, sherpa.resplot, and sherpa.multiplot.

By changing the values of the fields in these variables you change how new plots of the given type will be drawn. There are also several utility routines - such as set_log, set_lin, set_erron, and set_erroff to change some of the common options.

This approach provides great power and flexibility, but may not be easy to remember for many users. In this thread we describe how you can use the setplot() function from the setplot.sl script to easily set the options for the different plot types. The function prompts you for all parameters relevant to the requested plot and sets the appropriate fields in the Sherpa plot variables. The rest of the thread describes how to use this function.

Changing "DATA" plots

The default settings for "DATA" plots produces this plot  for the dataset used in this example. The look of the plot is controlled by the fields of the sherpa.dataplot plotting variable. These can be viewed using the print() command:

sherpa> print(sherpa.dataplot)
x_errorbars      =  0
y_errorbars      =  1
errs_style       =  bar
errs_type        =  both
x_log            =  0
y_log            =  0
curvestyle       =  noline
curvecolor       =  default
symbolstyle      =  square
symbolcolor      =  default
symbolsize       =  2
xlabel_size      =  1.5
ylabel_size      =  1.5
zlabel_size      =  1.5
title_size       =  1.5
tickvals_size    =  1.5
prefunc          =  NULL
postfunc         =  NULL

We decide we want the y axis to be drawn in a logarithmic scale and the symbols to be drawn in magenta whilst keeping the remaining options unchanged. Although we could change the fields manually, we use the setplot() command to prompt us for the settings:

sherpa> setplot("data")
Should the X-axis have logarithmic spacing? (no):
Should the Y-axis have logarithmic spacing? (no): yes
Draw error bars along the X-axis? (no): 
Draw error bars along the Y-axis? (yes): 
Style of error bars? (bar|standard) (bar): 
Type of error bars? (both|none|up|down|dn) (both): 
Line style to connect points (step|histo|noline|simpleline) (noline): 
Symbol used to mark points (none|bigpoint|...|uptri) (square):
Color of symbols (default|...|yellow) (default): magenta
Size of symbols (0:) (2):
Size of labels along X axis (0:) (1.5):
Size of labels along Y axis (0:) (1.5):
Size of title (0:) (1.5):
Size of numbers along axes (0:) (1.5):

The parameters for data (and related) plots has been set.
Try 'lplot data'

sherpa> lplot data

The new version of the plot looks like this . To avoid the screen text being too wide the list of options for the symbol style has been cut down to just "none|bigpoint|...|uptri" and the color range to just "default|...|yellow".

The bold entries in the following indicate the changed fields in the sherpa.dataplot variable:

sherpa> print(sherpa.dataplot)
x_errorbars      =  0
y_errorbars      =  1
errs_style       =  bar
errs_type        =  both
x_log            =  0
y_log            =  1
curvestyle       =  noline
curvecolor       =  default
symbolstyle      =  square
symbolcolor      =  magenta
symbolsize       =  2
xlabel_size      =  1.5
ylabel_size      =  1.5
zlabel_size      =  1.5
title_size       =  1.5
tickvals_size    =  1.5
prefunc          =  NULL
postfunc         =  NULL

We now decide that we want to make further changes to the plot and re-run the setplot() command:

sherpa> setplot("data")
Should the X-axis have logarithmic spacing? (no): yes
Should the Y-axis have logarithmic spacing? (yes):
Draw error bars along the X-axis? (no):
Draw error bars along the Y-axis? (yes): 
Style of error bars? (bar|standard) (bar): 
Type of error bars? (both|none|up|down|dn) (both): 
Line style to connect points (step|histo|noline|simpleline) (noline): step
Color to draw line connecting points (default|...|yellow) (default): cyan
Symbol used to mark points (none|bigpoint|...|uptri) (square): none
Size of labels along X axis (0:) (1.5):
Size of labels along Y axis (0:) (1.5):
Size of title (0:) (1.5): 2
Size of numbers along axes (0:) (1.5):

The parameters for data (and related) plots has been set.
Try 'lplot data'

sherpa> lplot 2 data arf

Note that the default values for the prompts have changed to reflect the current settings, and that the variables being prompted for have changed to reflect the settings: there are no questions about the symbol color or size since the symbol style was set to none, but the curve color was asked for since it is now being drawn.

The resulting plot looks like this . The top plot has been changed to match the settings asked for in the setplot() call. The bottom plot - of the ARF - does not use any of these settings, because the ARF plot is controlled by the sherpa.plot plot variable.

Although the plot title was changed to a size of 2, from its default value of 1.5, the new plot does not have a title. This is because we draw two plots here and Sherpa only sets the title when an individual plot - i.e. "lplot data" - is created.

Changing the "ARF" plot to match

In the previous section we changed Sherpa so that all "DATA" plots have a garish color scheme. However, other plots - such as of the ARF - do not share this scheme. We can use the setplot() call to change this:

sherpa> setplot("arf")
Should the X-axis have logarithmic spacing? (no): yes
Should the Y-axis have logarithmic spacing? (no): yes
Draw error bars along the X-axis? (no):
Draw error bars along the Y-axis? (no):
Line style to connect points (step|histo|noline|simpleline) (step):
Color to draw line connecting points (default|...|yellow) (default): cyan
Symbol used to mark points (none|...|uptri) (none):
Size of labels along X axis (0:) (1.5):
Size of labels along Y axis (0:) (1.5):
Size of title (0:) (1.5): 2
Size of numbers along axes (0:) (1.5):

The parameters for arf (and related) plots has been set.
Try 'lplot arf'

sherpa> lplot 2 data arf

which produces this plot .

Since the sherpa.plot plot object controls the look of many plots, not just those of the ARF, the following changes will also be seen in these other plots. For instance:

sherpa> lp model

The resulting plot  matches the style of the ARF plot. Since there is only one plot here we can see that the title has indeed been increased.

Changing the "FIT" plots

Although there are several different plot variables:

• sherpa.plot for general plots, such as the ARF and model components
• sherpa.dataplot for plotting the source and background data
• sherpa.resplot for plotting "residual" style plots
• and sherpa.fitplot for plotting fits

they are all essentially identical - except for fits. This is because the sherpa.fitplot object contains extra variables to control how the fitted model is displayed.

Here we change the fit-style plots; although most of the prompts are the same as seen with previous plots, there are extra ones (beginning with "Fit:"):

sherpa> setplot("fit")
Should the X-axis have logarithmic spacing? (no): yes
Should the Y-axis have logarithmic spacing? (no): yes
Draw error bars along the X-axis? (no):
Draw error bars along the Y-axis? (yes):
Style of error bars? (bar|standard) (bar):
Type of error bars? (both|none|up|down|dn) (both):
Line style to connect points (step|histo|noline|simpleline) (noline):
Symbol used to mark points (none|...|uptri) (square): bigpoint
Color of symbols (default|...|yellow) (default): blue
Size of symbols (0:) (2): 1
Fit: line style to connect points (step|histo|noline|simpleline) (step):
Fit: color to draw line connecting points (default|...|yellow) (red): green
Fit: symbol used to mark points (none|...|uptri) (none):
Size of labels along X axis (0:) (1.5):
Size of labels along Y axis (0:) (1.5):
Size of title (0:) (1.5):
Size of numbers along axes (0:) (1.5): 2

The parameters for fit (and related) plots has been set.
Try 'lplot fit'

sherpa> lp fit

The resulting plot looks like this .

Saving your changes

The save_state() command can be used to save your settings so that they can be used in other Sherpa sessions.

If called with no arguments, save_state() will write out the contents of the Sherpa configuration variables to the file $HOME/.sherpa-state-rc. This file will be over-written without warning (so you should not make any manual changes to it). When Sherpa starts, it will automatically load in the settings from this file, so your plots will retain the look you have set for them.

If called with an argument, save_state() will write out the settings to the file name (its argument) instead of $HOME/.sherpa-state-rc. This file can then be read into a Sherpa session using the USE command; this is useful if you want to set up different plot styles for use in different situations.

The beginning of the file will look something like:

% Sherpa state for ciaouser, Wed Jul 30 17:45:13 2006

sherpa.plot.x_errorbars = 0
sherpa.plot.y_errorbars = 0
sherpa.plot.errs_style = "bar"
sherpa.plot.errs_type = "both"
sherpa.plot.x_log = 1
sherpa.plot.y_log = 1
sherpa.plot.curvestyle = "step"
sherpa.plot.curvecolor = "cyan"
sherpa.plot.symbolstyle = "none"
sherpa.plot.symbolcolor = "default"
sherpa.plot.symbolsize = 2
sherpa.plot.xlabel_size = 1.5
sherpa.plot.ylabel_size = 1.5
sherpa.plot.zlabel_size = 1.5
sherpa.plot.title_size = 2
sherpa.plot.tickvals_size = 1.5
sherpa.plot.prefunc = NULL
sherpa.plot.postfunc = NULL

...

(the values will depend on your responses to any setplot() calls you have made).

Notes & Caveats