Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/image_resid.html
AHELP for CIAO 4.13 Sherpa v1

image_resid

Context: visualization

Synopsis

Display the residuals (data - model) for a data set in the image viewer.

Syntax

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

id - int or str, optional
newframe - bool, optional
tile - bool, optional

Description

This function displays the residuals (data - model) for a data set.

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


Examples

Example 1

Display the residuals for the default data set.

>>> image_resid()

Example 2

Display the residuals for data set 2 in a new frame so that the data in the current frame is not destroyed. The new data will be displayed in a single frame (i.e. the only data shown by the viewer).

>>> image_resid(2, newframe=True)

Example 3

Display the residuals for data sets 'i1' and 'i2' side by side:

>>> image_resid('i1')
>>> image_resid('i2', newframe=True, tile=True)

PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set. If not given then the default identifier is used, as returned by `get_default_id` .
newframe Create a new frame for the data? If False , the default, then the data will be displayed in the current frame.
tile 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 [1] .

References


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_resid_image, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_setregion, image_xpaget, image_xpaset