Synopsis
Display the model for a data set in the image viewer.
Syntax
image_model(id=None, newframe=False, tile=False) id - int or str, optional newframe - bool, optional tile - bool, optional
Description
This function evaluates and displays the model expression for a data set, including any instrument response (e.g. PSF or ARF and RMF) whether created automatically or with `set_full_model` .
The image viewer is automatically started if it is not already open.
Examples
Example 1
Display the model for the default data set.
>>> image_model()
Example 2
Display the model for data set 2 in a new frame so that the data in the current frame is not destroyed. The new data will be displayed in a single frame (i.e. the only data shown by the viewer).
>>> image_model(2, newframe=True)
Example 3
Display the models for data sets 'i1' and 'i2' side by side:
>>> image_model('i1')
>>> image_model('i2', newframe=True, tile=True)PARAMETERS
The parameters for this function are:
| Parameter | Definition |
|---|---|
| id | The data set. If not given then the default identifier is used, as returned by `get_default_id` . |
| newframe | Create a new frame for the data? If False , the default, then the data will be displayed in the current frame. |
| tile | Should the frames be tiles? If False , the default, then only a single frame is displayed. |
Notes
Image visualization is optional, and provided by the DS9 application.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- 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, load_image, pack_image, unpack_image
- info
- list_model_ids, show_bkg_model, show_bkg_source
- 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, get_xsabund, get_xscosmo, get_xsxsect, get_xsxset, 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
- 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, image_kernel, load_conv
- saving
- save_delchi, save_resid
- utilities
- calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth
- visualization
- contour, contour_data, contour_model, contour_ratio, contour_resid, get_model_image, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset