get_specresp

Synopsis

Return the effective area of a PHA spectrum

get_specresp([id, filter=False, bkg_id])

Description

The get_specresp() function returns the effective area array of a PHA source or background spectrum, by data set ID or background ID (bkg_id). The effective area has units of cm^2.

• id - the id of the data set to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
• filter - apply an established data filter to the data set before returning results; default=False
• bkg_id - the id of the background to use, e.g. if more than one background is associated with the data; default is the first background data set loaded

Example 1

sherpa> get_specresp()

When called with no arguments, the get_specresp() function returns the effective area array of the unfiltered default data set.

sherpa> get_specresp()
           
array([  2.46003189e+01,   2.46003189e+01,   2.46003189e+01,
         2.46003189e+01,   2.46003189e+01,   2.46003189e+01,
         2.46003189e+01,   2.46003189e+01,   2.46003189e+01,
. . . . ., 
         1.00000000e+00,   1.00000000e+00,   1.00000000e+00,
         1.00000000e+00])

Example 2

sherpa> get_specresp(1, bkg_id=1)

To return the effective area of a background associated with a data set, the background ID must be specified along with the data set ID. Here, the effective area array of the first background loaded for data set 1 is returned by get_specresp().

sherpa> get_specresp(1, 1)  

array([  24.60031891,   24.60031891,   24.60031891,   24.60031891,
         24.60031891,   24.60031891,   24.60031891,   24.60031891,
         24.60031891,   24.60031891,   24.60031891,   24.60031891,
. . . . .,      
         11.07425496,   10.85468429,   10.63558233,   10.41627978,
         10.19827679,    9.98038954,    9.76504485,    9.55377735,
          9.34527298,    9.14399513,    8.97895669,    8.82890079])

Example 3

sherpa> get_specresp(1, filter=True)

If a data set ID is supplied to get_specresp(), the unfiltered effective area array of the specified data set is returned, unless the 'filter' argument is set to 'True'.

sherpa> notice()
sherpa> get_specresp().size
           1024
sherpa> ignore(10,15)
sherpa> get_specresp(filter=True).size
           684

Bugs

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

See Also

confidence

get_conf, get_covar, get_int_proj, get_int_unc, get_proj, get_reg_proj, get_reg_unc

contrib

get_chart_spectrum

data

copy_data, dataspace1d, dataspace2d, delete_data, fake, get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_plot, get_bkg_scale, get_coord, get_counts, get_data, get_data_plot, get_dep, get_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_staterror, get_syserror, group, 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_fit, 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

modeling

clean, get_model, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_order_plot, get_par, get_pileup_model, get_response, get_source, get_source_component_image, get_source_component_plot, image_source

plotting

get_split_plot, plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog

psfs

get_kernel, get_psf

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

utilities

calc_data_sum, calc_data_sum2d, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum2d, calc_source_sum2d, get_analysis, get_rate

visualization

contour, contour_data, contour_ratio, get_ratio, get_resid, histogram1d, histogram2d, image_data, image_getregion, rebin