Calculate the sum of convolved model counts
calc_model_sum( [lo,hi,id,bkg_id] )
The calc_model_sum function calculates the sum of convolved model
counts for all or a portion of a source or background
data set by data ID or background ID.
A subset of the model can be specified
by entering the low and high ends of the desired data interval
in units of keV for energy data or angstroms for wavelength
data. To sum the amplitudes of unconvolved source or background
models in units of counts/cm^2/sec/keV (or counts/cm^2/sec/A),
the function calc_source_sum can be used by data ID or
background ID.
-
lo - low limit;
default=None
-
hi - high limit;
default=None
-
id - data ID;
if not given, uses the default sherpa id (id=1 by default, see "ahelp get_default_id")
-
bkg_id - background data ID
The calc_model_sum function can be called with no
arguments, in which
case the convolved model counts will be summed over the
entire data range
of the default data set. The counts of a convolved
background model can be summed by supplying the
corresponding Sherpa-assigned background ID as the
argument (e.g. "1" or
"2" for the first or second background data set
automatically located by Sherpa
in the corresponding source data set).
For 1-D data, if
o) a single energy, wavelength, or bin number is given (as
opposed to a [lo, hi] interval), then the sum of convolved model
counts in the bin associated with that value is
returned.
o) an energy or wavelength range is given with the 'lo' and 'hi'
arguments, then the sum of convolved model counts
for the given range is returned.
o) no value or range is specified, then the sum of
convolved model counts for the full range of the data set
is returned.
For 2-D data, the summation is carried out over the entire
input image.
When supplied with no arguments, calc_model_sum will sum
the convolved model counts over
the entire data range of the default data set.
sherpa> calc_model_sum(id=3)
Here, data set "3" is specified, so the convolved model
counts will be summed over the entire data range of
data set 3.
sherpa> calc_model_sum(10.0, id=4)
The sum of convolved model counts in the bin(s) corresponding to
10.0 keV in data set 4 is returned.
sherpa> calc_model_sum(bkg_id=1)
When supplied with a background ID, the
convolved background model associated with the specified
background data set will be summed over the entire
data range. In this example, the first background
data set automatically located by Sherpa is used.
sherpa> calc_model_sum(lo=0.1, hi=7.0, "bkg")
The convolved background model counts
between 0.1 and 7.0 keV are summed for the
background data set with user-assigned ID "bkg". (Note
that a user-defined string ID cannot be supplied to the
"bkg_id" argument)
sherpa> calc_model_sum(1.0, 15.0,id=1, bkg_id=2)
The convolved background model counts between 1 and
15 angstroms are summed for the second background data set
automatically loaded by Sherpa with source data set 1.
- py.sherpa
-
add_user_pars,
calc_chisqr,
calc_energy_flux,
calc_photon_flux,
calc_source_sum,
calc_stat,
clean,
contour_model,
contour_ratio,
contour_resid,
create_model_component,
delete_bkg_model,
delete_model,
delete_model_component,
delete_psf,
eqwidth,
gamma,
get_bkg_plot,
get_model,
get_model_autoassign_func,
get_model_plot,
get_num_par,
get_order_plot,
get_par,
get_pileup_model,
get_ratio,
get_resid,
get_source,
igam,
igamc,
image_model,
image_source,
incbet,
integrate,
lgam,
link,
list_model_ids,
load_table_model,
load_user_model,
plot_model,
plot_source,
reset,
set_bkg_model,
set_model,
set_model_autoassign_func,
set_pileup_model,
set_source
- sherpa_tools
-
modelflux
|
![[Sherpa Logo]](../imgs/sherpa_logo_navbar.gif){kind=logo}