get_model_component_plot¶

sherpa.astro.ui.get_model_component_plot(id, model=None)¶

Return the data used by plot_model_component.

Parameters:	id (int or str, optional) – The data set that provides the data. If not given then the default identifier is used, as returned by get_default_id. model (str or sherpa.models.model.Model instance) – The component to use (the name, if a string).
Returns:	An object representing the data used to create the plot by plot_model_component. The return value depends on the data set (e.g. 1D binned or un-binned).
Return type:	instance

See also

get_model_plot(): Return the data used by plot_model.
plot_model(): Plot the model for a data set.
plot_model_component(): Plot a component of the model for a data set.

Notes

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.

Examples

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

>>> cplot = get_model_component(pl)

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

>>> fmodel = xsphabs.gal * (powlaw1d.pl + gauss1d.gline)
>>> set_source('jet', fmodel)
>>> fit('jet')
>>> fplot = get_model('jet')
>>> plot1 = get_model_component('jet', pl*gal)
>>> plot2 = get_model_component('jet', gline*gal)