Last modified: December 2024

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/get_source_components_plot.html
AHELP for CIAO 4.17 Sherpa

get_source_components_plot

Context: plotting

Synopsis

Return the data used by plot_source_components.

Syntax

get_source_components_plot(id=None)

Description


Example

Return the plot data for the individual components used in the default data set. In this case it will report plots for gal * pl and gal * gline :

>>> set_source(xsphabs.gal * (powlaw1d.pl + gauss1d.gline))
>>> cplots = get_source_components_plot()

PARAMETERS

The parameter for this function is:

Parameter Type information Definition
id int, str, or None, optional The data set that provides the data. If not given then the default identifier is used, as returned by `get_default_id` .

Return value

The return value from this function is:

plot -- A plot object containing the individual plot objects.

Notes

Unlike get_source_component this routine does not accept either model or recalc arguments.

Changes in CIAO

Added in CIAO 4.17


Bugs

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