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 2008

URL: http://cxc.harvard.edu/sherpa4.1/get_proj.sl.html
AHELP for Sherpa 4.1

get_proj

Context: sl.sherpa

Synopsis

Return information regarding the projection method.

Syntax

get_proj();
get_proj_results();
get_proj_opt( [name] );

Description

get_proj

The get_proj command returns the current projection estimation method object.The function accepts no arguments. The returned information includes:

  • sigma - to get 1, 2, or 3-sigma limits
  • eps - precision of resulting limits
  • maxiters- maximum number of tries to bracket desired limits, before returning
  • remin - if during search, a new fit statistic is found that is smaller than original best fit, the difference between new and original statistics must be greater than this value

get_proj_results

The get_proj_results command accesses results from the last time projection was run. The function accepts no arguments. The results include the following attributes:

  • datasets - Data sets in fit
  • methodname - Estimation method name
  • fitname - Fitting method name
  • statname - Statistic name
  • sigma - Change in statistic
  • parnames - Model parameter names
  • parvals - Model parameter fit values
  • parmins - Model parameter minimum values
  • parmaxes - Model parameter maximum values
  • warnings - Warning messages

get_proj_opt

The get_proj_opt command returns a projection option by name. If the name isn't specified, it returns a dictionary of all options that govern how projection is run.

  • eps - precision of resulting limits, default=0.01
  • fast - the method is automatically switched to a faster option to reduce the time per fit, default=True
  • max_rstat - maximum possible value of the reduced statistic, default=3
  • maxfits - maximum number of tries to fit the parameter space, default=5
  • maxiters- maximum number of tries to bracket desired limits, before returning, default=200
  • remin - if during search, a new fit statistic is found that is smaller than original best fit, the difference between new and original statistics must be greater than this value, default=0.01
  • sigma - to get 1, 2, or 3-sigma limits, default=0.01
  • soft_limits - a switch which allows the search to go all the way out to the hard parameter limits; if switched on, the search will be restricted to occur within the soft limits, which can be changed by the user, default=False
  • tol - tolerance for the fit, default=0.20000000000000001

Example 1

sherpa> get_proj();

Return a variable listing of all settings that govern how the projection method calculates confidence limits. Sample output is

name        = projection
max_rstat   = 3
maxiters    = 200
soft_limits = False
eps         = 0.01
fast        = True
maxfits     = 5
remin       = 0.01
tol         = 0.2
sigma       = 1

Example 2

sherpa> get_proj_results();

Return a variable listing of all results from the last time projection was run.

Example 3

sherpa> get_proj_opt("sigma");
1

Return the value of the sigma option, which is "1" in this example.

Bugs

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

Last modified: December 2008



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.