xset

set variables for XSPEC models

Modify a number of XSPEC internal switches.

Syntax: xset [abund |cosmo |delta | mdatadir |method |seed |statistic |usechainrule |weight |xsect |<string_name>] [ <options>|<string_value>]

The arguments abund, cosmo, method, statistic, weight, and xsect just run the appropriate XSPEC commands. mdatadir changes the directory in which XSPEC searches for model data files. You probably don't want to change this. The seed option requires an integer argument, which will then be used to immediately re-seed and re-initialize XSPEC's random-number generator.

The delta option is for setting fit delta values (see the newpar command) which are proportional to the current parameter value rather than fixed. For example,

XSPEC12> xset delta .15

will set each parameter fit delta to .15 * parVal. To turn proportional deltas off and restore the original fixed deltas, set delta to a negative value or 0.0. The current proportional delta setting can be seen with show control.

The usechainrule option can be used to switch between the fast (usechainrule yes) and slow (usechainrule no) options when calculating the derivatives of the fit statistic.

The <string_name> option can be used to pass string values to models. XSPEC maintains a database of <string_name>, <string_value> pairs created using this command. Individual model functions can then access this database. Note that xset does no checking on whether the <string_name> is used by any model so spelling errors will not be trapped.

To access the <string_name>, <string_value> database from within a model function use the fortran function fgmstr. This is defined as character*128 and takes a single argument, the string name as a character*128. If the <string_name> has not been set then a blank string will be returned.

The current <string_name> options, models to which they apply and brief descriptions are given in the following table :

APECROOT	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)mekal, mkcflow, nlapec, t(v)(v)apec, vmcflow	Switch from default APEC input files.
APECTHERMAL	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Thermally broaden emission lines in APEC input files.
APECVELOCITY	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Velocity broaden emission lines in APEC input files.
APECMINFLUX	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Set minimum flux for line broadening.
APECBROADPSEUDO	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Broaden pseudo-continuum lines.
APECNOLINES	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Continuum only.
APEC_TRACE_ABUND	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Set trace element abundances.
APECLOGINTERP	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Use logarithmic interpolation between tabulated temperatures.
APECUSENEI	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)mekal, mkcflow, nlapec, t(v)(v)apec, vmcflow	Use NEI code to calculate CEI spectra.
APECMULTITHREAD	(v)(v)apec, b(v)(v)apec, b(v)(v)tapec, c6(v)mekl, c6p(v)mekl, ce(v)mkl, (v)equil, (v)mekal, mkcflow, nlapec, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov, t(v)(v)apec, vmcflow	Parallelize over temperatures when calculating the lines in the spectrum.
NEIAPECROOT	(v)equil, (v)gnei, (v)nei, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov	Switch from default NEIAPEC input files.
NEIVERS	(v)equil, (v)gnei, (v)nei, (v)npshock, (v)pshock, (v)(v)rnei, (v)sedov	Set version of NEI calculations.
POW_EMIN, POW_EMAX	powerlaw, bknpower, bkn2pow, cutoffpl	Switch to normalize to a flux calculated over an energy range.
NEIVERS	gnei, nei, vgnei, vnei, equil, vequil, npshock, vnpshock, pshock, vpshock, sedov, vsedov	Switch NEIAPEC version number.
CFLOW_VERSION	mkcflow, vmclow	Switch CFLOW version number.
CFLOW_NTEMPS	mkcflow, vmclow	Switch number of temperature bins used in CFLOW model.
SUZPSF-IMAGE	suzpsf	Set image file to be used for surface brightness.
SUZPSF-RA	suzpsf	Set RA for center surface brightness map which is taken from the WMAP.
SUZPSF-DEC	suzpsf	Set Dec for center surface brightness map which is taken from the WMAP.
SUZPSF-MIXFACT-IFILE#	suzpsf	Set filename to read mixing factors.
SUZSF-MIXFACT-OFILE#	suzpsf	Set filename to write mixing factors.
XMMPSF-IMAGE	xmmpsf	Set image file to be used for surface brightness.
XMMPSF-RA	xmmpsf	Set RA for center surface brightness map which is taken from the WMAP.
XMMPSF-DEC	xmmpsf	Set Dec for center surface brightness map which is taken from the WMAP.
XMMPSF-MIXFACT-IFILE#	xmmpsf	Set filename to read mixing factors.
XMMPSF-MIXFACT-OFILE#	xmmpsf	Set filename to write mixing factors.
NSA_FILE	nsa	Change filename used for model data.
NSAGRAV_DIR	nsagrav	Change directory used for model data files.
NSMAX_DIR	nsmax	Change directory used for model data files.
ZXIPCF_DIR	zxipcf	Change directory used for model data files.

Examples:

XSPEC12> xset neivers 2.0
   // Set the NEIVERS variable to 2.0
XSPEC12> xset 
   // List the current string variables
XSPEC12> xset apecroot /foo/bar/apec_v1.01
   // Set the APECROOT variable
XSPEC12> xset seed 1515151
   // Re-initialize the pseudo random-number generator
   // with the seed value 1515151