Skip to main content

Come analyze HEASARC, IRSA, and MAST data in the cloud! The Fornax Initiative is now welcoming all interested beta users.

Xspec Home Page

next up previous contents
Next: Initializing the Models Library Up: Using the XSPEC Models Previous: Calling Model Functions From   Contents

Interface Routines

XSPEC also provides a set of functions for accessing some of the model functions' internal data. The C++ functions are listed in the file FunctionUtility.h in the XSFunctions/Utilities directory. For C and Fortran access, equivalent wrapper functions are listed in the same directory in xsFortran.h. The wrapper functions have C-style function declarations, and are also made available to Fortran calling routines via the CERN <cfortran.h> interface.

The currently provided C/Fortran wrapper functions are (see xsFortran.h for the function signatures):

FNINIT Initializes data directory locations needed by the models. See below for a fuller description.
FGABND Get an element abundance.
FGCHAT Get current chatter level setting for model functions' output verbosity.
FPCHAT Set the chatter level. Default is 10, higher chatter levels produce more output.
FGDATD Get the model .dat files path.
FPDATD Set the model .dat files path.
FGMODF Get the model ion data path.
FGMSTR Get a model string value (see XSPEC xset command).
FPMSTR Set a model string value.
FPSLFL Load values of a file solar abundance table (see abund command).
FGSOLR Get the solar abundance table setting.
FPSOLR Set the solar abundance table.
FGXSCT Get the cross section table setting.
FPXSCT Set the cross section table.
RFLABD Read abundance data from a file, then load and set this to be the current abundance table. (Essentially this combines a file read with the FPSLFL and FPSOLR functions.)
csmgh0 Get the cosmology H$_0$ setting (see the cosmo command).
csmph0 Set H$_0$.
csmgl0 Get $\Lambda_0$.
csmpl0 Set $\Lambda_0$.
csmgq0 Get q$_0$.
csmpq0 Put q$_0$.
fzsq Computes the luminosity distance, (c/H$_0$)*fzsq. The function is valid for small values of q$_0$*z for the case of no cosmological constant and uses the approximation of Pen (1999 ApJS 120, 49) for the case of a cosmological constant and a flat Universe. The function is not valid for non-zero cosmological constant if the Universe is not flat.
DGFILT Get a particular XFLT keyword value from a data file.
DGNFLT Get the number of XFLT keywords in a data file.
xs_getVersion (or xgvers) Retrieve XSPEC's version string.

next up previous contents
Next: Initializing the Models Library Up: Using the XSPEC Models Previous: Calling Model Functions From   Contents