Last modified: December 2024

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


AHELP for CIAO 4.17 Sherpa

image_ratio

Context: visualization

Synopsis

Display the ratio (data/model) for a data set in the image viewer.

Syntax

image_ratio(id=None, newframe=False, tile=False)

Description

This function displays the ratio data/model for a data set.

The image viewer is automatically started if it is not already open.


Example

Display the ratio (data/model) for the default data set.

>>> image_ratio()

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` .
newframe bool, optional Create a new frame for the data? If False , the default, then the data will be displayed in the current frame.
tile bool, optional Should the frames be tiles? If False , the default, then only a single frame is displayed.

Notes

Image visualization is optional, and provided by the DS9 application.


Bugs

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

See Also

data
load_image, pack_image, unpack_image
modeling
image_model, image_model_component, image_source, image_source_component
psfs
image_kernel
visualization
contour, contour_data, contour_model, contour_ratio, contour_resid, get_ratio_image, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_resid, image_setregion, image_xpaget, image_xpaset