Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/get_rate.html
AHELP for CIAO 4.13 Sherpa v1

get_rate

Context: utilities

Synopsis

Return the count rate of a PHA data set.

Syntax

get_rate(id=None, filter=False, bkg_id=None)

id - int or str, optional
filter - bool, optional
bkg_id - int or str, optional

Description

Return an array of count-rate values for each bin in the data set. The units of the returned values depends on the values set by the `set_analysis` rountine for the data set.


Examples

Example 1

Return the count-rate for the default data set. For a PHA data set, where `set_analysis` has not been called, the return value will be in units of count/second/keV, and a value for each group in the data set is returned.

>>> rate = get_rate()

Example 2

The return value is grouped to match the data, but is not filtered (with the default `filter` argument). The data set used here 46 groups in it, but after filtering only has 40 groups, but the call to `get_rate` returns a 46-element array unless `filter` is explicitly set to `True` :

>>> notice()
>>> get_rate().size
46
>>> ignore(None, 0.5)
>>> ignore(7, None)
>>> get_rate().size
46
>>> get_rate(filter=True).size
40

Example 3

The rate of data set 2 will be in units of count/s/Angstrom and only cover the range 20 to 22 Angstroms:

>>> set_analysis(2, 'wave')
>>> notice_id(2, 20, 22)
>>> r2 = get_rate(2, filter=True)

Example 4

The returned rate is now in units of count/s (the return value is multiplied by `binwidth^factor` , where `factor` is normally 0):

>>> set_analysis(2, 'wave', factor=1)
>>> r2 = get_rate(2, filter=True)

Example 5

Return the count rate for the second background component of data set "grating":

>>> get_rate(id="grating", bkg_id=2)

PARAMETERS

The parameters for this function are:

Parameter Definition
id The identifier for the data set to use. If not given then the default identifier is used, as returned by `get_default_id` .
filter Should the filter attached to the data set be applied to the return value or not. The default is False .
bkg_id Set if the rate should be taken from the background associated with the data set.

Return value

The return value from this function is:

rate -- The rate array. The output matches the grouping of the data set. The units are controlled by the `set_analysis` setting for this data set; that is, the units used in `plot_data` , except that the `type` argument to `set_analysis` is ignored. The return array will match the grouping scheme applied to the data set.


Bugs

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

See Also

confidence
get_conf, get_conf_results, get_covar, get_covar_opt, get_covar_results, get_covariance_results, get_int_proj, get_int_unc, get_proj, get_proj_opt, get_proj_results, get_projection_results, get_reg_proj, get_reg_unc
contrib
get_chart_spectrum, get_marx_spectrum
data
copy_data, dataspace1d, dataspace2d, datastack, delete_data, fake, get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_arf, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_rmf, get_bkg_scale, get_bkg_source, get_bkg_source_plot, get_coord, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_data_plot_prefs, get_dep, get_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror, group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width, load_ascii, load_data, load_grouping, load_quality, set_data, set_quality, ungroup, unpack_ascii, unpack_data
filtering
get_filter, load_filter, set_filter
fitting
calc_stat_info, get_stat_info
info
get_default_id, list_data_ids, list_response_ids, list_stats
methods
get_draws, get_iter_method_name, get_iter_method_opt, get_method, get_method_name, get_method_opt
modeling
clean, get_model, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_response, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, image_source
plotting
get_split_plot, plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog
psfs
get_psf, get_psf_contour, get_psf_image, get_psf_plot
saving
save_error, save_filter, save_grouping, save_quality, save_staterror, save_syserror
statistics
get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
utilities
calc_data_sum, calc_data_sum2d, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum2d, calc_source_sum2d, get_analysis
visualization
contour, contour_data, contour_ratio, histogram1d, histogram2d, image_data, image_getregion, rebin