Module functions for computing the sum of convolved model counts in source and background datasets.
Struct_Type get_mcounts_sum(Struct_Type)
Struct_Type get_bmcounts_sum(Struct_Type)
Struct_Type get_mcounts_sum([Integer_Type[,{Float_Type |
Array_Type}[,String_Type]]])
Struct_Type get_bmcounts_sum([Integer_Type[,{Float_Type |
Array_Type}[,String_Type]]])
Error Return Values: NULL
Arguments:
(1) Structure of form returned by get_flux_str; or
(1) Dataset number (default 1)
(2) Evaluation point, or lower-upper bounds (default use all data)
(3) Model component or stack name (default use all appropriate models)
These functions retrieve the summation of
convolved predicted model amplitudes.
The output of get_flux_str(), a structure, can be used as
input to get_mcounts_sum() and get_bmcounts_sum().
One would retrieve this default structure, modify its field values, and
pass it to get_mcounts_sum() et al. See the example below.
Note that numerical arguments are interpreted using Sherpa's
current
ANALYSIS setting.
The structure output by these functions contains the following fields:
get_mcounts_sum Structure Fields
| dataset |
the dataset for which the counts summation is evaluated |
| range |
the single point at which the counts is determined,
or the range over which the counts are summed; if NULL,
the summation is done over the entire dataset range |
| comp |
the model stack or component for which the counts are
summed; if NULL, the whole source/bg stack is used |
| value |
the summation of counts |
| units |
NULL for these functions |
See the related Sherpa command
MCOUNTS for more information.
Fit a power-law to a dataset; compute
the sum of model amplitudes between 2 and 10 keV:
sherpa> foo = get_flux_str()
sherpa> print(foo)
dataset = 1
range = NULL
comp = NULL
sherpa> foo.range = [2,10]
sherpa> print(get_mcounts_sum(foo).value)
291.483
sherpa> print(get_mcounts_sum(,2.0,"p").value)
12.6129
- 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_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,
sherpa_utils,
show,
simspec,
use,
version
|
![[CIAO Logo]](../imgs/ciao_logo_navbar.gif){kind=logo}