Last modified: December 2013

Jump to: Description · Examples · Bugs · See Also

AHELP for CIAO 4.11 Sherpa v1


Context: plotting


Create an X,Y scatter plot.


plot_scatter(x, y, name="(x,y)", xlabel="x", ylabel="y", replot=False,
overplot=False, clearwindow=True)


The plot_scatter() function creates a scatter plot using the input x and y data arrays (NumPy ndarrays), with the specified title and axis labels.

Argument Default Description
x NumPy ndarray of x values
y NumPy ndarray of y values
name "(x,y)" title to assign to the plot
xlabel "x" label to assign to the x-axis
ylabel "y" label to assign to the y-axis
replot False Should previously-calculated arrays be used to create the plot?
overplot False If True, then add the data to the current plot, otherwise erase the frame and create a new plot.
clearwindow True If True, then do not delete any existing frames in the current ChIPS window. Note that the plots will be created in a new ChIPS frame even when this argument is set.


Example 1


Assign an array of flux values to variable 'x' and array of corresponding significance values to variable 'y', and create an x,y scatter plot of the data using the plot_scatter() function with default preferences.

sherpa> x = [7.89598603e-13, 7.83831341e-13, 7.56311062e-13,
7.82468252e-13, 7.86805883e-13, 7.18030229e-13]
sherpa> y = [3., 4., 5., 6., 10., 2.]

sherpa> plot_scatter(x,y)

Example 2

plot_scatter(redshift, index, name="P-L Photon Index versus Quasar
Redshift", ylabel="X-ray power law photon index", xlabel="quasar

Assign an array of quasar redshift values to variable 'redshift' and and array of corresponding power law photon index values to variable 'index', and create a scatter plot of the data. Customize the title and axis labels of the plot by specifying 'redshift' as the x-axis label, 'index' as the y-axis label, and "P-L Photon Index versus Quasar Redshift" as the plot title.

sherpa> redshift = [3.9, 4.5, 4.19, 4.23, 4.46]
sherpa> index = [1.25, 1.35, 0.75, 1.3, 1.8]

sherpa> plot_scatter(redshift,index, name="P-L Photon Index
          vs. Quasar Redshift", ylabel="X-ray power law photon
          index", xlabel="quasar redshift")


See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

See Also

get_data_prof, get_data_prof_prefs, get_delchi_prof, get_delchi_prof_prefs, get_fit_prof, get_model_prof, get_model_prof_prefs, get_resid_prof, get_resid_prof_prefs, get_source_prof, get_source_prof_prefs, plot_chart_spectrum, plot_marx_spectrum, prof_data, prof_delchi, prof_fit, prof_fit_delchi, prof_fit_resid, prof_model, prof_resid, prof_source
get_arf_plot, get_bkg_plot
list_model_ids, show_bkg_model, show_bkg_source
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, 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
get_energy_flux_hist, get_lrt_plot, get_lrt_results, get_photon_flux_hist, get_pvalue_plot, get_pvalue_results, get_split_plot, plot, plot_arf, plot_bkg, plot_cdf, plot_chisqr, plot_data, plot_delchi, plot_energy_flux, plot_fit, plot_model, plot_model_component, plot_order, plot_pdf, plot_photon_flux, plot_pvalue, plot_ratio, plot_resid, plot_source, plot_source_component, plot_trace, set_xlinear, set_xlog, set_ylinear, set_ylog
delete_psf, load_conv, plot_kernel
save_delchi, save_resid
get_chisqr_plot, get_delchi_plot
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth
contour_model, contour_ratio, contour_resid, get_ratio, get_resid