get_kernel_image

sherpa.astro.ui.get_kernel_image(id: IdType | None = None)

Return the data used by image_kernel.

Parameters:

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

Returns:

psf_data

Return type:

a sherpa.image.PSFKernelImage instance

Raises:

sherpa.utils.err.IdentifierErr – If a PSF model has not been created for the data set.

See also

get_psf_image

Return the data used by image_psf.

image_kernel

Display the 2D kernel for a data set in the image viewer.

image_psf

Display the 2D PSF model for a data set in the image viewer.

Examples

Return the image data for the kernel for the default data set:

>>> lplot = get_kernel_image()
>>> iplot.y.shape
(51, 51)