Search http://cxc.harvard.edu/sherpa/ Contact the CXC HelpDesk
Last modified: 13 December 2018

Contextual List of Ahelp Files

Jump to: Main AHELP page | Alphabetical List

confidence | contrib | data | filtering | fitting | info | methods | modeling | models | plotting | psfs | saving | sherpa | statistics | utilities | visualization

Context Topic Summary
confidence conf Estimate confidence intervals for selected thawed parameters based on confidence method
covariance Estimate confidence intervals for selected thawed parameters based on covariance method
get_conf Return information regarding the confidence method.
get_covar Return settings or results for the covariance method.
get_int_proj Return the confidence data defining an interval projection plot
get_int_unc Return the confidence data defining an int_unc() plot
get_proj Return information regarding the projection method.
get_reg_proj Return the confidence data defining a region projection contour plot
get_reg_unc Return the confidence data defining a reg_unc() contour plot
int_proj Create a confidence plot of fit statistic vs. parameter value.
int_unc Create a confidence plot of fit statistic vs. parameter value.
projection Estimate confidence intervals for selected thawed parameters based on projection method
reg_proj Create a confidence contour of fit statistic vs. two thawed parameter values.
reg_unc Create a confidence contour of fit statistic vs. two thawed parameter values.
set_conf_opt Set the options for confidence
set_covar_opt Set the options for covariance
set_proj_opt Set the options for projection
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.
lmod Load a X-Spec local model, compiled with convert_xspec_user_model, into Sherpa
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 by data ID to a new data ID (deep copy)
dataspace1d Create a blank 1D dataset
dataspace2d Create a blank 2D dataset
datastack Sherpa extension package for modeling stacks of data.
delete_data Delete a data set by ID
fake_pha Simulate an observed spectrum based on a theoretical model.
fake Simulate a generic data set with a chosen model and add noise
get_areascal Return the source or background pixel fractional area scale
get_arf_plot Return the data and preferences defining an ARF plot
get_arf Return a source or background ARF by data set ID
get_axes Return the alternate grid of a data set
get_backscal Return the source or background extraction region area
get_bkg_plot Return the data and preferences defining a background plot.
get_bkg_scale Returns the complete background scaling factor
get_bkg Return the background data, ARF, RMF, or model.
get_coord Return the coordinate system of an image
get_counts Return the dependent variable array (e.g., counts) of a data set
get_data_plot Return a plot, contour, or image of the data, or the associated preferences
get_data Return details of a Sherpa data set by ID.
get_dep Return the dependent variable array (e.g., counts) of a data set
get_dims Return the length of the x-dimension of a data set
get_error Return the total errors on the counts of a data set
get_exposure Return the exposure time for a source or background data set
get_grouping Obtain the grouping flags from a data set
get_indep Return the independent variable array of a data set
get_quality Obtain the quality flags from a data set
get_rmf Return a source or background RMF by data set ID
get_specresp Return the effective area of a PHA spectrum
get_staterror Return the statistical errors on the counts of a data set
get_syserror Return the systematic errors on the counts of a data set
group Enable and specify the grouping settings of a spectral data set
load_arf Load a source or background ARF
load_arrays Load data from variables containing arrays.
load_ascii Load ASCII data
load_bkg_arf Load a background ARF
load_bkg_rmf Load a background RMF
load_bkg Load a PHA background spectrum
load_data Load 1D data from a file
load_grouping Load a grouping scheme from a FITS table or ASCII file
load_image Load an image
load_multi_arfs Load multiple ARFs
load_multi_rmfs Load multiple RMFs
load_pha Load PHA source spectra
load_quality Load quality flags from a FITS table or ASCII file
load_rmf Load a source or background RMF
load_staterror Load statistical errors
load_syserror Load systematic errors
load_table Load tabular data
pack_image Pack image data into an IMAGECrate
pack_pha Pack PHA data into a PHACrate
pack_table Pack tabular data into a TABLECrate
set_areascal Set the fractional area
set_arf Set an ARF dataset
set_backscal Set the extraction region area
set_bkg Set a background PHA dataset
set_coord Set the image coordinate system
set_counts Set the dependent variable (e.g. counts) of a dataset
set_data Set a source dataset
set_exposure Set the exposure time
set_grouping Apply user-defined grouping to a dataset
set_quality Apply user-defined quality flags to a data set
set_rmf Set an RMF dataset
set_staterror Set the statistical errors
set_syserror Set the systematic errors
subtract Perform background subtraction
ungroup Ungroup PHA data
unpack_arf Unpack an ARF from an ARFCrate
unpack_arrays Unpack arrays from a CrateData object
unpack_ascii Unpack ASCII data from a crate
unpack_bkg Unpack PHA data from a PHACrate
unpack_data Unpack a table data, ASCII data, or a spectrum from a crate
unpack_image Unpack image data from an IMAGECrate
unpack_pha Unpack PHA data from a PHACrate
unpack_rmf Unpack an RMF from a crate
unpack_table Unpack tabular data from a TABLECrate
unsubtract Undo background subtraction
filtering get_filter Return the filter of a data set
ignore2d_id Apply an exclude region filter to 2-D data by data set ID(s).
ignore2d Apply an exclude region filter to all 2-D data sets
ignore_bad Ignore bins according to quality flags
ignore_id Apply an exclude filter to 1-D data by data set ID
ignore Apply an exclude filter to all 1D data sets
load_filter Load filter from a FITS table, FITS image, or ASCII file
notice2d_id Apply an include filter to 2D data by dataset id
notice2d Apply an include filter to all 2D datasets
notice_id Apply an include filter to 1D data by dataset id
notice Apply an include filter to all 1D datasets
set_filter Apply user-defined filter to a data set
show_filter Display the filters applied to a dataset
fitting calc_stat_info Returns goodness-of-fit statistics associated with a Sherpa data set.
fit Perform a fit using current optimization method and fit statistic.
get_fit Return model fit information associated with a Sherpa data set.
get_stat_info Parses the goodness-of-fit statistic information returned by calc_stat_info()
info get_default_id Return the default data set ID in a Sherpa session.
list_bkg_ids List all background IDs associated with a data set.
list_data_ids List all data set IDs in a Sherpa session.
list_functions List all available Sherpa functions
list_model_ids List all current model IDs.
list_response_ids List all response IDs associated with a data set.
list_stats List all Sherpa fit statistics.
show_all Reports the current state of the Sherpa session
show_bkg_model Display the background convolved model
show_bkg_source Display the background unconvolved model
show_bkg Display PHA background data set information
show_conf Display the confidence information
show_covar Display the covariance information
show_data Display the data sets
show_fit Display the fit information
show_method Display the optimization method
show_model Display the convolved source model
show_proj Display the projection information
show_source Display the unconvolved source model
show_stat Display the fit statistic
methods get_draws Run the pyBLoCXS MCMC-based algorithm using the current sampler.
get_iter_method_name Return the name of the current iterative fitting method
get_iter_method_opt Return the value of the specified option for the current iterative fitting method
get_method Return information on the optimization method
gridsearch Grid searching optimization method
levmar Levenberg-Marquardt optimization method
list_iter_methods List all Sherpa iterative fitting methods.
list_methods List all Sherpa 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 the value of the specified option for the current iterative fitting method
set_iter_method Set the iterative fitting method
set_method_opt Set the options of the chosen optimization method
set_method Set the optimization method
modeling add_model Add a user-defined model class as a Sherpa model type
add_user_pars Add parameters to a user-defined model
clean Erase data and model settings in a Sherpa session
create_model_component Create a new model component
delete_bkg_model Delete a background model
delete_model_component Delete a model component
delete_model Delete a Sherpa model by model ID
freeze Freeze model parameters, so they do not vary during a fit.
get_model_autoassign_func Return the method for storing model identifiers
get_model_component_image Returns the 2D data and coordinate settings defining the convolved model component image
get_model_component_plot Returns the data and preferences defining the convolved model component plot
get_model_component Returns the parameters for the specified model component
get_model_plot Return a plot, contour, or image of a model, or the associated preferences
get_model Return the model, model parameters, or model type
get_num_par Returns the number of parameters (total, frozen, or thawed) in a model.
get_order_plot Return the data and preferences defining a plot of model spectral orders
get_par Returns a model parameter.
get_pileup_model Return the pileup model associated with a data set.
get_response Get the associated instrument response model of a PHA data set by data ID
get_source_component_image Returns the 2D data and coordinate settings defining the unconvolved model component image
get_source_component_plot Returns the data and preferences defining the unconvolved model component plot
get_source Return the unconvolved model associated with a Sherpa data set ID.
guess Estimate initial parameter values and ranges
image_model_component Sends image of the convolved model component to ds9.
image_model Send image of the model to ds9.
image_source_component Sends image of the unconvolved model component to ds9.
image_source Image the 2-D unconvolved model
integrate1d <Integrate1D model type>
integrate Controlling the integration of model components
link Link a model parameter to another model parameter.
load_table_model Load a table model, including X-Spec atable and mtable forms
load_template_model Load a set of template models
load_user_model Load a user-defined model
normal_sample Sample the current set of thawed parameters from a uni-variate or multi-variate normal distribution.
paramprompt Toggle parameter prompting for initial model values
reset Reset model parameter values after a fit
save_model Save the convolved source model to a FITS table or ASCII file
save_source Save the unconvolved source model to a FITS table or ASCII file
set_bkg_model Set a background model expression
set_full_model Set the complete convolved source and background model expressions to be used for fitting a data set
set_model_autoassign_func Define a method for storing model identifiers
set_par Set initial values for a model parameter
set_pileup_model Set a pileup model to be used in fitting a dataset
set_source Set the source model expression to be used for fitting a dataset
set_xsabund Set XSPEC solar abundance
set_xscosmo Set XSPEC cosmology settings (H0, q0, L0)
set_xsxsect Set XSPEC photoelectric cross-section
set_xsxset Set and get environment variables for XSPEC models
thaw Thaw model parameters so they vary during a fit
t_sample Sample the current set of thawed parameters from a Student's t-distribution.
uniform_sample Sample the current set of thawed parameters from a uniform distribution.
unlink Remove a link between model parameters
models absorptionedge Optical model of an absorption edge.
absorptiongaussian Gaussian function for modeling absorption (equivalent width).
absorptionlorentz Lorentz function for modeling absorption (equivalent width).
absorptionvoigt Voigt 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.
emissionvoigt Voigt 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 all Sherpa models.
list_model_components List all models established in a Sherpa session.
lmc LMC extinction: the Howarth model.
load_xscflux calculate flux. XSpec convolution model *Experimental*.
load_xsclumin calculate luminosity. XSpec convolution model *Experimental*.
load_xscpflux calculate photon flux. XSpec convolution model *Experimental*.
load_xsgsmooth gaussian smoothing. XSpec convolution model *Experimental*.
load_xsireflect reflection from ionized material. XSpec convolution model *Experimental*.
load_xskdblur2 convolve with the laor2 model shape. XSpec convolution model *Experimental*.
load_xskdblur convolve with the laor model shape. XSpec convolution model *Experimental*.
load_xskerrconv accretion disk line shape with BH spin as free parameter. XSpec convolution model *Experimental*.
load_xslsmooth lorentzian smoothing. XSpec convolution model *Experimental*.
load_xspartcov partial covering. XSpec convolution model *Experimental*.
load_xsrdblur convolve with the dislkine model shape. XSpec convolution model *Experimental*.
load_xsreflect reflection from neutral material. XSpec convolution model *Experimental*.
load_xsrfxconv angle-dependent reflection from an ionized disk. XSpec convolution model *Experimental*.
load_xsrgsxsrc convolve an RGS spectrum for extended emission. XSpec convolution model *Experimental*.
load_xssimpl comptonization of a seed spectrum. XSpec convolution model *Experimental*.
load_xsvashift Velocity shift an additive model. XSpec convolution model *Experimental*.
load_xsvmshift Velocity shift a multiplicative model. XSpec convolution model *Experimental*.
load_xsxilconv angle-dependent reflection from an ionized disk XSpec convolution model *Experimental*.
load_xszashift Redshift an additive model. XSpec convolution model *Experimental*.
load_xszmshift Redshift a multiplicative model. XSpec convolution model *Experimental*.
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.
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 Schecter 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.
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.
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.
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.
xsconvolve The XSpec convolution models *Experimental*.
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.
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.
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.
xskerrbb The XSPEC kerrbb model: multi-temperature blackbody model for thin accretion disk around a Kerr black hole.
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.
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.
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.
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.
xsraymond The XSPEC raymond model: emission, hot diffuse gas, Raymond-Smith.
xsredden The XSPEC redden model: interstellar extinction.
xsredge The XSPEC redge model: emission, recombination edge.
xsrefsch The XSPEC refsch model: reflected power law from ionized accretion disk.
xsrnei The XSPEC rnei model: non-equilibrium recombining collisional plasma.
xssedov The XSPEC sedov model: sedov model, separate ion/electron temperature.
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.
xsvbremss The XSPEC vbremss model: thermal bremsstrahlung.
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).
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.
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.
xszbabs The XSPEC zbabs model: EUV ISM attenuation
xszbbody The XSPEC zbbody model: blackbody spectrum.
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.
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_energy_flux_hist Calculate a histogram of a simulated energy flux probability distribution
get_lrt_plot Access a histogram plot of likelihood ratio test results.
get_lrt_results Access the simulation results of the likelihood ratio test.
get_photon_flux_hist Calculate a histogram of a simulated photon flux probability distribution
get_pvalue_plot Access a histogram plot of likelihood ratio test results.
get_pvalue_results Access the simulation results of the likelihood ratio test.
get_split_plot Return plot attributes for multiple plots
plot_arf Plot an ARF
plot_bkg Plot information about background data
plot_cdf Plot a cumulative distribution function with lower, median, and upper quantiles.
plot_chisqr Plot the chi-squared statistic
plot_data Plot the dataset
plot_delchi Plot the delchi residuals of the fit: (data-model)/error
plot_energy_flux Plot the calculated energy flux distribution
plot_fit Plot the fit, fit plus delta chi, or fit plus residuals
plot_model_component Plots individual convolved source model components
plot_model Plot the convolved source model
plot_order Plot the convolved source model by order
plot_pdf Plot a binned probability density function.
plot_photon_flux Plot the calculated photon flux distribution
plot_pvalue Plot a histogram of likelihood ratio test results.
plot_ratio Plot the (data/model) ratio
plot_resid Plot the residuals of the fit: (data - model)
plot_scatter Create an X,Y scatter plot.
plot_source_component Plots individual unconvolved source model components
plot_source Plot the unconvolved source model
plot_trace Create a trace plot of iteration number vs. sampled value.
plot Plot multiple objects (data, model, residuals, etc.)
set_xlinear Changes the plot X axis to use a linear scale.
set_xlog Changes the plot x axis to use a logarithmic scale.
set_ylinear Changes the plot Y axis to use a linear scale.
set_ylog Changes the plot Y axis to use a logarithmic scale.
psfs contour_kernel Create a contour plot of a PSF kernel
contour_psf Create a contour plot of a PSF
delete_psf Delete a PSF model
get_kernel Return kernel plot, image, and contour preferences.
get_psf Return PSF model data and plot, image, and contour preferences.
image_kernel Send a PSF kernel image to the imager (ds9).
image_psf Send a PSF image to the imager (ds9).
load_conv Load a 1D convolution kernel
load_psf Load a PSF model
plot_kernel Plot the PSF kernel
plot_psf Plot the PSF
set_psf Convolve the PSF model with the source model
show_kernel Display the PSF kernel
show_psf Display the PSF model
saving restore Restore a previous Sherpa session from a file
save_all Save all the information about the current session
save_arrays Save a list of arrays as columns to a FITS table or ASCII file
save_data Save a Sherpa data set to an ASCII file.
save_delchi Save the delta chi fit residuals to a FITS table or ASCII file
save_error Save total errors to a FITS table or ASCII file
save_filter Save filter to a FITS table or ASCII file
save_grouping Save grouping flags to a FITS table or ASCII file
save_image Save image data to a file
save_pha Save a Sherpa data set to a PHA file.
save_quality Save quality flags to a FITS table or ASCII file
save_resid Save the simple data-model difference residuals
save_staterror Save statistical errors to a FITS table or ASCII file
save_syserror Save systematic errors to a FITS table or ASCII file
save_table Save a Sherpa data set to a FITS or ASCII file.
save Save the current Sherpa session to a file
script Save every command typed in a Sherpa or ChIPS 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 and preferences defining a chi^2 plot
get_delchi_plot Return the data and preferences defining a delta chi plot
get_prior Access the prior function associated with a Sherpa model parameter.
get_sampler Return information on the current pyBLoCXS sampler.
get_stat Return information on the fit statistic
leastsq Chi-square statistic with variance set to 1.
list_priors List thawed Sherpa model parameters with associated priors.
list_samplers List all available pyBLoCXS samplers.
load_user_stat Load a user-defined fit statistic
set_prior Define a prior function for a particular Sherpa model parameter.
set_sampler_opt Define sampler options for a pyBLoCXS chain.
set_sampler Set the current pyBLoCXS sampler.
set_stat Set the statistical method
wstat A maximum likelihood function from XSPEC
utilities calc_chisqr Calculate the Chi Squared statistic contribution per bin
calc_data_sum2d Calculate the sum of observed image counts
calc_data_sum Calculate the sum of observed data counts
calc_energy_flux Calculate the unconvolved model energy flux
calc_ftest Calculate the significance using the F test
calc_kcorr Calculate the k correction for a spectral model.
calc_mlr Calculate the Maximum Likelihood Ratio test
calc_model_sum2d Calculate the convolved 2D model amplitudes
calc_model_sum Calculate the sum of convolved model counts
calc_photon_flux Calculate the unconvolved model photon flux
calc_source_sum2d Calculate the unconvolved 2D model amplitudes
calc_source_sum Calculate the sum of unconvolved model amplitudes
calc_stat Calculate the fit statistic by data set ID
eqwidth Calculate the equivalent width of an emission or absorption line.
gamma Calculate the Gamma function
get_analysis Return the current units setting for a PHA data set
get_rate Return the measured count rate of a 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 of the Gamma function
sample_energy_flux Sample the energy flux distribution
sample_flux Return a sample of Sherpa model parameters and the corresponding unabsorbed energy flux and flux uncertainty
sample_photon_flux Sample the photon flux distribution
set_analysis Set the units for spectral analysis
set_default_id Set the default Sherpa data id
visualization contour_data Open a contour plot of a data set in ChIPS
contour_fit_resid Create a contour plot of the fit and residuals
contour_fit Send a contour plot of the fit
contour_model Open a contour plot of a data set model in ChIPS
contour_ratio Open a contour plot of a data-to-model ratio in ChIPS
contour_resid Open a contour plot of data-minus-model residuals in ChIPS
contour_source Create a contour plot of the source
contour Open a contour plot in ChIPS
get_ratio Return information on the ratio of data and model.
get_resid Return information on a contour plot of the residuals of data and model.
histogram1d Create a 1D histogram from a binned grid and array of samples
histogram2d Create a 2D histogram from a pair of axes and a pair of sample arrays
image_close Close the imager window (i.e., exit ds9).
image_data Send image of 2-D data to ds9.
image_deleteframes Delete frames in the imager window (ds9).
image_fit Send image of the fit results to ds9.
image_getregion Returns a region description from ds9.
image_open Open the imager window (i.e., start ds9).
image_ratio Send image of the ratio (i.e., data/model) to ds9.
image_resid Send image of the residuals (i.e., data - model) to ds9.
image_setregion Sends a region description to ds9, where it is drawn in the current frame.
image_xpaget Retrieve data from ds9 using XPA.
image_xpaset Send data to ds9 using XPA.
rebin Rebin a histogram
Jump to: Main AHELP page | Alphabetical List