Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: 15 December 2016

Contextual List of Ahelp Files


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_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
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
sherpa_chart Create and view spectral files for ChaRT2 (CIAO contributed package).
sherpa_contrib Contributed CIAO routines for Sherpa.
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 Helper function to control the integration of 1D non-XSPEC model expressions
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 defined in Angstroms.
absorptiongaussian A Gaussian model of an absorption feature expressed in equivalent width and defined in Angstroms.
absorptionlorentz A Lorentz model of an absorption feature expressed in equivalent width and defined in Angstroms.
absorptionvoigt A Voigt model of an absorption feature defined in Angstroms.
accretiondisk A model of emission due to an accretion disk.
atten Attenuation by ISM.
bbodyfreq Blackbody as a function of frequency.
bbody Blackbody as a function of energy.
beta1d 1-D Lorentz model with a varying power law.
beta2d 2-D Lorentz model with a varying power law.
blackbody Blackbody function
box1d 1-D box function.
box2d 2-D box function.
bpl1d Broken power law function.
bremsstrahlung Bremsstrahlung function
brokenpowerlaw Broken power-law function
ccm Interstellar extinction function
const1d 1-D constant amplitude model.
const2d 2-D constant amplitude model.
cos Cosine function.
delta1d 1-D delta function.
delta2d 2-D delta function.
dered Dereddening function.
devaucouleurs2d DeVaucouleurs profile.
disk2d Uniform 2-D Disk model.
edge Photoabsorption edge model.
emissiongaussian A Gaussian model of an emission feature defined in Angstroms.
emissionlorentz A Lorentz model of an emission feature defined in Angstroms.
emissionvoigt Voigt model of an emission feature defined in Angstroms.
erfc A 1-D complementary error function.
erf A 1-D error function.
exp10 Exponential function, base 10.
exp Exponential function.
fm Fitzpatrick and Massa extinction curve
gauss1d 1-D unnormalized Gaussian function.
gauss2d 2-D unnormalized Gaussian function.
hubblereynolds Hubble-Reynolds profile.
jdpileup A CCD pileup model developed by John Davis of MIT.
linebroad Line-broadening profile.
list_models List all Sherpa models.
list_model_components List all models established in a Sherpa session.
lmc Extinction curve for the Large Magellanic Cloud
load_xscflux calculate 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_xssimpl comptonization of a seed spectrum. 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 Logarithm function, base 10.
logabsorption Logarithmic Gaussian absorption model expressed in optical depth and defined in Angstroms.
logemission Logarithmic Gaussian emission model defined in Angstroms.
logparabola Log-parabolic function
log Natural logarithm function.
lorentz1d 1-D normalized Lorentzian function.
lorentz2d 2-D unnormalized Lorentzian function.
models Summary of Available Models
normbeta1d 1-D normalized beta function.
normgauss1d 1-D normalized Gaussian function.
normgauss2d 2-D normalized Gaussian function.
opticalgaussian Gaussian model of an absorption feature expressed in optical depth and defined in Angstroms.
poisson Poisson function.
polynom1d 1-D polynomial function.
polynom2d 2-D polynomial function.
polynomial 1-D polynomial function of order <= 5
powerlaw Power law function
powlaw1d 1-D power law.
recombination Model of continuum emission due to recombination
scale1d 1-D constant amplitude model.
scale2d 2-D constant amplitude model.
schechter Schechter function.
seaton Galactic extinction model
sersic2d Sersic 2D surface brightness model.
shell2d Homogeneous spherical shell, projected along the z-direction.
sigmagauss2d 2-D unnormalized Gaussian function with independent axis parameterized by sigma.
sin Sine function.
smc Extinction curve for the Small Magellanic Cloud
sm Galactic extinction curve
sqrt Square root function.
stephi1d 1-D step function.
steplo1d 1-D step function.
tablemodel Using an n-dimensional array of values as a model (table model).
tan Tangent function.
xgal Extragalactic extinction function
xsabsori Ionized absorber. XSPEC model.
xsacisabs Decay in the ACIS quantum efficiency. XSPEC model.
xsagauss Gaussian line profile in wavelength space. XSPEC model.
xsapec APEC thermal plasma model. XSPEC model.
xsbapec APEC thermal plasma model with velocity broadening as a free parameter. XSPEC model.
xsbbodyrad Blackbody spectrum with norm proportional to surface area. XSPEC model.
xsbbody Blackbody spectrum. XSPEC model.
xsbexrav E-folded broken power law reflected from neutral matter. XSPEC model.
xsbexriv E-folded broken power law reflected from ionized matter. XSPEC model.
xsbkn2pow Broken power law, two break energies. XSPEC model.
xsbknpower Broken power law. XSPEC model.
xsbmc Comptonization by relativistically moving matter. XSPEC model.
xsbremss Thermal bremsstrahlung. XSPEC model.
xsbvapec APEC thermal plasma model with variable abundances and velocity broadening as a free parameter. XSPEC model.
xsbvvapec APEC thermal plasma model with variable abundances and velocity broadening as a free parameter. XSPEC model.
xsc6mekl 6th-order Chebyshev polynomial DEM using mekal. XSPEC model.
xsc6pmekl Exponential of 6th-order Chebyshev polynomial DEM using mekal. XSPEC model.
xsc6pvmkl Variable abundance version of c6pmekl. XSPEC model.
xsc6vmekl Variable abundance version of xsc6mekl. XSPEC model.
xscabs Compton scattering (non-relativistic). XSPEC model.
xscemekl Multi-temperature mekal. XSPEC model.
xscevmkl Multi-temperature vmeka. XSPEC model.
xscflow Cooling flow model. XSPEC model.
xscompbb Comptonized blackbody spectrum after Nishimura et al. (1986). XSPEC model.
xscompls Comptonization spectrum after Lamb and Sanford (1979). XSPEC model.
xscompmag Thermal and bulk Comptonization for cylindrical accretion onto the polar cap of a magnetized neutron star. XSPEC model.
xscompps Comptonization, Poutanen and Svenson. XSPEC model.
xscompst Comptonization spectrum after Sunyaev and Titarchuk (1980). XSPEC model.
xscomptb Thermal and bulk Comptonization of a seed blackbody-like spectrum. XSPEC model.
xscompth Component of Paolo Coppi's hybrid (thermal/non-thermal) hot plasma emission models.
xscomptt Comptonization spectrum after Titarchuk (1994). XSPEC model.
xsconstant Energy-independent multiplicative factor. XSPEC model.
xsconvolve The XSpec convolution models *Experimental*.
xscplinear Non-physical piecewise-linear model for low count background spectra. XSPEC model.
xscutoffpl Power law with high energy exponential cutoff. XSPEC model.
xscyclabs Cyclotron absorption line. XSPEC model.
xsdiskbb Multiple blackbody disk model. XSPEC model.
xsdiskir Irradiated inner and outer disk. XSPEC model.
xsdiskline Line emission from relativistic accretion disk. XSPEC model.
xsdiskm Disk model with gas pressure viscosity. XSPEC model.
xsdisko Modified blackbody disk model. XSPEC model.
xsdiskpbb Accretion disk, power-law dependence for T(r). XSPEC model.
xsdiskpn Accretion disk around a black hole. XSPEC model.
xsdisk Disk model. XSPEC model.
xsdust Dust scattering out of the beam. XSPEC model.
xsedge Absorption edge. XSPEC model.
xseplogpar Log-parabolic blazar model with nu Fu normalization. XSPEC model.
xseqpair Component of Paolo Coppi's hybrid (thermal/non-thermal) hot plasma emission models
xseqtherm Component of Paolo Coppi's hybrid (thermal/non-thermal) hot plasma emission models
xsequil Equilibrium ionization collisional plasma model from Borkowski. XSPEC model.
xsexpabs Low-energy exponential cutoff. XSPEC model.
xsexpdec An exponential decay. XSPEC model.
xsexpfac Exponential factor. XSPEC model.
xsezdiskbb Multiple blackbody disk model with zero-torque inner boundary. XSPEC model.
xsgabs A multiplicative gaussian absorption line. XSPEC model.
xsgadem Plasma emission, multi-temperature with gaussian distribution of emission measure. XSPEC model.
xsgaussian Simple gaussian line profile. XSPEC model.
xsgnei Generalized single ionization NEI plasma model. XSPEC model.
xsgrad GR accretion disk around a black hole. XSPEC model.
xsgrbm Gamma-ray burst model. XSPEC model.
xsheilin Voigt absorption profiles for He I series. XSPEC model.
xshighecut High energy cutoff. XSPEC model.
xshrefl Simple reflection model good up to 15 keV. XSPEC model.
xskerrbb Multi-temperature blackbody model for thin accretion disk around a Kerr black hole. XSPEC model.
xskerrdisk Accretion disk line emission with BH spin as free parameter. XSPEC model.
xskerrd Optically thick accretion disk around a Kerr black hole. XSPEC model.
xslaor2 Accretion disk with broken-power law emissivity profile, black hole emission line. XSPEC model.
xslaor Line from accretion disk around a black hole. XSPEC model.
xslogpar Log-parabolic blazar model. XSPEC model.
xslorentz Lorentzian line profile. XSPEC model.
xslyman Voigt absorption profiles for H I or He II Lyman series XSPEC model.
xsmekal Mewe-Kaastra-Liedahl thermal plasma (1995). XSPEC model.
xsmeka Mewe-Gronenschild-Kaastra thermal plasma (1992). XSPEC model.
xsmkcflow Cooling flow model based on mekal. XSPEC model.
xsnei Simple nonequilibrium ionization plasma model. XSPEC model.
xsnotch Notch line absorption. XSPEC model.
xsnpshock Plane-parallel shock with ion and electron temperatures. XSPEC model.
xsnsagrav NS H atmosphere model for different g. XSPEC model.
xsnsatmos NS Hydrogen Atmosphere model with electron conduction and self-irradiation. XSPEC model.
xsnsa Spectra in the X-ray range (0.05-10 keV) emitted from a hydrogen atmosphere of a neutron star. XSPEC model.
xsnsmaxg Neutron star with a magnetic atmosphere. XSPEC model.
xsnsmax Neutron Star Magnetic Atmosphere. XSPEC model.
xsnsx Neutron Star with a non-magnetic atmosphere. XSPEC model.
xsnteea Pair plasma model. XSPEC model.
xsnthcomp Thermally comptonized continuum. XSPEC model.
xsoptxagnf Color-temperature-corrected disc and energetically coupled Comptonization model for AGN. XSPEC model.
xsoptxagn Color-temperature-corrected disc and energetically coupled Comptonization model for AGN. XSPEC model.
xspcfabs Partial covering fraction absorption. XSPEC model.
xspegpwrlw Power law with pegged normalization. XSPEC model.
xspexmon Neutral Compton reflection with self-consistent Fe and Ni lines. XSPEC model.
xspexrav Exponentially cutoff power law reflected from neutral matter. XSPEC model.
xspexriv Exponentially cutoff power law reflected from ionized matter. XSPEC model.
xsphabs Photo-electric absorption. XSPEC model.
xsplabs Absorption model with power law dependence on energy. XSPEC model.
xsplcabs Cutoff power law observed through dense, cold matter. XSPEC model.
xsposm Positronium continuum. XSPEC model.
xspowerlaw Simple photon power law. XSPEC model.
xspshock Constant temperature, plane-parallel shock plasma model. XSPEC model.
xspwab An extension of partial covering fraction absorption into a power-law distribution of covering fraction. XSPEC model.
xsraymond Raymond-Smith thermal plasma. XSPEC model.
xsredden IR/optical/UV extinction from Cardelli et al. (1989). XSPEC model.
xsredge Recombination edge. XSPEC model.
xsrefsch E-folded power law reflected from an ionized relativistic disk. XSPEC model.
xsrnei Non-equilibrium recombining collisional plasma model. XSPEC model.
xssedov Sedov model with electron and ion temperatures. XSPEC model.
xssirf Self-irradiated funnel. XSPEC model.
xssmedge Smoothed absorption edge. XSPEC model.
xsspexpcut Super-exponential cutoff absorption. XSPEC model.
xsspline Spline multiplicative factor. XSPEC model.
xssrcut Synchrotron radiation from cutoff electron distribution. XSPEC model.
xssresc Synchrotron radiation from escape-limited electron distribution. XSPEC model.
xssss_ice Einstein SSS ice absorption. XSPEC model.
xsstep Step function convolved with gaussian. XSPEC model.
xsswind1 Absorption by partially ionized material with large velocity shear. XSPEC model.
xstbabs Calculates the absorption of X-rays by the ISM. XSPEC model.
xstbgrain Calculates the absorption of X-rays by the ISM with variable hydrogen to H2 ratio and grain parameters. XSPEC model.
xstbvarabs Calculates the absorption of X-rays by the ISM, allowing user to vary all abundances, depletion factors, and grain properties. XSPEC model.
xsuvred UV reddening. XSPEC model.
xsvapec APEC thermal plasma model with variable abundances. XSPEC model.
xsvarabs Photoelectric absorption with variable abundances. XSPEC model.
xsvbremss Thermal bremsstrahlung spectrum with variable H/He. XSPEC model.
xsvequil Ionization equilibrium collisional plasma model with variable abundances. XSPEC model.
xsvgadem Plasma emission, multi-temperature with gaussian distribution of emission measure. XSPEC model.
xsvgnei Non-equilibrium ionization collisional plasma model with variable abundances. XSPEC model.
xsvmcflow Cooling flow model based on vmekal. XSPEC model.
xsvmekal Mewe-Kaastra-Liedahl thermal plasma with variable abundances. XSPEC model.
xsvmeka Mewe-Gronenschild-Kaastra thermal plasma with variable abundances. XSPEC model.
xsvnei Non-equilibrium ionization collisional plasma model with variable abundances. XSPEC model.
xsvnpshock Plane-parallel shock plasma model with separate ion and electron temperatures and variable abundances. XSPEC model.
xsvphabs Photoelectric absorption with variable abundances. XSPEC model.
xsvpshock Constant temperature, plane-parallel shock plasma model with variable abundances. XSPEC model.
xsvraymond Raymond-Smith thermal plasma with variable abundances. XSPEC model.
xsvrnei Non-equilibrium recombining collisional plasma model with variable abundances. XSPEC model.
xsvsedov Sedov model with separate ion and electron temperatures and variable abundances. XSPEC model.
xsvvapec APEC thermal plasma model with variable abundances. XSPEC model.
xsvvgnei Non-equilibrium ionization collisional plasma model with variable abundances for all elements with Z <= 30. XSPEC model.
xsvvnei Non-equilibrium ionization collisional plasma model with variable abundances for all elements with Z <= 30. XSPEC model.
xsvvnpshock Plane-parallel shock plasma model with separate ion and electron temperatures and variable abundances for all elements with Z <= 30. XSPEC model.
xsvvpshock Constant temperature, plane-parallel shock plasma model with variable abundances for all elements with Z <= 30. XSPEC model.
xsvvrnei Non-equilibrium recombining collisional plasma model with variable abundances for all elements with Z <= 30. XSPEC model.
xsvvsedov Sedov model with separate ion and electron temperatures and variable abundances for all elements with Z <= 30. XSPEC model.
xswabs Photoelectric absorption (Morrison and McCammon). XSPEC model.
xswndabs Photoelectric absorption with low energy window. XSPEC model.
xsxion Reflected spectra of a photo-ionized accretion disk or ring. XSPEC model.
xszagauss Redshifted gaussian line profile in wavelength space. XSPEC model.
xszbabs EUV ISM attenuation XSPEC model.
xszbbody Redshifted blackbody. XSPEC model.
xszbremss Redshifted thermal bremsstrahlung. XSPEC model.
xszdust Extinction by dust grains. XSPEC model.
xszedge Redshifted absorption edge. XSPEC model.
xszgauss Redshifted gaussian. XSPEC model.
xszhighect Redshifted high energy cutoff. XSPEC model.
xszigm UV/Optical attenuation by the intergalactic medium.
xszpcfabs Redshifted partial covering absorption. XSPEC model.
xszphabs Redshifted photoelectric absorption. XSPEC model.
xszpowerlw Redshifted power law. XSPEC model.
xszredden Redshifted version of redden. XSPEC model.
xszsmdust Extinction by dust grains in starburst galaxies. XSPEC model.
xsztbabs Calculates the absorption of X-rays by the ISM for modeling redshifted absorption. Does not include a dust component. XSPEC model.
xszvarabs Redshifted photoelectric absorption with variable abundances. XSPEC model.
xszvfeabs Redshifted photoelectric absorption with free Fe edge energy. XSPEC model.
xszvphabs Redshifted photoelectric absorption with variable abundances. XSPEC model.
xszwabs Redshifted "Wisconsin absorption." XSPEC model.
xszwndabs Redshifted photoelectric absorption with low energy window. XSPEC model.
xszxipcf Partial covering absorption by partially ionized material. XSPEC model.
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

Last modified: 15 December 2016
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxcweb@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.