get_model_plot

Context: modeling

Synopsis

Return a plot, contour, or image of a model, or the associated preferences

Syntax

get_model_plot( [id] )
get_model_plot_prefs()
get_model_contour( [id] )
get_model_contour_prefs()
get_model_image( [id] )

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")

get_model_plot

The get_model_plot command returns a model plot object which holds references to various plot preferences and data arrays. The attributes are:

Field name	Description
x	The bin centers (independent variable)
y	The value of the dependent variable
yerr	The error on y
xerr	The half-width of the bin
xlabel	The label for the X axis
ylabel	The label for the Y axis
title	The plot title
plot_prefs	The preferences for the plot

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

get_model_plot_prefs

The get_model_plot_prefs command returns a dictionary of model plot preferences. For example:

{'symbolstyle': 0, 'linethickness': 3, 'linestyle': 1, 'linecolor': 'red'}

Users can change preferences as desired in the set returned by this function, as shown below in the examples. These preferences changes the appearance of models plotted using the following commands: plot_model(), plot_bkg_model(), the "fit" versions of these commands, such as plot_fit(), plot_bkg_fit(), and plot_fit_delchi().

get_model_contour

The get_model_contour command returns a model contour object which holds references to various plot preferences and data arrays. The attributes are:

Field name	Description
x0	The coordinate values for the first axis as a 1D array
x1	The coordinate values for the second axis as a 1D array
y	The model value at each point of (x0,x1) as a 1D array
levels	The levels used for drawing contours
xlabel	The label for the X axis
ylabel	The label for the Y axis
title	The plot title
contour_prefs	The preferences for the plot

get_model_contour_prefs

The get_model_contour_prefs command returns a dictionary of model contour preferences. For example:

{'color': 'red', 'style': None, 'thickness': 3}

get_model_image

The get_model_image command returns an image object which holds the reference to the image array. The attributes are:

Field name	Description
name	A label for the object
y	The model data (as a 2D array)
eqpos	Information on the world coordinate system (if available)
sky	Information on the physical coordinate system (if available)

Example 1

sherpa> p = get_model_plot_prefs()
sherpa> p["xlog"] = True
sherpa> p["ylog"] = True
sherpa> p["symbolstyle"] = chips_none
sherpa> p["linetyle"] = chips_dot
sherpa> p["linecolor"] = "orange"
sherpa> p["linethickness"] = 2

Change the defaults for plot_model() so that:

both the X and Y axes will be drawn using a log scale;
no symbols will be drawn;
the points will be connected using a dotted, orange line of thickness 2.

Example 2

sherpa> get_model_plot()

Return a model plot object for the default dataset.

Example 3

sherpa> get_model_contour("src")

Return a model contour object for dataset "src".

Bugs

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