get_contour_prefs

Synopsis

Return the preferences for the given contour type.

Syntax

get_contour_prefs(contourtype, id=None)

Description

Example

Change the contours of the model to be drawn partly opaque (with the matplotlib backend):

>>> prefs = get_contour_prefs("data")
>>> prefs['alpha'] = 0.7
>>> contour_data()
>>> contour_model(overcontour=True)

PARAMETERS

The parameters for this function are:

Parameter	Type information	Definition
contourtype	str	The contour type, such as "data", "model", or "resid". The "fit" argument is not supported.
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:

prefs -- Changing the values of this dictionary will change any new contour plots. This dictionary will be empty if no plot backend is available.

Notes

The meaning of the fields depend on the chosen plot backend. A value of none means to use the default value for that attribute, or not to use that setting.

The "fit" argument can not be used, even though there is a get_fit_contour call. Either use the "data" or "model" arguments to access the desired plot type, or use get_fit_contour() and access the datacontour and modelcontour attributes directly.

Changes in CIAO

Added in CIAO 4.16

Bugs

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