Last modified: 16 December 2020

Contextual List of Ahelp Files


Context Topic Summary
confidence confidence Estimate parameter confidence intervals using the confidence method.
conf Estimate parameter confidence intervals using the confidence method.
covariance Estimate parameter confidence intervals using the covariance method.
covar Estimate parameter confidence intervals using the covariance method.
get_confidence_results Return the results of the last conf run.
get_conf_opt Return one or all of the options for the confidence interval method.
get_conf_results Return the results of the last conf run.
get_conf Return the confidence-interval estimation object.
get_covariance_results Return the results of the last covar run.
get_covar_opt Return one or all of the options for the covariance method.
get_covar_results Return the results of the last covar run.
get_covar Return the covariance estimation object.
get_int_proj Return the interval-projection object.
get_int_unc Return the interval-uncertainty object.
get_projection_results Return the results of the last proj run.
get_proj_opt Return one or all of the options for the confidence interval method.
get_proj_results Return the results of the last proj run.
get_proj Return the confidence-interval estimation object.
get_reg_proj Return the region-projection object.
get_reg_unc Return the region-uncertainty object.
int_proj Calculate and plot the fit statistic versus fit parameter value.
int_unc Calculate and plot the fit statistic versus fit parameter value.
projection Estimate parameter confidence intervals using the projection method.
proj Estimate parameter confidence intervals using the projection method.
reg_proj Plot the statistic value as two parameters are varied.
reg_unc Plot the statistic value as two parameters are varied.
set_conf_opt Set an option for the confidence interval method.
set_covar_opt Set an option for the covariance method.
set_proj_opt Set an option for the projection method.

contrib estimate_weighted_expmap Return the estimated exposure map value by weighting an ARF by a spectral model.
get_chart_spectrum Return the model spectrum in the form required by ChaRT2
get_data_prof_prefs The plot preferences for radial or elliptical profiles of imaging data.
get_data_prof Return the data used to create the radial or elliptical profile of imaging data.
get_delchi_prof_prefs The plot preferences for radial or elliptical profiles of the residuals (data - model)/error to imaging data.
get_delchi_prof Return the data used to create the radial or elliptical profile of the residuals (data - model)/error to imaging data.
get_fit_prof Return the data used to create the radial or elliptical profile of fits to imaging data.
get_instmap_weights Return the model spectrum in the form required by the spectrumfile parameter of mkinstmap
get_marx_spectrum Return the model spectrum in the form required by MARX
get_model_prof_prefs The plot preferences for radial or elliptical profiles of the model (after any PSF convolution) for imaging data.
get_model_prof Return the data used to create the radial or elliptical profile of the source model (after any PSF convolution) for imaging data.
get_resid_prof_prefs The plot preferences for radial or elliptical profiles of the residuals (data - model) to imaging data.
get_resid_prof Return the data used to create the radial or elliptical profile of the residuals (data - model) to imaging data.
get_source_prof_prefs The plot preferences for radial or elliptical profiles of the source model for imaging data.
get_source_prof Return the data used to create the radial or elliptical profile of the source model (before any PSF convolution) for imaging data.
plot_chart_spectrum Plot up the model spectrum in the form required by ChaRT
plot_instmap_weights Plot up the model spectrum in the form required by mkinstmap
plot_marx_spectrum Plot up the model spectrum in the form required by MARX
prof_data Plot a radial or elliptical profile of imaging data.
prof_delchi Plot a radial or elliptical profile of the residuals (data - model)/error to imaging data.
prof_fit_delchi Plot a radial or elliptical profile of the fit (data and model) and residuals (data-model)/error to imaging data.
prof_fit_resid Plot a radial or elliptical profile of the fit (data and model) and residuals (data-model) to imaging data.
prof_fit Plot a radial or elliptical profile of the fit (data and model) to imaging data.
prof_model Plot a radial or elliptical profile of the model (after any PSF convolution) for imaging data.
prof_resid Plot a radial or elliptical profile of the residuals (data - model) to imaging data.
prof_source Plot a radial or elliptical profile of the source model for imaging data.
renorm Change the normalization of a model to match the data.
save_chart_spectrum Write out the model spectrum in the form required by ChaRT2
save_instmap_weights Write out the model spectrum in the form required by mkinstmap
save_marx_spectrum Write out the model spectrum in the form required by MARX
sherpa_chart Create and view spectral files for ChaRT2 (CIAO contributed package).
sherpa_contrib Contributed CIAO routines for Sherpa.
sherpa_marx Create and view spectral files for MARX (CIAO contributed package).
sherpa_profiles Radial profiles of imaging data in Sherpa (CIAO contributed package).
sherpa_utils Utility routines for Sherpa (CIAO contributed package).

data copy_data Copy a data set, creating a new identifier.
create_arf Create an ARF.
create_rmf Create an RMF.
dataspace1d Create the independent axis for a 1D data set.
dataspace2d Create the independent axis for a 2D data set.
datastack Sherpa extension package for modeling stacks of data.
delete_data Delete a data set by identifier.
fake_pha Simulate a PHA data set from a model.
fake Simulate a data set.
get_areascal Return the fractional area factor of a PHA data set.
get_arf_plot Return the data used by plot_arf.
get_arf Return the ARF associated with a PHA data set.
get_axes Return information about the independent axes of a data set.
get_backscal Return the BACKSCAL scaling of a PHA data set.
get_bkg_arf Return the background ARF associated with a PHA data set.
get_bkg_chisqr_plot Return the data used by plot_bkg_chisqr.
get_bkg_delchi_plot Return the data used by plot_bkg_delchi.
get_bkg_fit_plot Return the data used by plot_bkg_fit.
get_bkg_model_plot Return the data used by plot_bkg_model.
get_bkg_model Return the model expression for the background of a PHA data set.
get_bkg_plot Return the data used by plot_bkg.
get_bkg_ratio_plot Return the data used by plot_bkg_ratio.
get_bkg_resid_plot Return the data used by plot_bkg_resid.
get_bkg_rmf Return the background RMF associated with a PHA data set.
get_bkg_scale Return the background scaling factor for a background data set.
get_bkg_source_plot Return the data used by plot_bkg_source.
get_bkg_source Return the model expression for the background of a PHA data set.
get_bkg Return the background for a PHA data set.
get_coord Get the coordinate system used for image analysis.
get_counts Return the dependent axis of a data set.
get_data_contour_prefs Return the preferences for contour_data.
get_data_contour Return the data used by contour_data.
get_data_image Return the data used by image_data.
get_data_plot_prefs Return the preferences for plot_data.
get_data_plot Return the data used by plot_data.
get_data Return the data set by identifier.
get_dep Return the dependent axis of a data set.
get_dims Return the dimensions of the data set.
get_error Return the errors on the dependent axis of a data set.
get_exposure Return the exposure time of a PHA data set.
get_grouping Return the grouping array for a PHA data set.
get_indep Return the independent axes of a data set.
get_quality Return the quality flags for a PHA data set.
get_rmf Return the RMF associated with a PHA data set.
get_specresp Return the effective area values for a PHA data set.
get_staterror Return the statistical error on the dependent axis of a data set.
get_syserror Return the systematic error on the dependent axis of a data set.
group_adapt_snr Adaptively group to a minimum signal-to-noise ratio.
group_adapt Adaptively group to a minimum number of counts.
group_bins Group into a fixed number of bins.
group_counts Group into a minimum number of counts per bin.
group_snr Group into a minimum signal-to-noise ratio.
group_width Group into a fixed bin width.
group Turn on the grouping for a PHA data set.
load_arf Load an ARF from a file and add it to a PHA data set.
load_arrays Create a data set from array values.
load_ascii_with_errors Load an ASCII file with asymmetric errors as a data set.
load_ascii Load an ASCII file as a data set.
load_bkg_arf Load an ARF from a file and add it to the background of a PHA data set.
load_bkg_rmf Load a RMF from a file and add it to the background of a PHA data set.
load_bkg Load the background from a file and add it to a PHA data set.
load_data Load a data set from a file.
load_grouping Load the grouping scheme from a file and add to a PHA data set.
load_image Load an image as a data set.
load_multi_arfs Load multiple ARFs for a PHA data set.
load_multi_rmfs Load multiple RMFs for a PHA data set.
load_pha Load a PHA data set.
load_quality Load the quality array from a file and add to a PHA data set.
load_rmf Load a RMF from a file and add it to a PHA data set.
load_staterror Load the statistical errors from a file.
load_syserror Load the systematic errors from a file.
load_table Load a FITS binary file as a data set.
pack_image Convert a data set into an image structure.
pack_pha Convert a PHA data set into a file structure.
pack_table Convert a data set into a table structure.
resample_data Resample data with asymmetric error bars.
set_areascal Change the fractional area factor of a PHA data set.
set_arf Set the ARF for use by a PHA data set.
set_backscal Change the area scaling of a PHA data set.
set_bkg Set the background for a PHA data set.
set_coord Set the coordinate system to use for image analysis.
set_counts Set the dependent axis of a data set.
set_data Set a data set.
set_dep Set the dependent axis of a data set.
set_exposure Change the exposure time of a PHA data set.
set_grouping Apply a set of grouping flags to a PHA data set.
set_quality Apply a set of quality flags to a PHA data set.
set_rmf Set the RMF for use by a PHA data set.
set_staterror Set the statistical errors on the dependent axis of a data set.
set_syserror Set the systematic errors on the dependent axis of a data set.
subtract Subtract the background estimate from a data set.
ungroup Turn off the grouping for a PHA data set.
unpack_arf Create an ARF data structure.
unpack_arrays Create a sherpa data object from arrays of data.
unpack_ascii Unpack an ASCII file into a data structure.
unpack_bkg Create a PHA data structure for a background data set.
unpack_data Create a sherpa data object from a file.
unpack_image Create an image data structure.
unpack_pha Create a PHA data structure.
unpack_rmf Create a RMF data structure.
unpack_table Unpack a FITS binary file into a data structure.
unsubtract Undo any background subtraction for the data set.

filtering get_filter Return the filter expression for a data set.
ignore2d_id Exclude a spatial region from a data set.
ignore2d_image Exclude pixels using the region defined in the image viewer.
ignore2d Exclude a spatial region from all data sets.
ignore_bad Exclude channels marked as bad in a PHA data set.
ignore_id Exclude data from the fit for a data set.
ignore Exclude data from the fit.
load_filter Load the filter array from a file and add to a data set.
notice2d_id Include a spatial region of a data set.
notice2d_image Include pixels using the region defined in the image viewer.
notice2d Include a spatial region of all data sets.
notice_id Include data from the fit for a data set.
notice Include data in the fit.
set_filter Set the filter array of a data set.
show_filter Show any filters applied to a data set.

fitting calc_stat_info Display the statistic values for the current models.
fit_bkg Fit a model to one or more background PHA data sets.
fit Fit a model to one or more data sets.
get_fit_results Return the results of the last fit.
get_stat_info Return the statistic values for the current models.
simulfit Fit a model to one or more data sets.

info get_default_id Return the default data set identifier.
get_functions Return the functions provided by Sherpa.
list_bkg_ids List all the background identifiers for a data set.
list_data_ids List the identifiers for the loaded data sets.
list_functions Display the functions provided by Sherpa.
list_model_ids List of all the data sets with a source expression.
list_pileup_model_ids List of all the data sets with a pile up model.
list_psf_ids List of all the data sets with a PSF.
list_response_ids List all the response identifiers of a data set.
list_stats List the fit statistics.
show_all Report the current state of the Sherpa session.
show_bkg_model Display the background model expression used to fit a data set.
show_bkg_source Display the background model expression for a data set.
show_bkg Show the details of the PHA background data sets.
show_conf Display the results of the last conf evaluation.
show_covar Display the results of the last covar evaluation.
show_data Summarize the available data sets.
show_fit Summarize the fit results.
show_method Display the current optimization method and options.
show_model Display the model expression used to fit a data set.
show_proj Display the results of the last proj evaluation.
show_source Display the source model expression for a data set.
show_stat Display the current fit statistic.

methods get_draws Run the pyBLoCXS MCMC algorithm.
get_iter_method_name Return the name of the iterative fitting scheme.
get_iter_method_opt Return one or all options for the iterative-fitting scheme.
get_method_name Return the name of current Sherpa optimization method.
get_method_opt Return one or all of the options for the current optimization method.
get_method Return an optimization method.
gridsearch Grid searching optimization method
levmar Levenberg-Marquardt optimization method
list_iter_methods List the iterative fitting schemes.
list_methods List the optimization methods.
moncar Monte Carlo optimization method
neldermead Nelder-Mead Simplex optimization method
pyblocxs MCMC-based algorithm for Bayesian Low-Count X-ray Spectral (BLoCXS) analysis
set_iter_method_opt Set an option for the iterative-fitting scheme.
set_iter_method Set the iterative-fitting scheme used in the fit.
set_method_opt Set an option for the current optimization method.
set_method Set the optimization method.

model delete_pileup_model Delete the pile up model for a data set.

modeling add_model Create a user-defined model class.
add_user_pars Add parameter information to a user model.
clean Clear out the current Sherpa session.
create_model_component Create a model component.
delete_bkg_model Delete the background model expression for a data set.
delete_model_component Delete a model component.
delete_model Delete the model expression for a data set.
freeze Fix model parameters so they are not changed by a fit.
get_model_autoassign_func Return the method used to create model component identifiers.
get_model_component_image Return the data used by image_model_component.
get_model_component_plot Return the data used to create the model-component plot.
get_model_component Returns a model component given its name.
get_model_pars Return the names of the parameters of a model.
get_model_plot Return the data used to create the model plot.
get_model_type Describe a model expression.
get_model Return the model expression for a data set.
get_num_par_frozen Return the number of frozen parameters in a model expression.
get_num_par_thawed Return the number of thawed parameters in a model expression.
get_num_par Return the number of parameters in a model expression.
get_order_plot Return the data used by plot_order.
get_par Return a parameter of a model component.
get_pileup_model Return the pile up model for a data set.
get_response Return the response information applied to a PHA data set.
get_source_component_image Return the data used by image_source_component.
get_source_component_plot Return the data used by plot_source_component.
get_source_contour Return the data used by contour_source.
get_source_image Return the data used by image_source.
get_source_plot Return the data used by plot_source.
get_source Return the source model expression for a data set.
get_xsabund Return the X-Spec abundance setting or elemental abundance.
get_xschatter Return the chatter level used by X-Spec.
get_xscosmo Return the X-Spec cosmology settings.
get_xsxsect Return the cross sections used by X-Spec models.
get_xsxset Return the X-Spec model setting.
guess Estimate the parameter values and ranges given the loaded data.
image_model_component Display a component of the model in the image viewer.
image_model Display the model for a data set in the image viewer.
image_source_component Display a component of the source expression in the image viewer.
image_source Display the source expression for a data set in the image viewer.
integrate1d <Integrate1D model type>
integrate Controlling the integration of model components
link Link a parameter to a value.
load_table_model Load tabular or image data and use it as a model component.
load_template_interpolator Set the template interpolation scheme.
load_template_model Load a set of templates and use it as a model component.
load_user_model Create a user-defined model.
load_xstable_model Load a XSPEC table model.
normal_sample Sample the fit statistic by taking the parameter values from a normal distribution.
paramprompt Should the user be asked for the parameter values when creating a model?
reset Reset the model parameters to their default settings.
save_model Save the model values to a file.
save_source Save the model values to a file.
set_bkg_full_model Define the convolved background model expression for a PHA data set.
set_bkg_model Set the background model expression for a PHA data set.
set_bkg_source Set the background model expression for a PHA data set.
set_full_model Define the convolved model expression for a data set.
set_model_autoassign_func Set the method used to create model component identifiers.
set_model Set the source model expression for a data set.
set_par Set the value, limits, or behavior of a model parameter.
set_pileup_model Include a model of the Chandra ACIS pile up when fitting PHA data.
set_source Set the source model expression for a data set.
set_xsabund Set the elemental abundances used by X-Spec models.
set_xschatter Set the chatter level used by X-Spec.
set_xscosmo Set the cosmological parameters used by X-Spec models.
set_xsxsect Set the cross sections used by X-Spec models.
set_xsxset Set a X-Spec model setting.
thaw Allow model parameters to be varied during a fit.
t_sample Sample the fit statistic by taking the parameter values from a Student's t-distribution.
uniform_sample Sample the fit statistic by taking the parameter values from an uniform distribution.
unlink Unlink a parameter value.

models absorptionedge Optical model of an absorption edge.
absorptiongaussian Gaussian function for modeling absorption (equivalent width).
absorptionlorentz Lorentz function for modeling absorption (equivalent width).
accretiondisk A model of emission due to an accretion disk.
atten Model the attenuation by the Inter-Stellar Medium (ISM).
bbodyfreq A one-dimensional Blackbody model (frequency).
bbody A one-dimensional Blackbody model.
beta1d One-dimensional beta model function.
beta2d Two-dimensional beta model function.
blackbody Emission from a black body as a function of wavelength.
box1d One-dimensional box function.
box2d Two-dimensional box function.
bpl1d One-dimensional broken power-law function.
bremsstrahlung Bremsstrahlung emission.
brokenpowerlaw Broken power-law model.
ccm Galactic extinction: the Cardelli, Clayton, and Mathis model.
const1d A constant model for one-dimensional data.
const2d A constant model for two-dimensional data.
cos One-dimensional cosine function.
delta1d One-dimensional delta function.
delta2d Two-dimensional delta function.
dered A de-reddening model.
devaucouleurs2d Two-dimensional de Vaucouleurs model.
disk2d Two-dimensional uniform disk model.
edge Photoabsorption edge model.
emissiongaussian Gaussian function for modeling emission.
emissionlorentz Lorentz function for modeling emission.
erfc One-dimensional complementary error function.
erf One-dimensional error function.
exp10 One-dimensional exponential function, base 10.
exp One-dimensional exponential function.
fm UV extinction curve: Fitzpatrick and Massa 1988.
gauss1d One-dimensional gaussian function.
gauss2d Two-dimensional gaussian function.
hubblereynolds Two-dimensional Hubble-Reynolds model.
jdpileup A CCD pileup model for the ACIS detectors on Chandra.
linebroad A one-dimensional line-broadening profile.
list_models List the available model types.
list_model_components List the names of all the model components.
lmc LMC extinction: the Howarth model.
log10 One-dimensional logarithm function, base 10.
logabsorption Gaussian function for modeling absorption (log of fwhm).
logemission Gaussian function for modeling emission (log of fwhm).
logparabola One-dimensional log-parabolic function.
log One-dimensional natural logarithm function.
lorentz1d One-dimensional normalized Lorentz model function.
lorentz2d Two-dimensional un-normalised Lorentz function.
models Summary of Sherpa models (excluding XSPEC).
normbeta1d One-dimensional normalized beta model function.
normgauss1d One-dimensional normalised gaussian function.
normgauss2d Two-dimensional normalised gaussian function.
opticalgaussian Gaussian function for modeling absorption (optical depth).
poisson One-dimensional Poisson function.
polynom1d One-dimensional polynomial function of order 8.
polynom2d Two-dimensional polynomial function.
polynomial Polynomial model of order 5.
powerlaw Power-law model.
powlaw1d One-dimensional power-law function.
pseudovoigt1d A weighted sum of a Gaussian and Lorentzian distribution.
recombination Optically-thin recombination continuum model.
scale1d A constant model for one-dimensional data.
scale2d A constant model for two-dimensional data.
schechter One-dimensional Schechter model function.
seaton Galactic extinction: the Seaton model from Synphot.
sersic2d Two-dimensional Sersic model.
shell2d A homogenous spherical 3D shell projected onto 2D.
sigmagauss2d Two-dimensional gaussian function (varying sigma).
sin One-dimensional sine function.
smc SMC extinction: the Prevot et al. 1984 model.
sm Galactic extinction: the Savage & Mathis model.
sqrt One-dimensional square root function.
stephi1d One-dimensional step function.
steplo1d One-dimensional step function.
tablemodel Using an n-dimensional array of values as a model (table model).
tan One-dimensional tan function.
voigt1d One dimensional Voigt profile.
xgal Extragalactic extinction: Calzetti, Kinney and Storchi-Bergmann
xsabsori The XSPEC absori model: ionized absorber.
xsacisabs The XSPEC acisabs model: Chandra ACIS q.e. decay.
xsagauss The XSPEC agauss model: gaussian line profile in wavelength space.
xsagnsed The XSPEC agnsed model: AGN SED model
xsapec The XSPEC apec model: APEC emission spectrum.
xsbapec The XSPEC bapec model: velocity broadened APEC thermal plasma model.
xsbbodyrad The XSPEC bbodyrad model: blackbody spectrum, area normalized.
xsbbody The XSPEC bbody model: blackbody spectrum.
xsbexrav The XSPEC bexrav model: reflected e-folded broken power law, neutral medium.
xsbexriv The XSPEC bexriv model: reflected e-folded broken power law, ionized medium.
xsbkn2pow The XSPEC bkn2pow model: broken power law with two breaks.
xsbknpower The XSPEC bknpower model: broken power law.
xsbmc The XSPEC bmc model: Comptonization by relativistic matter.
xsbremss The XSPEC bremss model: thermal bremsstrahlung.
xsbrnei The XSPEC brnei model: velocity-broadened non-equilibrium recombining collisional plasma.
xsbtapec The XSPEC btapec model: velocity broadened APEC emission spectrum with separate continuum and line temperatures.
xsbvapec The XSPEC bvapec model: velocity broadened APEC thermal plasma model.
xsbvrnei The XSPEC bvrnei model: velocity-broadened non-equilibrium recombining collisional plasma.
xsbvtapec The XSPEC bvtapec model: velocity broadened APEC emission spectrum with separate continuum and line temperatures.
xsbvvapec The XSPEC bvvapec model: velocity broadened APEC thermal plasma model.
xsbvvrnei The XSPEC bvvrnei model: velocity-broadened non-equilibrium recombining collisional plasma.
xsbvvtapec The XSPEC bvvtapec model: velocity broadened APEC emission spectrum with separate continuum and line temperatures.
xsc6mekl The XSPEC c6mekl model: differential emission measure using Chebyshev representations with multi-temperature mekal.
xsc6pmekl The XSPEC c6pmekl model: differential emission measure using Chebyshev representations with multi-temperature mekal.
xsc6pvmkl The XSPEC c6pvmkl model: differential emission measure using Chebyshev representations with multi-temperature mekal.
xsc6vmekl The XSPEC c6vmekl model: differential emission measure using Chebyshev representations with multi-temperature mekal.
xscabs The XSPEC cabs model: Optically-thin Compton scattering.
xscarbatm The XSPEC carbatm model: Nonmagnetic carbon atmosphere of a neutron star.
xscemekl The XSPEC cemekl model: plasma emission, multi-temperature using mekal.
xscevmkl The XSPEC cevmkl model: plasma emission, multi-temperature using mekal.
xscflow The XSPEC cflow model: cooling flow.
xscflux The XSPEC cflux convolution model: calculate flux
xsclumin The XSPEC clumin convolution model: calculate luminosity
xscompbb The XSPEC compbb model: Comptonization, black body.
xscompls The XSPEC compLS model: Comptonization, Lamb & Sanford.
xscompmag The XSPEC compmag model: Thermal and bulk Comptonization for cylindrical accretion onto the polar cap of a magnetized neutron star.
xscompps The XSPEC compPS model: Comptonization, Poutanen & Svenson.
xscompst The XSPEC compST model: Comptonization, Sunyaev & Titarchuk.
xscomptb The XSPEC comptb model: Thermal and bulk Comptonization of a seed blackbody-like spectrum.
xscompth The XSPEC compth model: Paolo Coppi's hybrid (thermal/non-thermal) hot plasma emission models.
xscomptt The XSPEC compTT model: Comptonization, Titarchuk.
xsconstant The XSPEC constant model: energy-independent factor.
xscpflux The XSPEC cpflux convolution model: calculate photon flux
xscph The XSPEC cph model: Cooling + heating model for cool core clusters
xscplinear The XSPEC cplinear model: a non-physical piecewise-linear model for low count background spectra.
xscutoffpl The XSPEC cutoffpl model: power law, high energy exponential cutoff.
xscyclabs The XSPEC cyclabs model: absorption line, cyclotron.
xsdiskbb The XSPEC diskbb model: accretion disk, multi-black body components.
xsdiskir The XSPEC diskir model: Irradiated inner and outer disk.
xsdiskline The XSPEC diskline model: accretion disk line emission, relativistic.
xsdiskm The XSPEC diskm model: accretion disk with gas pressure viscosity.
xsdisko The XSPEC disko model: accretion disk, inner, radiation pressure viscosity.
xsdiskpbb The XSPEC diskpbb model: accretion disk, power-law dependence for T(r).
xsdiskpn The XSPEC diskpn model: accretion disk, black hole, black body.
xsdisk The XSPEC disk model: accretion disk, black body.
xsdust The XSPEC dust model: dust scattering.
xsedge The XSPEC edge model: absorption edge.
xseplogpar The XSPEC eplogpar model: log-parabolic blazar model with nu-Fnu normalization.
xseqpair The XSPEC eqpair model: Paolo Coppi's hybrid (thermal/non-thermal) hot plasma emission models.
xseqtherm The XSPEC eqtherm model: Paolo Coppi's hybrid (thermal/non-thermal) hot plasma emission models.
xsequil The XSPEC equil model: collisional plasma, ionization equilibrium.
xsexpabs The XSPEC expabs model: exponential roll-off at low E.
xsexpdec The XSPEC expdec model: exponential decay.
xsexpfac The XSPEC expfac model: exponential modification.
xsezdiskbb The XSPEC ezdiskbb model: multiple blackbody disk model with zero-torque inner boundary.
xsgabs The XSPEC gabs model: gaussian absorption line.
xsgadem The XSPEC gadem model: plasma emission, multi-temperature with gaussian distribution of emission measure.
xsgaussian The XSPEC gaussian model: gaussian line profile.
xsgnei The XSPEC gnei model: collisional plasma, non-equilibrium, temperature evolution.
xsgrad The XSPEC grad model: accretion disk, Schwarzschild black hole.
xsgrbcomp The XSPEC grbcomp model: Comptonization for GRB prompt emission.
xsgrbm The XSPEC grbm model: gamma-ray burst continuum.
xsgsmooth The XSPEC gsmooth convolution model: gaussian smoothing
xshatm The XSPEC hatm model: Nonmagnetic hydrogen atmosphere of a neutron star.
xsheilin The XSPEC heilin model: Voigt absorption profiles for He I series.
xshighecut The XSPEC highecut model: high-energy cutoff.
xshrefl The XSPEC hrefl model: reflection model.
xsireflect The XSPEC ireflect convolution model: reflection from ionized material
xsismabs The XSPEC ismabs model: A high resolution ISM absorption model with variable columns for individual ions.
xsjet The XSPEC jet model: Leptonic relativistic jet model.
xskdblur2 The XSPEC kdblur2 convolution model: convolve with the laor2 model
xskdblur The XSPEC kdblur convolution model: convolve with the laor model
xskerrbb The XSPEC kerrbb model: multi-temperature blackbody model for thin accretion disk around a Kerr black hole.
xskerrconv The XSPEC kerrconv convolution model: accretion disk line shape with BH spin as free parameter
xskerrdisk The XSPEC kerrdisk model: accretion disk line emission with BH spin as free parameter.
xskerrd The XSPEC kerrd model: optically thick accretion disk around a Kerr black hole.
xskyconv The XSPEC kyconv convolution model: convolution using a relativistic line from axisymmetric accretion disk
xskyrline The XSPEC kyrline model: relativistic line from axisymmetric accretion disk
xslaor2 The XSPEC laor2 model: accretion disk with broken-power law emissivity profile, black hole emission line.
xslaor The XSPEC laor model: accretion disk, black hole emission line.
xslogpar The XSPEC logpar model: log-parabolic blazar model.
xslorentz The XSPEC lorentz model: lorentz line profile.
xslsmooth The XSPEC lsmooth convolution model: lorentzian smoothing
xslyman The XSPEC lyman model: Voigt absorption profiles for H I or He II Lyman series.
xsmekal The XSPEC mekal model: emission, hot diffuse gas (Mewe-Kaastra-Liedahl).
xsmeka The XSPEC meka model: emission, hot diffuse gas (Mewe-Gronenschild).
xsmkcflow The XSPEC mkcflow model: cooling flow, mekal.
xsnei The XSPEC nei model: collisional plasma, non-equilibrium, constant temperature.
xsnlapec The XSPEC nlapec model: continuum-only APEC emission spectrum.
xsnotch The XSPEC notch model: absorption line, notch.
xsnpshock The XSPEC npshock model: shocked plasma, plane parallel, separate ion, electron temperatures.
xsnsagrav The XSPEC nsagrav model: NS H atmosphere model for different g.
xsnsatmos The XSPEC nsatmos model: NS Hydrogen Atmosphere model with electron conduction and self-irradiation.
xsnsa The XSPEC nsa model: neutron star atmosphere.
xsnsmaxg The XSPEC nsmaxg model: neutron star with a magnetic atmosphere.
xsnsmax The XSPEC nsmax model: Neutron Star Magnetic Atmosphere.
xsnsx The XSPEC nsx model: neutron star with a non-magnetic atmosphere.
xsnteea The XSPEC nteea model: non-thermal pair plasma.
xsnthcomp The XSPEC nthComp model: Thermally comptonized continuum.
xsoptxagnf The XSPEC optxagnf model: Colour temperature corrected disc and energetically coupled Comptonisation model for AGN.
xsoptxagn The XSPEC optxagn model: Colour temperature corrected disc and energetically coupled Comptonisation model for AGN.
xspartcov The XSPEC partcov convolution model: partial covering
xspcfabs The XSPEC pcfabs model: partial covering fraction absorption.
xspegpwrlw The XSPEC pegpwrlw model: power law, pegged normalization.
xspexmon The XSPEC pexmon model: neutral Compton reflection with self-consistent Fe and Ni lines.
xspexrav The XSPEC pexrav model: reflected powerlaw, neutral medium.
xspexriv The XSPEC pexriv model: reflected powerlaw, neutral medium.
xsphabs The XSPEC phabs model: photoelectric absorption.
xsplabs The XSPEC plabs model: power law absorption.
xsplcabs The XSPEC plcabs model: powerlaw observed through dense, cold matter.
xsposm The XSPEC posm model: positronium continuum.
xspowerlaw The XSPEC powerlaw model: power law photon spectrum.
xspshock The XSPEC pshock model: plane-parallel shocked plasma, constant temperature.
xspwab The XSPEC pwab model: power-law distribution of neutral absorbers.
xsqsosed The XSPEC qsosed model: AGN SED model
xsraymond The XSPEC raymond model: emission, hot diffuse gas, Raymond-Smith.
xsrdblur The XSPEC rdblur convolution model: convolve with the diskline model shape
xsredden The XSPEC redden model: interstellar extinction.
xsredge The XSPEC redge model: emission, recombination edge.
xsreflect The XSPEC reflect convolution model: reflection from neutral material
xsrefsch The XSPEC refsch model: reflected power law from ionized accretion disk.
xsrfxconv The XSPEC rfxconv convolution model: angle-dependent reflection from an ionized disk
xsrgsxsrc The XSPEC rgsxsrc convolution model: convolve an RGS spectrum for extended emission.
xsrnei The XSPEC rnei model: non-equilibrium recombining collisional plasma.
xssedov The XSPEC sedov model: sedov model, separate ion/electron temperature.
xssimpl The XSPEC simpl convolution model: comptonization of a seed spectrum.
xssirf The XSPEC sirf model: self-irradiated funnel.
xsslimbh The XSPEC slimbh model: Stationary slim accretion disk.
xssmedge The XSPEC smedge model: smeared edge.
xssnapec The XSPEC snapec model: galaxy cluster spectrum using SN yields.
xsspexpcut The XSPEC spexpcut model: super-exponential cutoff absorption.
xsspline The XSPEC spline model: spline modification.
xssrcut The XSPEC srcut model: synchrotron spectrum, cutoff power law.
xssresc The XSPEC sresc model: synchrotron spectrum, cut off by particle escape.
xsssa The XSPEC ssa model: Strangeon star atmosphere.
xssss_ice The XSPEC sss_ice model: Einstein SSS ice absorption.
xsstep The XSPEC step model: step function convolved with gaussian.
xsswind1 The XSPEC swind1 model: absorption by partially ionized material with large velocity shear.
xstapec The XSPEC tapec model: APEC emission spectrum with separate continuum and line temperatures.
xstbabs The XSPEC TBabs model: ISM grain absorption.
xstbfeo The XSPEC TBfeo model: ISM grain absorption.
xstbgas The XSPEC TBgas model: ISM grain absorption.
xstbgrain The XSPEC TBgrain model: ISM grain absorption.
xstbpcf The XSPEC TBpcf model: ISM grain absorption.
xstbrel The XSPEC TBrel model: ISM grain absorption.
xstbvarabs The XSPEC TBvarabs model: ISM grain absorption.
xsuvred The XSPEC uvred model: interstellar extinction, Seaton Law.
xsvapec The XSPEC vapec model: APEC emission spectrum.
xsvarabs The XSPEC varabs model: photoelectric absorption.
xsvashift The XSPEC vashift convolution model: velocity shift an additive model.
xsvbremss The XSPEC vbremss model: thermal bremsstrahlung.
xsvcph The XSPEC vcph model: Cooling + heating model for cool core clusters
xsvequil The XSPEC vequil model: collisional plasma, ionization equilibrium.
xsvgadem The XSPEC vgadem model: plasma emission, multi-temperature with gaussian distribution of emission measure.
xsvgnei The XSPEC vgnei model: collisional plasma, non-equilibrium, temperature evolution.
xsvmcflow The XSPEC vmcflow model: cooling flow, mekal.
xsvmekal The XSPEC vmekal model: emission, hot diffuse gas (Mewe-Kaastra-Liedahl).
xsvmeka The XSPEC vmeka model: emission, hot diffuse gas (Mewe-Gronenschild).
xsvmshift The XSPEC vmshift convolution model: velocity shift a multiplicative model.
xsvnei The XSPEC vnei model: collisional plasma, non-equilibrium, constant temperature.
xsvnpshock The XSPEC vnpshock model: shocked plasma, plane parallel, separate ion, electron temperatures.
xsvoigt The XSPEC voigt model: Voigt line profile.
xsvphabs The XSPEC vphabs model: photoelectric absorption.
xsvpshock The XSPEC vpshock model: plane-parallel shocked plasma, constant temperature.
xsvraymond The XSPEC vraymond model: emission, hot diffuse gas, Raymond-Smith.
xsvrnei The XSPEC vrnei model: non-equilibrium recombining collisional plasma.
xsvsedov The XSPEC vsedov model: sedov model, separate ion/electron temperature.
xsvtapec The XSPEC vtapec model: APEC emission spectrum with separate continuum and line temperatures.
xsvvapec The XSPEC vvapec model: APEC emission spectrum.
xsvvgnei The XSPEC vvgnei model: collisional plasma, non-equilibrium, temperature evolution.
xsvvnei The XSPEC vvnei model: collisional plasma, non-equilibrium, constant temperature.
xsvvnpshock The XSPEC vvnpshock model: shocked plasma, plane parallel, separate ion, electron temperatures.
xsvvpshock The XSPEC vvpshock model: plane-parallel shocked plasma, constant temperature.
xsvvrnei The XSPEC vvrnei model: non-equilibrium recombining collisional plasma.
xsvvsedov The XSPEC vvsedov model: sedov model, separate ion/electron temperature.
xsvvtapec The XSPEC vvtapec model: APEC emission spectrum with separate continuum and line temperatures.
xswabs The XSPEC wabs model: photoelectric absorption, Wisconsin cross-sections.
xswndabs The XSPEC wndabs model: photo-electric absorption, warm absorber.
xsxilconv The XSPEC xilconv convolution model: angle-dependent reflection from an ionized disk
xsxion The XSPEC xion model: reflected spectrum of photo-ionized accretion disk/ring.
xsxscat The XSPEC xscat model: dust scattering.
xszagauss The XSPEC zagauss model: gaussian line profile in wavelength space.
xszashift The XSPEC zashift convolution model: redshift an additive model.
xszbabs The XSPEC zbabs model: EUV ISM attenuation.
xszbbody The XSPEC zbbody model: blackbody spectrum.
xszbknpower The XSPEC zbknpower model: broken power law.
xszbremss The XSPEC zbremss model: thermal bremsstrahlung.
xszcutoffpl The XSPEC zcutoffpl model: power law, high energy exponential cutoff.
xszdust The XSPEC zdust model: extinction by dust grains.
xszedge The XSPEC zedge model: absorption edge.
xszgauss The XSPEC zgauss model: gaussian line profile.
xszhighect The XSPEC zhighect model: high-energy cutoff.
xszigm The XSPEC zigm model: UV/Optical attenuation by the intergalactic medium.
xszlogpar The XSPEC zlogpar model: log-parabolic blazar model.
xszmshift The XSPEC zmshift convolution model: redshift a multiplicative model.
xszpcfabs The XSPEC zpcfabs model: partial covering fraction absorption.
xszphabs The XSPEC zphabs model: photoelectric absorption.
xszpowerlw The XSPEC zpowerlw model: redshifted power law photon spectrum.
xszredden The XSPEC zredden model: redshifted version of redden.
xszsmdust The XSPEC zsmdust model: extinction by dust grains in starburst galaxies.
xsztbabs The XSPEC zTBabs model: ISM grain absorption.
xszvarabs The XSPEC zvarabs model: photoelectric absorption.
xszvfeabs The XSPEC zvfeabs model: photoelectric absorption with free Fe edge energy.
xszvphabs The XSPEC zvphabs model: photoelectric absorption.
xszwabs The XSPEC zwabs model: photoelectric absorption, Wisconsin cross-sections.
xszwndabs The XSPEC zwndabs model: photo-electric absorption, warm absorber.
xszxipcf The XSPEC zxipcf model: partial covering absorption by partially ionized material.
xs XSPEC model functions.

plotting get_cdf_plot Return the data used to plot the last CDF.
get_energy_flux_hist Return the data displayed by plot_energy_flux.
get_fit_plot Return the data used to create the fit plot.
get_kernel_plot Return the data used by plot_kernel.
get_model_plot_prefs Return the preferences for plot_model.
get_pdf_plot Return the data used to plot the last PDF.
get_photon_flux_hist Return the data displayed by plot_photon_flux.
get_pvalue_plot Return the data used by plot_pvalue.
get_pvalue_results Return the data calculated by the last plot_pvalue call.
get_ratio_plot Return the data used by plot_ratio.
get_resid_plot Return the data used by plot_resid.
get_scatter_plot Return the data used to plot the last scatter plot.
get_split_plot Return the plot attributes for displays with multiple plots.
get_trace_plot Return the data used to plot the last trace.
plot_arf Plot the ARF associated with a data set.
plot_bkg_chisqr Plot the chi-squared value for each point of the background of a PHA data set.
plot_bkg_delchi Plot the ratio of residuals to error for the background of a PHA data set.
plot_bkg_fit_delchi Plot the fit results, and the residuals, for the background of a PHA data set.
plot_bkg_fit_ratio Plot the fit results, and the data/model ratio, for the background of a PHA data set.
plot_bkg_fit_resid Plot the fit results, and the residuals, for the background of a PHA data set.
plot_bkg_fit Plot the fit results (data, model) for the background of a PHA data set.
plot_bkg_model Plot the model for the background of a PHA data set.
plot_bkg_ratio Plot the ratio of data to model values for the background of a PHA data set.
plot_bkg_resid Plot the residual (data-model) values for the background of a PHA data set.
plot_bkg_source Plot the model expression for the background of a PHA data set.
plot_bkg Plot the background values for a PHA data set.
plot_cdf Plot the cumulative density function of an array of values.
plot_chisqr Plot the chi-squared value for each point in a data set.
plot_data Plot the data values.
plot_delchi Plot the ratio of residuals to error for a data set.
plot_energy_flux Display the energy flux distribution.
plot_fit_delchi Plot the fit results, and the residuals, for a data set.
plot_fit_ratio Plot the fit results, and the ratio of data to model, for a data set.
plot_fit_resid Plot the fit results, and the residuals, for a data set.
plot_fit Plot the fit results (data, model) for a data set.
plot_model_component Plot a component of the model for a data set.
plot_model Plot the model for a data set.
plot_order Plot the model for a data set convolved by the given response.
plot_pdf Plot the probability density function of an array of values.
plot_photon_flux Display the photon flux distribution.
plot_pvalue Compute and plot a histogram of likelihood ratios by simulating data.
plot_ratio Plot the ratio of data to model for a data set.
plot_resid Plot the residuals (data - model) for a data set.
plot_scatter Create a scatter plot.
plot_source_component Plot a component of the source expression for a data set.
plot_source Plot the source expression for a data set.
plot_trace Create a trace plot of row number versus value.
plot Create one or more plot types.
set_xlinear New plots will display a linear X axis.
set_xlog New plots will display a logarithmically-scaled X axis.
set_ylinear New plots will display a linear Y axis.
set_ylog New plots will display a logarithmically-scaled Y axis.

psfs contour_kernel Contour the kernel applied to the model of an image data set.
contour_psf Contour the PSF applied to the model of an image data set.
delete_psf Delete the PSF model for a data set.
get_psf_contour Return the data used by contour_psf.
get_psf_image Return the data used by image_psf.
get_psf_plot Return the data used by plot_psf.
get_psf Return the PSF model defined for a data set.
image_kernel Display the 2D kernel for a data set in the image viewer.
image_psf Display the 2D PSF model for a data set in the image viewer.
load_conv Load a 1D convolution model.
load_psf Create a PSF model.
plot_kernel Plot the 1D kernel applied to a data set.
plot_psf Plot the 1D PSF model applied to a data set.
set_psf Add a PSF model to a data set.
show_kernel Display any kernel applied to a data set.
show_psf Display any PSF model applied to a data set.

saving restore Load in a Sherpa session from a file.
save_all Save the information about the current session to a text file.
save_arrays Write a list of arrays to a file.
save_data Save the data to a file.
save_delchi Save the ratio of residuals (data-model) to error to a file.
save_error Save the errors to a file.
save_filter Save the filter array to a file.
save_grouping Save the grouping scheme to a file.
save_image Save the pixel values of a 2D data set to a file.
save_pha Save a PHA data set to a file.
save_quality Save the quality array to a file.
save_resid Save the residuals (data-model) to a file.
save_staterror Save the statistical errors to a file.
save_syserror Save the systematic errors to a file.
save_table Save a data set to a file as a table.
save Save the current Sherpa session to a file.
script Save every command typed in a Sherpa session to a file.

sherpa sherparc The .sherpa.rc file provides user-configuration options for Sherpa
sherpa Introduction to Sherpa, the CIAO modeling and fitting package

statistics cash A maximum likelihood function.
chi2constvar Chi-square statistic with constant variance computed from the counts data.
chi2datavar Chi-square statistic with variance computed from the data.
chi2gehrels Chi-square statistic with the Gehrels variance function.
chi2modvar Chi-square statistic with variance computed from model amplitudes.
chi2xspecvar Chi-square statistic with variance computed from data amplitudes.
chisquare About the chi-square statistic.
cstat A maximum likelihood function from XSPEC
get_chisqr_plot Return the data used by plot_chisqr.
get_delchi_plot Return the data used by plot_delchi.
get_prior Return the prior function for a parameter (MCMC).
get_sampler_name Return the name of the current MCMC sampler.
get_sampler_opt Return an option of the current MCMC sampler.
get_sampler Return the current MCMC sampler options.
get_stat_name Return the name of the current fit statistic.
get_stat Return the fit statisic.
leastsq Chi-square statistic with variance set to 1.
list_priors Return the priors set for model parameters, if any.
list_samplers List the MCMC samplers.
load_user_stat Create a user-defined statistic.
set_prior Set the prior function to use with a parameter.
set_sampler_opt Set an option for the current MCMC sampler.
set_sampler Set the MCMC sampler.
set_stat Set the statistical method.
wstat A maximum likelihood function from XSPEC

utilities calc_chisqr Calculate the per-bin chi-squared statistic.
calc_data_sum2d Sum up the data values of a 2D data set.
calc_data_sum Sum up the data values over a pass band.
calc_energy_flux Integrate the unconvolved source model over a pass band.
calc_ftest Compare two models using the F test.
calc_kcorr Calculate the K correction for a model.
calc_mlr Compare two models using the Maximum Likelihood Ratio test.
calc_model_sum2d Sum up the convolved model for a 2D data set.
calc_model_sum Sum up the fitted model over a pass band.
calc_photon_flux Integrate the unconvolved source model over a pass band.
calc_source_sum2d Sum up the unconvolved model for a 2D data set.
calc_source_sum Sum up the source model over a pass band.
calc_stat Calculate the fit statistic for a data set.
eqwidth Calculate the equivalent width of an emission or absorption line.
gamma Calculate the Gamma function.
get_analysis Return the units used when fitting spectral data.
get_rate Return the count rate of a PHA data set.
igamc Calculate the complement of the regularized incomplete Gamma function (upper).
igam Calculate the regularized incomplete Gamma function (lower).
incbet Calculate the incomplete Beta function.
lgam Calculate the log (base e) of the Gamma function.
multinormal_pdf The PDF of a multivariate-normal.
multit_pdf The PDF of a multivariate student-t.
sample_energy_flux Return the energy flux distribution of a model.
sample_flux Return the flux distribution of a model.
sample_photon_flux Return the photon flux distribution of a model.
set_analysis Set the units used when fitting and displaying spectral data.
set_default_id Set the default data set identifier.

visualization contour_data Contour the values of an image data set.
contour_fit_resid Contour the fit and the residuals to a data set.
contour_fit Contour the fit to a data set.
contour_model Create a contour plot of the model.
contour_ratio Contour the ratio of data to model.
contour_resid Contour the residuals of the fit.
contour_source Create a contour plot of the unconvolved spatial model.
contour Create a contour plot for an image data set.
get_fit_contour Return the data used by contour_fit.
get_kernel_contour Return the data used by contour_kernel.
get_kernel_image Return the data used by image_kernel.
get_model_contour_prefs Return the preferences for contour_model.
get_model_contour Return the data used by contour_model.
get_model_image Return the data used by image_model.
get_ratio_contour Return the data used by contour_ratio.
get_ratio_image Return the data used by image_ratio.
get_resid_contour Return the data used by contour_resid.
get_resid_image Return the data used by image_resid.
histogram1d Create a 1D histogram from a sequence of samples.
histogram2d Create 2D histogram from a sequence of samples.
image_close Close the image viewer.
image_data Display a data set in the image viewer.
image_deleteframes Delete all the frames open in the image viewer.
image_fit Display the data, model, and residuals for a data set in the image viewer.
image_getregion Return the region defined in the image viewer.
image_open Start the image viewer.
image_ratio Display the ratio (data/model) for a data set in the image viewer.
image_resid Display the residuals (data - model) for a data set in the image viewer.
image_setregion Set the region to display in the image viewer.
image_xpaget Return the result of an XPA call to the image viewer.
image_xpaset Return the result of an XPA call to the image viewer.
rebin Rebin a histogram.