Last modified: December 2020

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

contour_model

Context: visualization

Synopsis

Create a contour plot of the model.

Syntax

contour_model(id=None, replot=False, overcontour=False, **kwargs)

id - int or str, optional
replot - bool, optional
overcontour - bool, optional

Description

Displays a contour plot of the values of the model, evaluated on the data, including any PSF kernel convolution (if set).


Examples

Example 1

Plot the model from the default data set:

>>> contour_model()

Example 2

Compare the model without and with the PSF component, for the "img" data set:

>>> contour_source("img")
>>> contour_model("img", overcontour=True)

PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set that provides the model. If not given then the default identifier is used, as returned by `get_default_id` .
replot Set to True to use the values calculated by the last call to `contour_model` . The default is False .
overcontour If True then add the data to an existing plot, otherwise create a new contour plot. The default is False .

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_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
contour_kernel, contour_psf, 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_fit, contour_fit_resid, contour_ratio, contour_resid, contour_source, get_model_contour, get_model_contour_prefs, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset