Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/get_response.html
Jump to: Description · Example · PARAMETERS · Bugs · See Also


AHELP for CIAO 4.13 Sherpa v1

get_response

Context: modeling

Synopsis

Return the response information applied to a PHA data set.

Syntax

get_response(id=None, bkg_id=None)

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

Description

For a PHA data set, the source model - created by `set_model` - is modified by a model representing the instrumental effects - such as the effective area of the mirror, the energy resolution of the detector, and any model of pile up - which is collectively known as the instrument response. The `get_response` function returns the instrument response model.


Example

Create an empty PHA data set, load in an ARF and RMF, and then retrieve the response. The response is then used to model the instrument response applied to a `powlaw1d` model component, along with a constant component ( `bgnd` ) that does not "pass through" the instrument response:

>>> dataspace1d(1, 1024, 1, dstype=DataPHA)
>>> load_arf('src.arf')
>>> load_rmf('src.rmf')
>>> rsp = get_response()
>>> set_full_model(rsp(powlaw1d.pl) + const1d.bgnd)

PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set containing the instrument response. If not given then the default identifier is used, as returned by `get_default_id` .
bkg_id If given, return the response for the given background component, rather than the source.

Return value

The return value from this function is:

The return value depends on whether an ARF, RMF, or pile up model has been associated with 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
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, load_arf, load_bkg_arf, load_bkg_rmf, load_multi_arfs, load_multi_rmfs, load_rmf, set_arf, set_rmf, unpack_arf, unpack_rmf
filtering
get_filter
fitting
calc_stat_info, get_stat_info
info
get_default_id, 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
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_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_arf
psfs
get_psf, get_psf_contour, get_psf_image, get_psf_plot
statistics
get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
utilities
get_analysis, get_rate
visualization
image_getregion