Last modified: December 2021

Jump to: Description · Examples · PARAMETERS · Notes · Bugs · See Also

AHELP for CIAO 4.14 Sherpa


Context: modeling


Return the data used to create the model-component plot.


get_model_component_plot(id, model=None, recalc=True)

id - int or str, optional
model - str or sherpa.models.model.Model instance
recalc - bool, optional


For PHA data, the response model is automatically added by the routine unless the model contains a response.


Example 1

Return the plot data for the pl component used in the default data set:

>>> cplot = get_model_component_plot(pl)

Example 2

Return the full source model ( fplot ) and then for the components gal * pl and gal * gline , for the data set 'jet':

>>> fmodel = * ( + gauss1d.gline)
>>> set_source('jet', fmodel)
>>> fit('jet')
>>> fplot = get_model_plot('jet')
>>> plot1 = get_model_component_plot('jet', pl*gal)
>>> plot2 = get_model_component_plot('jet', gline*gal)

Example 3

For PHA data sets the response is automatically added, but it can also be manually specified. In the following plot1 and plot2 contain the same data:

>>> plot1 = get_model_component_plot(pl)
>>> rsp = get_response()
>>> plot2 = get_model_component_plot(rsp(pl))


The parameters for this function are:

Parameter Definition
id The data set that provides the data. If not given then the default identifier is used, as returned by `get_default_id` .
model The component to use (the name, if a string).
recalc If False then the results from the last call to `plot_model_component` (or `get_model_component_plot` ) are returned, otherwise the data is re-generated.

Return value

The return value from this function is:

An object representing the data used to create the plot by `plot_model_component` . The return value depends on the data set (e.g. PHA, 1D binned, or 1D un-binned).


The function does not follow the normal Python standards for parameter use, since it is designed for easy interactive use. When called with a single un-named argument, it is taken to be the `model` parameter. If given two un-named arguments, then they are interpreted as the `id` and `model` parameters, respectively.


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

See Also

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
get_chart_spectrum, get_marx_spectrum
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
calc_stat_info, get_stat_info
get_default_id, list_model_ids, list_stats, show_bkg_model, show_bkg_source
get_draws, get_iter_method_name, get_iter_method_opt, get_method, get_method_name, get_method_opt
add_model, add_user_pars, clean, create_model_component, delete_bkg_model, delete_model, delete_model_component, get_model, get_model_autoassign_func, get_model_component, get_model_component_image, 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, get_xsabund, get_xscosmo, get_xsxsect, get_xsxset, image_model, image_model_component, image_source, image_source_component, integrate, link, load_table_model, load_template_interpolator, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_bkg_source, set_full_model, set_model, set_model_autoassign_func, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset, t_sample, uniform_sample
get_cdf_plot, get_pdf_plot, get_pvalue_plot, get_pvalue_results, get_split_plot, plot_cdf, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace
delete_psf, get_psf, get_psf_contour, get_psf_image, get_psf_plot, load_conv
save_delchi, save_resid
get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth, get_analysis, get_rate
contour_model, contour_ratio, contour_resid, image_getregion