calc_data_sum

Synopsis

Sum up the data values over a pass band.

Syntax

calc_data_sum(lo=None, hi=None, id=None, bkg_id=None)

lo - number, optional
hi - number, optional
id - int or str, optional
bkg_id - int or str, optional

Description

This function is for one-dimensional data sets: use `calc_data_sum2d` for two-dimensional data sets.

Examples

Example 1

Sum up the data values (the dependent axis) for all points or bins in the default data set:

>>> dsum = calc_data_sum()

Example 2

Calculate the number of counts over the ranges 0.5 to 2 and 0.5 to 7 keV for the default data set, first using the observed signal and then, for the 0.5 to 2 keV band - the background-subtraced estimate:

>>> set_analysis('energy')
>>> calc_data_sum(0.5, 2)
745.0
>>> calc_data_sum(0.5, 7)
60.0
>>> subtract()
>>> calc_data_sum(0.5, 2)
730.9179738207356

Example 3

Calculate the data value in the bin containing 0.5 keV for the source "core":

>>> calc_data_sum(0.5, id="core")
0.0

Example 4

Calculate the sum of the second background component for data set 3 over the independent axis range 12 to 45:

>>> calc_data_sum(12, 45, id=3, bkg_id=2)

PARAMETERS

The parameters for this function are:

Parameter	Definition
lo	If both are None or both are set then sum up the data over the given band. If only one is set then return the data count in the given bin.
hi	If both are None or both are set then sum up the data over the given band. If only one is set then return the data count in the given bin.
id	Use the source expression associated with this data set. If not given then the default identifier is used, as returned by `get_default_id` .
bkg_id	If set, use the model associated with the given background component rather than the source model.

Return value

The return value from this function is:

dsum -- If a background estimate has been subtracted from the data set then the calculation will use the background-subtracted values.

Notes

The units of lo and hi are determined by the analysis setting for the data set (e.g. `get_analysis` ). The summation occurs over those points in the data set that lie within this range, not the range itself.

Any existing filter on the data set - e.g. as created by `ignore` or `notice` - is ignored by this function.

If a grouping scheme has been applied to the data set that it will be used. This can change the results, since the first and last bins of the selected range may extend outside the requested range.

Bugs

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