Last modified: December 2024

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/get_ratio_contour.html
Jump to: · Example · PARAMETERS · Bugs · See Also


AHELP for CIAO 4.17 Sherpa

get_ratio_contour

Context: visualization

Synopsis

Return the data used by contour_ratio.

Syntax

get_ratio_contour(id=None, recalc=True)

Example

Return the ratio data for the default data set:

>>> rinfo = get_ratio_contour()

PARAMETERS

The parameters for this function are:

Parameter Type information Definition
id int, str, or None, optional The data set. If not given then the default identifier is used, as returned by `get_default_id` .
recalc bool, optional If False then the results from the last call to `contour_ratio` (or `get_ratio_contour` ) are returned, otherwise the data is re-generated.

Return value

The return value from this function is:

ratio_data -- The y attribute contains the ratio values and the x0 and x1 arrays contain the corresponding coordinate values, as one-dimensional arrays.


Bugs

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

See Also

visualization
contour_ratio, get_resid_contour