| AHELP for CIAO 4.5 Sherpa v1 | contour_ratio |
Context: visualization |
Synopsis
Open a contour plot of a data-to-model ratio in ChIPS
Syntax
contour_ratio( [ id, [replot=False,overcontour=False]] )
Description
The contour_ratio function opens in ChIPS a contour plot of the ratio of a data set, i.e. the data set divided by data set model, by data set ID. If no data set ID is specified, the default data set will be used. To plot contours of a data set, model, fit, fit residuals, or psf, use the contour function.
Arguments:
- id - Sherpa data set ID; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
- replot - Send cached data arrays to ChIPS; default=False
- overcontour - Contour data without clearing previous plot; default=False
Example 1
sherpa> contour_ratio()
The contour_ratio function can be called with no arguments, in which case a contour plot of the data-to-model ratio is made for the default data set loaded in the Sherpa session, with the default settings.
Example 2
sherpa> contour_ratio(3, overcontour=False)
Here, the contour_ratio function clears the previous plot and sends a contour of the data-to-model ratio for data set 3 to ChIPS.
Example 3
sherpa> contour_ratio(replot=True, overcontour=True)
This command sends a cached contour plot of the data-to-model ratio for data set 1 to ChIPS, without clearing the previous plot.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- data
- copy_data, dataspace1d, dataspace2d, delete_data, fake, get_axes, get_bkg_plot, get_counts, get_data, get_data_plot, get_dep, get_dims, get_error, get_quality, get_specresp, get_staterror, get_syserror, group, load_ascii, load_data, load_grouping, load_image, load_quality, pack_image, set_data, set_quality, ungroup, unpack_ascii, unpack_data, unpack_image
- filtering
- get_filter, load_filter, set_filter
- info
- get_default_id, list_data_ids, list_model_ids, list_response_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_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, image_model, image_model_component, image_source, image_source_component, integrate, integrate1d, link, load_table_model, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_full_model, set_model_autoassign_func, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset, t_sample, uniform_sample
- plotting
- get_lrt_plot, get_lrt_results, get_pvalue_plot, get_pvalue_results, plot_cdf, plot_data, plot_lrt, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace, set_xlinear, set_xlog, set_ylinear, set_ylog
- psfs
- contour_kernel, contour_psf, delete_psf, image_kernel, load_conv
- saving
- save_delchi, save_error, save_filter, save_grouping, save_quality, save_resid, save_staterror, save_syserror
- utilities
- calc_chisqr, calc_data_sum, calc_data_sum2d, calc_energy_flux, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum, calc_model_sum2d, calc_photon_flux, calc_source_sum, calc_source_sum2d, calc_stat, eqwidth, get_rate
- visualization
- contour, contour_data, contour_fit, contour_fit_resid, contour_model, contour_resid, contour_source, get_ratio, get_resid, histogram1d, histogram2d, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset, rebin

![[Sherpa Logo]](../imgs/sherpa_logo_navbar.gif)