get_model_component_plot

sherpa.ui.get_model_component_plot(id, model=None, recalc: bool = True, copy: bool = True)

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

Changed in version 4.19.0: The plot object is now copied by default. To get the previous behaviour set the copy attribute to False.

Parameters:

idint 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.
modelstr or sherpa.models.model.Model instance: The component to use (the name, if a string).
recalcbool, optional: 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.
copybool, optional: Is the plot object copied before being returned? If so then the plot attributes will not be changed by multiple calls to this routine.

Returns:

instance: 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).

See also

get_model_plot: Return the data used to create the model plot.
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_plot(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_plot('jet')
>>> plot1 = get_model_component_plot('jet', pl*gal)
>>> plot2 = get_model_component_plot('jet', gline*gal)