| AHELP for CIAO 4.5 Sherpa v1 | get_resid |
Context: visualization |
Synopsis
Return information on a contour plot of the residuals of data and model.
Syntax
get_resid_contour( [id] ) get_resid_image( [id] ) get_resid_plot( [id] )
Description
get_resid_contour When a 2-D model is assigned to a data set, a contour plot of the residuals between the data and model can be created. This function returns a variable listing all the information that went into making that plot--title, axis labels, data arrays, contour levels and other plot preferences.
get_resid_image When a 2-D model is assigned to a data set, an image of the residuals between the data and model can be created. This function returns a variable containing the image of that residuals.
get_resid_plot When a 1-D model is assigned to a data set, a plot of the residuals between the data and model can be created. This function returns a variable listing all the information that went into making that plot--title, axis labels, data arrays, error bars and other plot preferences.
Example 1
sherpa> get_resid_contour() sherpa> get_resid_contour(1)
This function returns a variable listing all information that went into making a contour plot of the residuals of data and model. If no argument is given, then the default data set ID is assumed. If an argument is given, then information about the residuals contour plot that goes with that data set is returned.
Example 2
sherpa> get_resid_image() sherpa> get_resid_image(1)
This function returns a variable containing the image of the residuals of the data and model. If no argument is given, then the default data set ID is assumed. If an argument is given, then the image of the residuals for that data set is returned.
Example 3
sherpa> get_resid_plot() sherpa> get_resid_plot(1)
This function returns a variable listing all information that went into making a plot of the residuals of data and model. If no argument is given, then the default data set ID is assumed. If an argument is given, then information about the residuals plot that goes with that data set is returned.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- confidence
- get_conf, get_covar, get_int_proj, get_int_unc, get_proj, get_reg_proj, get_reg_unc
- contrib
- get_chart_spectrum
- data
- copy_data, dataspace1d, dataspace2d, delete_data, fake, get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_plot, get_bkg_scale, get_coord, get_counts, get_data, get_data_plot, get_dep, get_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror, group, load_ascii, load_data, load_grouping, load_quality, set_data, set_quality, ungroup, unpack_ascii, unpack_data
- filtering
- get_filter, load_filter, set_filter
- fitting
- calc_stat_info, get_fit, get_stat_info
- info
- get_default_id, list_data_ids, list_model_ids, list_response_ids, list_stats, show_bkg_model, show_bkg_source
- methods
- get_draws, get_iter_method_name, get_iter_method_opt, get_method
- 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_response, 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, get_split_plot, 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
- delete_psf, get_kernel, get_psf, load_conv
- saving
- save_delchi, save_error, save_filter, save_grouping, save_quality, save_resid, save_staterror, save_syserror
- statistics
- get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat
- 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_analysis, get_rate
- visualization
- contour, contour_data, contour_model, contour_ratio, contour_resid, get_ratio, histogram1d, histogram2d, image_data, image_getregion, rebin

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