get_kernel_plot

sherpa.astro.ui.get_kernel_plot(id: IdType | None = None, recalc: bool = True, copy: bool = True) → sherpa.plot.PSFKernelContour

Return the data used by plot_kernel.

Changed in version 4.19.0: The plot 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.

recalcbool, optional

If False then the results from the last call to plot_kernel (or get_kernel_plot) are returned, otherwise the data is re-generated.

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:

kernel_plota sherpa.plot.PSFKernelPlot instance

Raises:

sherpa.utils.err.IdentifierErr

If a PSF model has not been created for the data set.

See also

get_psf_plot

Return the data used by plot_psf.

plot_kernel

Plot the 1D kernel applied to a data set.

plot_psf

Plot the 1D PSF model applied to a data set.

Examples

Return the plot data and then create a plot with it:

>>> kplot = get_kernel_plot()
>>> kplot.plot()