get_resid_image

sherpa.astro.ui.get_resid_image(id=None)

Return the data used by image_resid.

Parameters

id (int or str, optional) – The data set. If not given then the default identifier is used, as returned by get_default_id.

Returns

resid_img – The y attribute contains the residual values as a 2D NumPy array.

Return type

a sherpa.image.ResidImage instance

Raises

See also

get_ratio_image

Return the data used by image_ratio.

contour_resid

Contour the residuals of the fit.

image_resid

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

Examples

Return the residual data for the default data set:

>>> rinfo = get_resid_image()