Provides a number of S-Lang functions useful for Sherpa.
calc_kcorr()
groupByCounts()
groupBySNR()
groupAdaptively()
groupAdaptiveSNR()
get_source_components()
set_dataspace()
and the variables:
_sherpa_utils_version_string
_sherpa_utils_version
The sherpa_utils.sl package contains S-Lang routines that may be useful
to the Sherpa user. They can be loaded into Sherpa by saying, once
per session,
The "NOTES" section contains further information on installing this
package.
The available routines are:
| calc_kcorr() |
Calculates the k-correction for a given model, redshift, and
energy range. See "ahelp calc_kcorr" for more information.
|
| groupByCounts() |
Groups the dataset so that each group
contains at least the specified number of counts.
See "ahelp groupByCounts" for more information.
|
| groupBySNR() |
Groups the dataset so that each group
has at least the specified signal-to-noise value.
See "ahelp groupByCounts" for more information.
|
| groupAdaptively() |
Adaptively group the dataset so that each group
contains at least the specified number of counts.
See "ahelp groupByCounts" for more information.
|
| groupAdaptiveSNR() |
Adaptively groups the dataset so that each group
has at least the specified signal-to-noise value.
See "ahelp groupByCounts" for more information.
|
| get_source_components() |
Returns an array containing the names of the model compunents
used to define the source expression for a dataset. |
| set_datapace() |
Sets the X-axis grid used for a dataset (see Sherpa's
DATASPACE command) |
See the individual ahelp pages for each function for
more information on their use.
The available variables are:
| _sherpa_utils_version_string |
Contains the version of the script as a string in
the format "a.b".
|
| _sherpa_utils_version |
Contains the version of the script as an integer
equal to a*100 + b (when _sherpa_utils_version_string
is "a.b").
|
Version 1.26 of sherpa_utils.sl was released with CIAO 3.2.
The script can now be loaded by saying rather than having to use () = evalfile("sherpa_utils.sl"); The old method will still work.
Version 1.25 of sherpa_utils.sl was released with CIAO 3.1.
To take advantage of the set_groups() function
in Sherpa and the group module,
the following functions were added:
groupByCounts(), groupBySNR(),
groupAdaptively(), and groupAdaptiveSNR().
See "ahelp groupByCounts" for further details.
The documentation for the calc_kcorr(),
get_source_components(), and set_dataspace() routines
have been moved to separate ahelp files: try
'ahelp calc_kcorr', 'ahelp get_source_components',
and 'ahelp set_dataspace'.
Version 1.23 was released in January 2004 and
required CIAO 3.0.2.
The get_source_components() routine has been added to the
package. The set_dataspace() command now uses set_axes()
to set the axis grid.
This script is not an official part of the CIAO release but is
made available as "contributed" software via the
CIAO scripts page
which contains instructions on how to install the software.
The routines can be loaded into Sherpa by calling
If you want the routines available every time you use
Sherpa then you can add this line to your
Sherpa resource file (see section V of 'ahelp sherpa'
for the location of this file).
It is safe to call this multiple times since only the first
call loads the package; the remaining calls are ignored.
- chandra
-
guide
- sherpa
-
bye,
calc_kcorr,
dataspace,
dcounts,
dollarsign,
echo,
eflux,
eqwidth,
erase,
flux,
get,
get_dcounts_sum,
get_dir,
get_eflux,
get_eqwidth,
get_filename,
get_flux2d,
get_flux_str,
get_lfactorial,
get_mcounts_sum,
get_pflux,
get_source_components,
get_verbose,
groupbycounts,
guess,
is,
journal,
list,
list_par,
mcounts,
numbersign,
paramest,
plot_eprof,
plot_rprof,
prompt,
reset,
run,
set,
set_analysis,
set_axes,
set_coord,
set_dataspace,
set_dir,
set_verbose,
setplot,
sherpa-module,
sherpa_plotfns,
show,
simspec,
use,
version
|
![[CIAO Logo]](../imgs/ciao_logo_navbar.gif){kind=logo}