Last modified: December 2020

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


AHELP for CIAO 4.13 Sherpa v1

get_ratio_image

Context: visualization

Synopsis

Return the data used by image_ratio.

Syntax

get_ratio_image(id=None)

id - int or str, optional

Example

Return the ratio data for the default data set:

>>> rinfo = get_ratio_image()

PARAMETERS

The parameter for this function is:

Parameter Definition
id The data set. If not given then the default identifier is used, as returned by `get_default_id` .

Return value

The return value from this function is:

ratio_img -- The y attribute contains the ratio values as a 2D NumPy array.


Bugs

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

See Also

visualization
get_resid_image, image_ratio