Last modified: December 2023

AHELP for CIAO 4.16 Sherpa


Context: psfs


Load a 1D convolution model.


load_conv(modelname, filename_or_model, *args, **kwargs)

modelname - str
filename_or_model - str or model instance


The convolution model can be defined either by a data set, read from a file, or an analytic model, using a Sherpa model instance. A source model can be convolved with this model by including modelname in the `set_model` call, using the form:



Example 1

Create a 1D data set, assign a box model - which is flat between the xlow and xhi values and zero elsewhere - and then display the model values. Then add in a convolution component by a gaussian and overplot the resulting source model with two different widths.

>>> dataspace1d(-10, 10, 0.5, id='tst', dstype=Data1D)
>>> set_source('tst', box1d.bmdl)
>>> bmdl.xlow = -2
>>> bmdl.xhi = 3
>>> plot_source('tst')
>>> load_conv('conv', normgauss1d.gconv)
>>> gconv.fwhm = 2
>>> set_source('tst', conv(bmdl))
>>> plot_source('tst', overplot=True)
>>> gconv.fwhm = 5
>>> plot_source('tst', overplot=True)

Example 2

Create a convolution component called "cmodel" which uses the data in the file "conv.dat", which should have two columns (the X and Y values).

>>> load_conv('cmodel', 'conv.dat')


The parameters for this function are:

Parameter Definition
modelname The identifier for this PSF model.
filename_or_model This can be the name of an ASCII file or a Sherpa model component.
args Arguments for `unpack_data` if `filename_or_model` is a file.
kwargs Keyword arguments for `unpack_data` if `filename_or_model` is a file.


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

See Also

get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_source_plot
list_model_ids, show_bkg_model, show_bkg_source
add_model, add_user_pars, clean, create_model_component, delete_bkg_model, delete_model, delete_model_component, get_model, get_model_autoassign_func, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, get_xsabund, get_xscosmo, get_xsxsect, get_xsxset, image_model, image_model_component, image_source, image_source_component, integrate, link, load_table_model, load_template_interpolator, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_bkg_source, set_full_model, set_model, set_model_autoassign_func, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset, t_sample, uniform_sample
get_cdf_plot, get_pdf_plot, get_pvalue_plot, get_pvalue_results, plot_cdf, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace
contour_kernel, contour_psf, delete_psf, get_psf, get_psf_contour, get_psf_image, get_psf_plot, image_kernel, image_psf, load_psf, plot_kernel, plot_psf, set_psf, show_kernel, show_psf
save_delchi, save_resid
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth
contour_model, contour_ratio, contour_resid