get_reg_unc

Synopsis

Return the region-uncertainty object.

Syntax

get_reg_unc(par0=None, par1=None, id=None, otherids=None, recalc=False,
min=None, max=None, nloop=(10, 10), delv=None, fac=4, log=(False,
False), sigma=(1, 2, 3), levels=None, numcores=None)

Description

This returns (and optionally calculates) the data used to display the `reg_unc` contour plot. Note that if the the `recalc` parameter is `False` (the default value) then all other parameters are ignored and the results of the last `reg_unc` call are returned.

Examples

Example 1

Return the results for the `reg_unc` run for the `xpos` and `ypos` parameters of the `src` component, for the default data set:

>>> reg_unc(src.xpos, src.ypos)
>>> runc = get_reg_unc()

Example 2

Since the `recalc` parameter has not been changed to `True` , the following will return the results for the last call to `reg_unc` , which may not have been for the r0 and alpha parameters:

>>> runc = get_reg_unc(src.r0, src.alpha)

Example 3

Create the data without creating a plot:

>>> runc = get_reg_unc(pl.gamma, gal.nh, recalc=True)

Example 4

Specify the range and step size for both the parameters, in this case pl.gamma should vary between 0.5 and 2.5, with gal.nh between 0.01 and 1, both with 51 values and the nH range done over a log scale:

>>> runc = get_reg_unc(pl.gamma, gal.nh, id="src",
...                    min=(0.5, 0.01), max=(2.5, 1),
...                    nloop=(51, 51), log=(False, True),
...                    recalc=True)

PARAMETERS

The parameters for this function are:

Parameter	Type information	Definition
par0		The parameters to plot on the X and Y axes, respectively. These arguments are only used if `recalc` is set to `True` .
par1		The parameters to plot on the X and Y axes, respectively. These arguments are only used if `recalc` is set to `True` .
id	str, int, or None, optional	The data set that provides the data. If not given then all data sets with an associated model are used simultaneously.
otherids	list of str or int, or None, optional	Other data sets to use in the calculation.
recalc	bool, optional	The default value ( False ) means that the results from the last call to `reg_unc` (or `get_reg_unc` ) are returned, ignoring all other parameter values. Otherwise, the statistic curve is re-calculated, but not plotted.
fast	bool, optional	If True then the fit optimization used may be changed from the current setting (only for the error analysis) to use a faster optimization method. The default is False .
min	pair of numbers, optional	The minimum parameter value for the calculation. The default value of none means that the limit is calculated from the covariance, using the `fac` value.
max	pair of number, optional	The maximum parameter value for the calculation. The default value of none means that the limit is calculated from the covariance, using the `fac` value.
nloop	pair of int, optional	The number of steps to use. This is used when `delv` is set to none .
delv	pair of number, optional	The step size for the parameter. Setting this overrides the `nloop` parameter. The default is none .
fac	number, optional	When `min` or `max` is not given, multiply the covariance of the parameter by this value to calculate the limit (which is then added or subtracted to the parameter value, as required).
log	pair of bool, optional	Should the step size be logarithmically spaced? The default ( False ) is to use a linear grid.
sigma	sequence of number, optional	The levels at which to draw the contours. The units are the change in significance relative to the starting value, in units of sigma.
levels	sequence of number, optional	The numeric values at which to draw the contours. This overrides the `sigma` parameter, if set (the default is none ).
numcores	optional	The number of CPU cores to use. The default is to use all the cores on the machine.

Return value

The return value from this function is:

rproj -- The fields of this object can be used to re-create the plot created by `reg_unc` .

Changes in CIAO

Changed in CIAO 4.17

The log parameter can now be set to `True` for one or both parameters.

Bugs

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