get_resid_image

sherpa.astro.ui.get_resid_image(id: IdType | None = None, copy: bool = True) → sherpa.image.ResidImage

Return the data used by image_resid.

Changed in version 4.19.0: The image object is now copied by default. To get the previous behaviour set the copy attribute to False.

Parameters:

idint, str, or None, optional

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

copybool, optional

Is the plot object copied before being returned? If so then the plot attributes will not be changed by multiple calls to this routine.

Returns:

resid_imga sherpa.image.ResidImage instance

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

Raises:

sherpa.utils.err.DataErr

If the data set is not 2D.

sherpa.utils.err.IdentifierErr

If the data set does not exist or a source expression has not been set.

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()