Last modified: December 2024

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


AHELP for CIAO 4.17 Sherpa

image_fit

Context: visualization

Synopsis

Display the data, model, and residuals for a data set in the image viewer.

Syntax

image_fit(id=None, newframe=True, tile=True, deleteframes=True)

Description

This function displays the data, model (including any instrument response), and 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 fit results - that is, the data, model, and residuals - for the default data set.

>>> image_fit()

Example 2

Do not tile the frames (the three frames are loaded, but only the last displayed, the residuals), and then change the frame being displayed to the second one (the model).

>>> image_fit('img', tile=False)
>>> image_xpaset('frame 2')

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.
deleteframes bool, optional Should existing frames be deleted? The default is True .

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
fitting
fit, simulfit
methods
get_iter_method_name, get_iter_method_opt, list_iter_methods, set_iter_method, set_iter_method_opt
modeling
image_model, image_model_component, image_source, image_source_component
plotting
plot_fit, plot_fit_delchi, plot_fit_resid
psfs
image_kernel
statistics
get_stat, get_stat_name
utilities
calc_chisqr, calc_stat
visualization
contour, contour_data, contour_model, contour_ratio, contour_resid, image_close, image_data, image_deleteframes, image_getregion, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset