About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Last modified: December 2006

URL: http://cxc.harvard.edu/ciao3.4/sherpa.multiplot.html
Hardcopy (PDF): A4 | Letter
AHELP for CIAO 3.4 sherpa.multiplot Context: sherpa

Synopsis

Configure appearance of Sherpa plots.

Syntax

sherpa.multiplot.[field]

Description

The Sherpa configuration variable (also called "state object") sherpa.multiplot controls appearance of plots created by CPLOT, LPLOT , OPLOT and SPLOT .

The following table lists each field of sherpa.multiplot, with a description and the default value:

Field Name Description Default
use_tex_strings Cause certain characters in labels (e.g., "_") NOT to be interpreted as TeX would (0 = false, 1 = true) 1
skip_tex_chars Characters which are NOT to be interpreted as TeX would %$_
gap Gap width when two, and only two, plots are created with LPLOT 0.1
clear Clear ChIPS window before plot command executed (0 = false, 1 = true) 1
newarea When plot command creates multiple plots, put each plot in a new drawing area (0 = false, 1 = true) 1
redraw Redraw after every ChIPS command (0 = false, 1 = true) 0
prefunc User S-Lang function executed before the data is plotted NULL
postfunc User S-Lang function executed after the data is plotted NULL
xfilter_lo Lower x bound applied to all plots (if NULL, lower bound taken from data) NULL
xfilter_hi Upper x bound applied to all plots (if NULL, upper bound taken from data) NULL

The fields sherpa.multiplot.prefunc and sherpa.multiplot.postfunc refer to optional user functions that can be applied to plots before and after the plot is created. Please see the ahelp file sherpa-plot-hooks for more information.

Example 1

Generate plot in a new drawing area.

sherpa> sherpa.multiplot.newarea=1
sherpa> LPLOT DATA
 

Example 2

The sherpa.multiplot settings can be changed at the command line. When assigning a string to a field, the string should be quoted as shown in the second command:

sherpa> sherpa.multiplot.gap = 0.2
sherpa> sherpa.multiplot.skip_tex_chars = "%$_"

Example 3

Create an alias smp to sherpa.multiplot and use it.

sherpa> variable smp = sherpa.multiplot
sherpa> smp.gap = 0.2
sherpa> smp.skip_tex_chars = "%$_"

Example 4

Use print to obtain the information about the current settings of sherpa.multiplot:

sherpa> print(sherpa.multiplot)
use_tex_strings  =  1
skip_tex_chars   =  %$_
gap              =  0.1
clear            =  1
newarea          =  1
redraw           =  0
prefunc          =  NULL
postfunc         =  NULL
xfilter_lo       =  NULL
xfilter_hi       =  NULL

Bugs

See the Sherpa bug pages online for an up-to-date listing of known bugs.

Hardcopy (PDF): A4 | Letter
Last modified: December 2006



The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory.
60 Garden Street, Cambridge, MA 02138 USA.    Email: cxcweb@head.cfa.harvard.edu
Smithsonian Institution, Copyright © 1998-2004. All rights reserved.