Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2013

URL: http://cxc.harvard.edu/sherpa/ahelp/paramprompt.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.6 Sherpa v1

paramprompt

Context: modeling

Synopsis

Toggle parameter prompting for initial model values

Syntax

paramprompt(val=False)

Description

The paramprompt command controls whether Sherpa prompts the user for initial parameter values when a model component is created.

  • val - a boolean value which indicates whether parameter prompting is off (the default, val=False) or on (val=True).

If parameter prompting is turned on, the user is queried for the initial value of each model component parameter when it is established. At the model component prompt, either specify the initial value for the component or just hit <Return> to accept the default value.

In addition to the initial value, the minimum and maximum parameter limits may be set at the prompt. They must be comma-separated and specified in the order "value, min, max".

Example 1

sherpa> paramprompt(True)
sherpa> set_source(gauss1d.g1)

Parameter prompting is turned on, then a gauss1d model is created and named "g1". The screen output is:

g1.fwhm parameter value [10] 20
g1.pos parameter value [0] 0.05
g1.ampl parameter value [1]

Initial parameter values are set for the fwhm and pos parameters, while the default of the ampl parameter is accepted by hitting <Return>.

Example 2

sherpa> paramprompt(True)
sherpa> set_source(gauss2d.src)

Parameter prompting is turned on, then a gauss2d model is created and named "src". The screen output is:

src.fwhm parameter value [20] 20, 0.1, 300
src.xpos parameter value [0] 4024
src.ypos parameter value [0] 4250
src.ellip parameter value [0]
src.theta parameter value [0]
src.ampl parameter value [1] 20, 0.1, 1000

The initial value, minimum, and maximum are set for the fwhm and ampl parameters. An initial value only is set for the xpos and ypos parameters; the ellip and theta values are left unchanged by hitting <Return>.

Bugs

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

See Also

modeling
freeze, guess, link, set_par, thaw, unlink

Last modified: December 2013
Smithsonian Institute Smithsonian Institute

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-2014. All rights reserved.