get_model_component_plot

Context: modeling

Synopsis

Returns the data and preferences defining the convolved model component plot

Syntax

get_model_component_plot([id], name)

Description

id - the id of the dataset to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
name - the variable name(s) representing the model component(s)

The get_model_component_plot() command returns the data arrays and preferences which define a plot of convolved model components created with the plot_model_component() command. (The get_source_component_plot command is available for returning information pertaining to plots of unconvolved model components.) Once a data set has been loaded into the Sherpa session, this command can be used to list the xlo, xhi, and y data arrays associated with a specified model component, as well as the x label, y label, title, and other (histogram) plotting preferences and settings. The information returned by get_model_component_plot() may be stored in variables, or printed to the screen, as shown in the examples section.

Attributes:

Field name	Description
xlo	grid array, low bins (independent variable)
xhi	grid array, high bins (independent variable)
y	convolved model amplitudes (dependent variable)
xlabel	The label for the X axis
ylabel	The label for the Y axis
title	The plot title
histo_prefs	dictionary of histogram plotting preferences

Note that the show_model command ("ahelp show_model") is recommended to simply print the current model to the screen.

Example 1

sherpa> print get_model_component_plot(2, "p1")

Return the data arrays and preferences defining the plot of the convolved power law model component "p1" associated with data set 2.

sherpa> load_data(2, "source_pi.fits")
sherpa> set_model(2, "xsphabs.abs1*powlaw1d.p1")

sherpa> print get_model_component_plot(2, "p1")
xlo    = [  1.0000e+00   2.0000e+00   3.0000e+00 ...,   1.0220e+03   1.0230e+03
   1.0240e+03]
xhi    = [    2.     3.     4. ...,  1023.  1024.  1025.]
y      = [  1.2732e-04   6.3658e-05   4.2439e-05 ...,   1.2458e-07   1.2445e-07
   1.2433e-07]
xlabel = Channel
ylabel = Counts/sec
title  = Model component: powlaw1d.p1
histo_prefs = {'linethickness': 2, 'symbolcolor': None, 'symbolfill': None, 'xlog': False, 'ylog': False, 'symbolangle': None, 'errthickness': None, 'fillcolor': None, 'linecolor': 'orange', 'errstyle': None, 'linestyle': 1, 'symbolstyle': 0, 'errcolor': None, 'fillstyle': None, 'fillopacity': None, 'yerrorbars': False, 'symbolsize': None}

Example 2

sherpa> set_model("gauss1d.g1+const1d.c1")
sherpa> gauss_plot=get_model_component_plot("g1")
sherpa> gauss_plot.histo_prefs["symbolcolor"]="cyan"

Store the plot information returned by the get_model_component_plot() command for the Guass 1D model component "g1" to the variable "gauss_plot". Use the "gauss_plot" variable to change the color of plot symbols to cyan.

Bugs

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