Synopsis
Return the data used by plot_source.
Syntax
get_source_plot(id=None, lo=None, hi=None, recalc=True) id - int or str, optional lo - number, optional hi - number, optional recalc - bool, optional
Examples
Example 1
Retrieve the source plot information for the default data set and then display it:
>>> splot = get_source_plot() >>> print(splot)
Example 2
Return the plot data for data set 2, and then use it to create a plot:
>>> s2 = get_source_plot(2) >>> s2.plot()
Example 3
Retrieve the source plots for the 0.5 to 7 range of the 'jet' and 'core' data sets and display them on the same plot:
>>> splot1 = get_source_plot(id='jet', lo=0.5, hi=7) >>> splot2 = get_source_plot(id='core', lo=0.5, hi=7) >>> splot1.plot() >>> splot2.overplot()
Example 4
Access the plot data (for a PHA data set) and select only the bins corresponding to the 2-7 keV range defined in the call:
>>> splot = get_source_plot(lo=2, hi=7) >>> xlo = splot.xlo[splot.mask] >>> xhi = splot.xhi[splot.mask] >>> y = splot.y[splot.mask]
Example 5
For a PHA data set, the units on both the X and Y axes of the plot are controlled by the `set_analysis` command. In this case the Y axis will be in units of photon/s/cm^2/keV x Energy and the X axis in keV:
>>> set_analysis('energy', factor=1) >>> splot = get_source_plot() >>> print(splot)
PARAMETERS
The parameters for this function are:
Parameter | Definition |
---|---|
id | The data set that provides the data. If not given then the default identifier is used, as returned by `get_default_id` . |
lo | The low value to plot (only used for PHA data sets). |
hi | The high value to plot (only use for PHA data sets). |
recalc | If False then the results from the last call to `plot_source` (or `get_source_plot` ) are returned, otherwise the data is re-generated. |
Return value
The return value from this function is:
An object representing the data used to create the plot by `plot_source` . The return value depends on the data set (e.g. PHA, 1D binned, 1D un-binned). If lo or hi were set then the mask attribute of the object can be used to apply the filter to the xlo , xhi , and y attributes.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- confidence
- get_conf, get_conf_results, get_covar, get_covar_opt, get_covar_results, get_covariance_results, get_int_proj, get_int_unc, get_proj, get_proj_opt, get_proj_results, get_projection_results, get_reg_proj, get_reg_unc
- contrib
- get_chart_spectrum, get_marx_spectrum
- data
- get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_arf, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_rmf, get_bkg_scale, get_bkg_source, get_bkg_source_plot, get_coord, 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_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror
- filtering
- get_filter
- fitting
- calc_stat_info, get_stat_info
- info
- get_default_id, list_model_ids, list_stats, show_bkg_model, show_bkg_source
- methods
- get_draws, get_iter_method_name, get_iter_method_opt, get_method, get_method_name, get_method_opt
- 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_response, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, 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, get_split_plot, plot_cdf, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace
- psfs
- delete_psf, get_psf, get_psf_contour, get_psf_image, get_psf_plot, load_conv
- saving
- save_delchi, save_resid
- statistics
- get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat, get_stat_name
- utilities
- calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth, get_analysis, get_rate
- visualization
- contour_model, contour_ratio, contour_resid, image_getregion