Last modified: June 2019

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/get_source_prof_prefs.html
Jump to: Description · Example · Bugs · See Also


AHELP for CIAO 4.11 Sherpa v1

get_source_prof_prefs

Context: contrib

Synopsis

The plot preferences for radial or elliptical profiles of the source model for imaging data.

Syntax

get_source_prof_prefs()

Description

The get_source_prof_prefs() command returns the preferences for plots created by the prof_source() command. Changing the values will not change existing plots, only new plots created after the change was made. For example

sherpa> get_source_prof_prefs()["xlog"] = True

will cause any new plots to use logarithmic scaling for the X axis. A list of all the preferences is given below.

Loading the routine

The routine can be loaded into Sherpa by saying:

from sherpa_contrib.profiles import *

Plot defaults

The following table lists the allowed keys and values for the object returned by get_source_prof_prefs(), for when the ChIPS backend is in use. The values returned when Matplolib is used are similar in spirit, but use the Matplotlib naming.

Key Allowed values
xlog False, True
ylog False, True
linecolor Any valid ChIPS color (e.g. "red")
linethickness 0.5 to 10
linestyle chips_solid, chips_dot, chips_noline, chips_longdash, chips_shortdash, chips_dotlongdash, chips_dotshortdash, chips_shortdashlongdash
symbolstyle chips_circle, chips_cross, chips_diamond, chips_none, chips_plus, chips_square, chips_point_type, chips_uptriangle, chips_downtriangle
symbolcolor Any valid ChIPS color (e.g. "red")
symbolfill False, True
symbolsize 1 to 100

Example

sherpa> prof_source()
sherpa> log_scale()
...
sherpa> prefs = get_source_prof_prefs()
sherpa> prefs["xlog"] = True
sherpa> prefs["ylog"] = True
sherpa> prof_source()

The preferences are set so that both the x and y axes should be drawn using log scaling. Setting the get_source_prof_prefs values only affects plots made after the change; to change an existing plot you need to use ChIPS commands such as log_scale() and linear_scale().


Bugs

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

See Also

contrib
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, plot_chart_spectrum, plot_marx_spectrum, prof_data, prof_delchi, prof_fit, prof_fit_delchi, prof_fit_resid, prof_model, prof_resid, prof_source, sherpa_profiles
data
get_arf_plot, get_bkg_plot
modeling
normal_sample, t_sample, uniform_sample
plotting
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_scatter, plot_source, plot_source_component, plot_trace, set_xlinear, set_xlog, set_ylinear, set_ylog
psfs
plot_kernel
statistics
get_chisqr_plot, get_delchi_plot
visualization
contour_resid