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

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


AHELP for CIAO 4.9 Sherpa v1

int_unc

Context: confidence

Synopsis

Create a confidence plot of fit statistic vs. parameter value.

Syntax

int_unc(par,
[id,otherids=None,replot=False,min=None,max=None,nloop=20,delv=None,fac=
1,log=False,overplot=False,numcores])

Description

The int_unc command creates a confidence plot of fit statistic as a function of parameter value, with dashed lines indicating the best fit statistic and best fit parameter value. The parameter value is varied on the computed grid until the fit statistic is increased by delta_S, which is a function of sigma (e.g., delta_S = 1 if the statistic is chi-square and fac = 1). The best-fit statistic is determined at each grid point.

int-unc differs from int_proj ("ahelp int_proj") in that all other thawed parameters are fixed to their best-fit values, instead of being allowed to float to new best-fit values. This makes the plot created by int_unc a less accurate rendering of the projected shape of statistical hypersurface, but faster to create.

The computationally intensive projection function is parallelized to make use of multi-core systems (i.e., laptops or desktops with 2 or 4 cores) to provide significant improvements in efficiency compared to previous releases of Sherpa; the 'numcores' argument may be used to specify how the cores should be used when projection is run.

  • par - source model parameter
  • id, otherids - the id(s) of the dataset(s) to use; by default, uses all datasets; otherids=None
  • replot - should the cached arrays be used in the plot? False (default)=do the calculation, True=redisplay the existing values
  • min - minimum grid boundary; default=None, which calculates the value from the covariance. This is always a linear quantity, regardless of the log setting.
  • max - maximum grid boundary; default=None, which calculates the value from the covariance. This is always a linear quantity, regardless of the log setting.
  • nloop - bin size for calculating the step size (delv); default=20
  • delv - step size; default=None, which calculates the value using the min, max, and nloop values
  • fac - the number of sigma (i.e., the change in statistic) for the plot; default=1
  • log - use log space for the grid interval? default=False
  • overplot - should the new plot be overlaid in the plotting window? False (default)=clear the window, True=overplot on any existing plots
  • numcores - number of cores to use in parallelization; default is to use all cores available (2 or 4)

The calculated values, such as the grid min and max, can be retrieved with get_int_unc ("ahelp get_int_unc").

The plot is displayed in a ChIPS plotting window. If there is no plotting window open, one is created. If a plotting window exists, the overplot parameter value determines whether the new plot is overlaid on any existing plots in the window or if the window is cleared before the plot is drawn.

ChIPS commands may be used within Sherpa to modify plot characteristics and create hardcopies; refer to the ChIPS website for information.

Example 1

sherpa> int_unc(p1.gamma, id=1)

Run int_unc on the parameter p1.gamma from dataset 1.

Example 2

sherpa> int_unc(const.c0, id="bkg")

Run int_unc for the parameter const.c0 in the dataset "bkg".

Example 3

sherpa> int_unc(p1.gamma, 1, [2,3])

int_unc is run for parameter p1.gamma for datasets 1, 2, and 3.

Example 4

sherpa> int_unc(p1.gamma, min=2.0, max=2.5)

Manually set the grid limits to 2.0 (lower bound) and 2.5 (upper bound) before running int_unc for p1.gamma.

Example 5

sherpa> int_unc(src1.c2, log=True)

Use a log grid when running int_unc on the parameter src1.c2.

Example 6

sherpa> int_unc(p1.gamma, overplot=True)

Run int_unc on p1.gamma, overlaying the results on any existing plot.

Bugs

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

See Also

confidence
conf, covariance, get_conf, get_covar, get_int_proj, get_int_unc, get_proj, get_reg_proj, get_reg_unc, int_proj, projection, reg_proj, reg_unc, set_conf_opt, set_covar_opt, set_proj_opt

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:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.