Synopsis
Contour the ratio of data to model.
Syntax
contour_ratio(id=None, replot=False, overcontour=False, **kwargs) id - int or str, optional replot - bool, optional overcontour - bool, optional
Description
The ratio image is formed by dividing the data by the current model, including any PSF. The preferences are the same as `contour_data` .
Examples
Example 1
Plot the ratio from the default data set:
>>> contour_ratio()
Example 2
Overplot the ratio on the residuals:
>>> contour_resid('img')
>>> contour_ratio('img', overcontour=True)PARAMETERS
The parameters for this function are:
| Parameter | Definition |
|---|---|
| id | The data set that provides the data and 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_ratio` . 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
- copy_data, dataspace1d, dataspace2d, datastack, delete_data, fake, get_axes, 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, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_data_plot_prefs, get_dep, get_dims, get_error, get_quality, get_specresp, get_staterror, get_syserror, group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width, 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_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_data, 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_contour, 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