Synopsis
Define the convolved model expression for a data set.
Syntax
set_full_model(id, model=None)
Description
The model expression created by `set_model` can be modified by "instrumental effects", such as a PSF set by `set_psf` . The `set_full_model` function is for when this is not sufficient, and full control is needed. An example of when this would be if different PSF models should be applied to different source components.
Example
Apply different PSFs to different components, as well as an unconvolved component:
>>> load_psf("psf1", "psf1.dat")
>>> load_psf("psf2", "psf2.dat")
>>> smodel = psf1(gauss2d.src1) + psf2(beta2d.src2) + const2d.bgnd
>>> set_full_model("src", smodel)PARAMETERS
The parameters for this function are:
| Parameter | Type information | Definition |
|---|---|---|
| id | int or str, optional | The data set containing the source expression. If not given then the default identifier is used, as returned by `get_default_id` . |
| model | str or sherpa.models.Model object | This defines the model used to fit the data. It can be a Python expression or a string version of it. |
Notes
The function does not follow the normal Python standards for parameter use, since it is designed for easy interactive use. When called with a single un-named argument, it is taken to be the `model` parameter. If given two un-named arguments, then they are interpreted as the `id` and `model` parameters, respectively.
Some functions - such as `plot_source` - may not work for model expressions created by `set_full_model` .
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- confidence
- set_conf_opt, set_covar_opt, set_proj_opt
- data
- 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, set_areascal, set_arf, set_backscal, set_bkg, set_coord, set_counts, set_data, set_dep, set_exposure, set_grouping, set_quality, set_rmf, set_staterror, set_syserror
- filtering
- set_filter
- fitting
- fit
- info
- list_model_ids, show_bkg_model, show_bkg_source
- methods
- set_iter_method, set_iter_method_opt, set_method, set_method_opt
- modeling
- 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, 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_model, set_model_autoassign_func, set_par, set_pileup_model, set_source, t_sample, uniform_sample
- plotting
- 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
- psfs
- delete_psf, load_conv, set_psf
- saving
- save_delchi, save_resid
- statistics
- set_prior, set_sampler, set_sampler_opt, set_stat
- utilities
- calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth, set_analysis, set_default_id
- visualization
- contour_model, contour_ratio, contour_resid, image_setregion