Last modified: December 2025

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/plot_psf.html
AHELP for CIAO 4.18 Sherpa

plot_psf

Context: psfs

Synopsis

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

Syntax

plot_psf(id: int | str | Sequence[int | str] | None = None, replot:
bool = False, overplot: bool = False, clearwindow: bool = True,
**kwargs)

No return value.

Description

The `plot_kernel` function shows the data used to convolve the model.


Example

Create a model (a step function) that is convolved by a gaussian, and display the PSF:

>>> dataspace1d(1, 10, step=1, dstype=Data1D)
>>> set_model(steplo1d.stp)
>>> stp.xcut = 4.4
>>> load_psf('psf1', gauss1d.gline)
>>> set_psf('psf1')
>>> gline.fwhm = 1.2
>>> plot_psf()

PARAMETERS

The parameters for this function are:

Parameter Type information Definition
id int, str, sequence of int or str, or None, optional The data set. If not given then the default identifier is used, as returned by `get_default_id` .
replot bool, optional Set to True to use the values calculated by the last call to `plot_psf` . The default is False .
overplot bool, optional If True then add the data to an existing plot, otherwise create a new plot. The default is False .
clearwindow bool, optional Should the existing plot area be cleared before creating this new plot (e.g. for multi-panel plots)?

Changes in CIAO

Changed in CIAO 4.18

Multiple data sets can be displayed by using a list of identifiers. Per-plot options can now be given by using a list of values.


Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

psfs
contour_kernel, contour_psf, delete_psf, get_psf, get_psf_contour, get_psf_image, get_psf_plot, image_kernel, image_psf, load_conv, load_psf, plot_kernel, set_psf, show_kernel, show_psf