Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/image_model_component.html
AHELP for CIAO 4.13 Sherpa v1

image_model_component

Context: modeling

Synopsis

Display a component of the model in the image viewer.

Syntax

image_model_component(id, model=None, newframe=False, tile=False)

id - int or str, optional
model - str or sherpa.models.model.Model instance
newframe - bool, optional
tile - bool, optional

Description

This function evaluates and displays a component of the model expression for a data set, including any instrument response. Use `image_source_component` to exclude the response.

The image viewer is automatically started if it is not already open.


Examples

Example 1

Display the full source model and then just the 'gsrc' component for the default data set:

>>> image_model()
>>> image_model_component(gsrc)

Example 2

Display the 'clus' component of the model for the 'img' data set side by side without the with any instrument response (such as convolution with a PSF model):

>>> image_source_component('img', 'clus')
>>> image_model_component('img', 'clus', 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` .
model The component to display (the name, if a string).
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

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.

Image visualization is optional, and provided by the DS9 application [1] .

References


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, 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, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset