Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2013

URL: http://cxc.harvard.edu/sherpa/ahelp/load_psf.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.6 Sherpa v2

load_psf

Context: psfs

Synopsis

Load a PSF model

Syntax

load_psf( modelname, filename|model )

Description

The load_psf command loads a PSF from file or model. The PSF model can then be used to convolve (fold) a given source model by using the set_psf command ("ahelp set_psf").

  • modelname - a name for the PSF model
  • filename|model - the name of a file, including path, which contains the PSF image or the name of a model to use in creating the PSF model

If the function is being loaded from a file, some additional options are allowed. A table will accept the arguments to load_table: ncols, colkeys, dstype ("ahelp load_table"). An image will accept the argument associated with load_image: coord ("ahelp load_image").

Note that it is not required that 2D PSF models have equal (x,y) size parameters; rectangular PSFs are supported. It is also possible to simultaneously fit multiple data sets with each independent source model convolved by a different PSF model.

What is the difference between the PSF and the kernel?

The point spread function (PSF) is defined by the full (unfiltered) PSF image loaded into Sherpa or the PSF model expression evaluated over the full range of the dataset; both types of PSFs are established with the load_psf() command. The kernel is the subsection of the PSF image or model which is used to convolve the data. This subsection is created from the PSF when the size and center of the kernel are defined by the command set_psf(). While the kernel and PSF might be congruent, defining a smaller kernel helps speed the convolution process by restricting the number of points within the PSF that Sherpa must evaluate.

Example 1

sherpa> load_psf( "psf", "psf_0.25pix.fits" )

Load a PSF image from the file psf_0.25pix.fits, using the id "psf".

Example 2

sherpa> load_psf( "modpsf", gauss2d.g1 )

Create a model-based PSF from the model component "gauss2d.g1".

Example 3

sherpa> load_image("xmm_source.fits")
sherpa> set_coord("logical")
sherpa> set_source(beta2d.src+const2d.bg)
sherpa> load_psf("psf0", beta2d.p1 )
sherpa> p1.center =[276,117]
sherpa> p1.r0 = 2.2
sherpa> p1.alpha = 1.58
sherpa> freeze(p1)
sherpa> set_psf(psf0)
sherpa> fit()

A 2-D Beta model is defined as the PSF to convolve with the source model for image data set 1. The source model is defined as the sum of a 2-D Beta model and 2-D constant amplitude model, for modeling diffuse emission and the background level, respectively. The central (x,y) position of the PSF model is set to match the (image) coordinates of the source of interest in data set 'source.fits', and the 'r0' and 'alpha' parameters are set to match the PSF of XMM; the PSF model parameters are then frozen before the fit. The PSF model is convolved with the source model when set_psf is issued,and the PSF-convolved model is then fit to data set 1 when the fit command is run.

Example 4

sherpa> load_psf("psf1", beta2d.p1)
sherpa> set_psf(psf1)
sherpa> load_psf("psf2", "psf.fits")
sherpa> set_psf(2, psf2)
sherpa> fit()

A 2-D Beta model is used as the PSF to convolve with the source model for data set 1, and the PSF model defined in file 'psf.fits' is used to convolve the source model for data set 2. The PSF models are convolved with the corresponding source models when set_psf is issued. Data sets 1 and 2 are simultaneously fit with their associated source models convolved by different PSF models.

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_kernel, get_psf, image_kernel, image_psf, load_conv, plot_kernel, plot_psf, set_psf, show_kernel, show_psf

Last modified: December 2013
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxcweb@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2014. All rights reserved.