|
New issues from Xspec 12.3.0
Frequently Asked Questions
All users: If you receive the following message on start-up:
XSPEC not properly installed - cannot find manager, script, or help directory
You may need to add READ access for Other to the files in the directory $HEADAS/../spectral/help:
cd $HEADAS/../spectral
chmod o+r,o+x help
cd help
chmod o+r *
Cygwin users: Version 12.3.0 is the first Xspec12 release to offer support
for Windows users through Cygwin. However it requires that all of Xspec's libraries
be built statically, including users' local models libraries. Therefore the usual
initpackage and lmod commands won't work for building and loading
local model libraries at runtime. Cygwin users with local model libraries should
consult the static_initpackage section of the
initpackage help for an alternative way to load models.
List of currently outstanding issues.
Patches:
latest update
12.3.0am Feb 26, 2007
Requires patch installer
v2.2
To apply patches, you'll need to have downloaded and already built the source code distribution
of XSPEC. For details and more information about the patch installer, click
here.
Otherwise, just follow the instructions below.
To make sure your XSPEC installation is up to date with all listed patches:
1.    If you don't already have the patch installer v2.2
tcl script, download and place it in the XSPEC src directory. This directory
should be at .../headas/Xspec/src from the source code distribution.
2.    Download the latest patchfile into
the same directory. There is no need to unzip/untar the patchfile
since the installer will do that.
3.    (NOTE: This assumes you
have already set your HEADAS environment variables with the headas-init script,
as you would if you were running XSPEC, and that you have not modified the structure of
your XSPEC src directories.) At the command line, launch the script by typing
'tclsh patch_install_2.2.tcl',
and that's all. The script should detect which patches you've installed previously, copy
the new code files to the necessary directories, determine whether complete or only partial
rebuilds are necessary, and finally perform the rebuilds.
Numbers listed in red indicate that the patch modifies the interface
to one or more of XSPEC's libraries. These patches will generally cause longer rebuilds. If you
have a local model library, it is recommended (though not always necessary) that you rebuild it
with initpackage after applying red patches.
12.3.0a |
A script-exiting error should not automatically be thrown during the reporting
of a negative fit statistic. This is rare but possible in the case of cstat.
Our thanks to Franz Bauer for pointing this out.
Report added on Aug 15, 2006.
The fix is to replace headas/Xspec/src/XSFit/Fit/
StatMethod.cxx
and rebuild xspec.
|
12.3.0b |
This fixes a bug that can occur when using the xmmpsf
mixing model component with data which has energies lower than the lowest point
spread function energy (0.5 keV).
Report added on Aug 15, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/MixFunction/
XMMpsf.cxx
and rebuild xspec.
|
12.3.0c |
When fit statistic is set to cstat or lstat, mixing model
components have no effect on the statistic calculation.
Report added on Aug 15, 2006.
The fix is to replace headas/Xspec/src/XSFit/StatMethod/
Cstat.cxx,
Lstat.cxx,
and rebuild xspec.
|
12.3.0d |
For users writing stand-alone programs linking with the XSPEC models
library, XSFunctions: Fortran and C-accessible wrapper functions are needed for
model routines written in C++ (currently powerlaw and zpowerlaw). Our thanks to
John Houck for pointing this out.
Report added on Aug 22, 2006.
The fix is to replace headas/Xspec/src/XSFunctions/
xsFortran.cxx,
.h,
Makefile,
and rebuild xspec.
|
12.3.0e |
When reading in OGIP-standard table model files, parameters with
negative DELTA values should NOT be treated as switch parameters, but as regular
frozen model parameters. Nor should they be assumed to be "additional" parameters,
as only the NINTPARM and NADDPARM keywords should determine this. Finally, the
redshift parameter should default to frozen. Our thanks to Poonam Chandra for
pointing this out. Report added on Aug 22, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/Component/OGIPTable/
OGIPTable.cxx,
.h,
src/XSModel/Parameter/
ModParam.cxx,
.h,
and rebuild xspec.
|
12.3.0f |
A couple more table model bugs: The save command doesn't
store the full table model notation needed to reload the model at a later time.
Also, XSPEC should prompt for a replacement table model file name when it
fails to find the originally entered file. (This patch also vastly improves
the diagnostic error messages given when loading a table model file with
incorrect format.) Our thanks to Elisa Costantini for pointing this out.
Report added on Aug 30, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/Component/
AddTableComponent.cxx,
MulTableComponent.cxx,
Component.cxx,
CGroupBase.cxx,
src/XSModel/Model/Component/OGIPTable/
OGIPTable.cxx,
src/XSUser/Handler/
xsModel.cxx,
src/XSUtil/Parse/
XSparse.cxx,
and rebuild xspec.
|
12.3.0g |
When the redshift parameter value of a table model is changed, either
due to a newpar command or a fit iteration, the associated energy array
is not properly updated until the user issues another data or model/response-modifying type command
(ie. data, ignore, notice, model, response, etc.). Our thanks to Georg Lamer for
pointing this out.
Report added on Sep 07, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/Component/OGIPTable/
OGIPTable.cxx,
and rebuild xspec.
|
12.3.0h |
When using multiple sources, and not every spectrum uses all sources,
running show par will cause a crash.
Report added on Sep 22, 2006.
The fix is to replace headas/Xspec/src/XSUser/Handler/
xsShow.cxx,
and rebuild xspec.
|
12.3.0i |
addcomp and editmod do not work when adding table model
components. (This patch also fixes other cases of addcomp/editmod bugs,
most importantly when using mixing models, and when using editmod on multiple
data groups. It also adds addcomp/editmod table model file name re-prompting.)
Our thanks to Roderick Johnstone for pointing this out.
Report added on Sep 22, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/
Model.cxx,
ModelBase.cxx,
.h,
src/XSModel/Model/Component/
AddTableComponent.cxx,
.h,
CGroupBase.cxx,
.h,
ComponentCreator.cxx,
ComponentGroup.cxx,
.h,
MulTableComponent.cxx,
.h,
TableComponent.cxx,
.h,
src/XSUser/Handler/
xsEditmod.cxx,
src/XSUtil/Parse/
Expression.cxx,
.h,
and rebuild xspec.
|
12.3.0j |
A couple of bug fixes needed for the projct mixing model component,
for cases where multiple observations are analyzed OR where energy binning
varies among different data groups. Our thanks to Paul Nulsen for pointing this out.
Report added on Oct 23, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/MixFunction/
Projection.cxx,
and rebuild xspec.
|
12.3.0k |
When defining multiple models, the save command should
save the models in order of increasing source number, not in alphanumerical
order based on the model name. Our thanks to Steve Snowden for pointing this out.
Report added on Oct 23, 2006.
The fix is to replace headas/Xspec/src/XSModel/GlobalContainer/
ModelContainer.cxx,
and rebuild xspec.
|
12.3.0l |
This patch provides a reworking of XSPEC's plotting algorithms, to improve the
behavior and efficiency when using arbitrary configurations of multiple
models and detectors, as is now allowed in v12.3.0. Under the previous
system, some assignments of multiple models were very likely to run into
PLT's upper limit of allowed plot vectors when doing "plot data" and
its variations.
Report added on Oct 23, 2006.
The fix is to replace headas/Xspec/src/XSModel/Data/
SpectralData.cxx,
src/XSModel/GlobalContainer/
ModelContainer.cxx,
.h,
src/XSPlot/Commands/
PlotChiSq.cxx,
PlotDelchi.cxx,
PlotEfficiency.cxx,
PlotInsensitivity.cxx,
PlotRatio.cxx,
PlotResiduals.cxx,
PlotSensitivity.cxx,
PlotUnfolded.cxx,
src/XSPlot/Plot/
Plot.cxx,
.h,
PlotCommand.cxx,
.h,
PlotGroup.cxx,
.h,
PlotTypes.h,
src/XSPlot/Plt/
MultiPltLayout.cxx,
Plt.cxx,
.h,
SinglePltLayout.cxx,
and rebuild xspec.
|
12.3.0m |
An unintended result of patch 12.3.0l is that it no longer allows data
plots in energy/wavelength mode unless a model is assigned to 1 or more of
the spectrum's RMFs. If an RMF exists, it should allow the plot regardless
of whether or not there is also a model. Our thanks to Simon Vaughan for pointing this out.
Report added on Oct 26, 2006.
The fix is to replace headas/Xspec/src/XSPlot/Plot/
Plot.cxx,
and rebuild xspec.
|
12.3.0n |
A seg-fault can occur when removing spectra, when these spectra are associated
with a particular (unlikely) arrangement of multiple models and data groups.
Report added on Oct 26, 2006.
The fix is to replace headas/Xspec/src/XSModel/GlobalContainer/
ModelContainer.cxx,
and rebuild xspec.
|
12.3.0o |
The tclout stat option ought to run even if the fit is not current.
Report added on Oct 26, 2006.
The fix is to replace headas/Xspec/src/XSUser/Handler/
xsTclout.cxx,
and rebuild xspec.
|
12.3.0p |
Bug fix to the diskpbb additive model component. The normalization was wrong in that it was 0.75/p times smaller than
required. The correct normalization is obtained by multiplying 0.75/p
to the normalization of the old version of the code. Since the disk
radius is proportional to the square root of the normalization, and p
can be as low as 0.5, the correct inner radius may be up to 1.11 times
greater than the radius obtained from the old version of the code. Our
thanks to Ken Ebisawa for supplying this fix.
Report added on Oct 26, 2006.
The fix is to replace headas/Xspec/src/XSFunctions/
diskpbb.f,
and rebuild xspec.
|
12.3.0q |
A couple of small fakeit bugs: Net count rate is not being shown for
the new spectra after fakeit is run. Also fit statistic needs
immediate updating after fakeit, whereas it had been requiring another command
(e.g. fit, model, newpar, etc.) to trigger the proper update.
Report added on Nov 06, 2006.
The fix is to replace headas/Xspec/src/XSModel/Data/
DataSet.cxx,
src/XSUser/Handler/
xsFakeit.cxx,
and rebuild xspec.
|
12.3.0r |
When there is no relevant output for a tclout command option (e.g. running
tclout backgr when there is no background spectrum), the $xspec_tclout value
should be erased rather than left unchanged from its previous setting. Also,
tclout param should not append the parameter name and units string to
the output values.
Report added on Nov 06, 2006.
The fix is to replace headas/Xspec/src/XSUser/Handler/
xsTclout.cxx,
and rebuild xspec.
|
12.3.0s |
Restored earlier behaviour of the warning message written when interpolating
on tables (eg in the apec or mekal models) and the response energies extend
outside the tabulated range. The warning message is once again only written at
chatter level 15.
Report added on Nov 06, 2006.
The fix is to replace headas/Xspec/src/XSFunctions/
inibin.f,
and rebuild xspec.
|
12.3.0t |
Bug fix for Churazov and Gehrels weighting. When changing the
weighting function for already-loaded spectra to Churazov or Gehrels, if
a spectrum has a background spectrum with a different exposure time,
the weighting function is erroneously using the spectrum's exposure time for
both the spectrum and background.
Report added on Nov 08, 2006.
The fix is to replace headas/Xspec/src/XSUser/Handler/
xsWeight.cxx,
and rebuild xspec.
|
12.3.0u |
Several fakeit issues addressed: The variance is now calculated differently
for fake spectra with non-Poisson errors. It will no longer include contributions
from background spectra. Also when running fakeit on data using non-standard weighting,
the weighting was not being retained for the newly created fake spectra. (It had to be
recovered by running "weight standard" followed by "weight < non-std>".) And finally,
fakeit should always output the standard variance to the STAT_ERR column
even when non-standard weighting is in effect.
Report added on Nov 13, 2006.
The fix is to replace headas/Xspec/src/XSModel/Data/
DataSet.cxx,
OGIP-92aData.cxx,
headas/Xspec/Integral/
SPI_Data.cxx,
and rebuild xspec.
|
12.3.0v |
When a spectrum does not have a response assigned to source number 1 (the default
source for all spectra), yet does have 1 or more responses assigned to higher numbered
sources, the ignore command is not allowing ranges to be entered as energies.
Our thanks to Natasha Jackson for pointing this out.
Report added on Nov 28, 2006.
The fix is to replace headas/Xspec/src/XSModel/Data/
SpectralData.cxx,
and rebuild xspec.
|
12.3.0w |
This is an enhancement patch which adds an extend option to the energies
command. The energies command, which is new for v12.3.0, is meant to be a more
flexible replacement for the v11 extend command, but this option has now been
added to energies for those who still wish to have the old behaviour. See the
energies manual entry for usage syntax.
Report added on Nov 28, 2006.
The update is to replace headas/Xspec/src/XSModel/GlobalContainer/
ModelContainer.cxx,
.h,
ModelTypes.h,
src/XSModel/Model/
Model.cxx,
.h,
ModelBase.cxx,
.h,
src/XSUser/Handler/
xsEnergies.cxx,
xsModel.cxx,
xsShow.cxx,
xsTclout.cxx,
and rebuild xspec.
|
12.3.0x |
An enhancement patch which adds new plotting options for displaying
background spectra. The new command plot background will plot
the backgrounds by themselves (with folded models if they exist). The new
setplot option setplot background will cause the backgrounds
to be displayed along with the data when doing plot data or its
variants. This can be turned off with setplot nobackground.
Report added on Nov 28, 2006.
The update is to replace headas/Xspec/src/XSModel/Data/
SpectralData.cxx,
src/XSPlot/
Makefile,
src/XSPlot/Commands/
PlotBackground.cxx,
.h,
PlotData.cxx,
PlotIcounts2Panel.cxx,
.h,
PlotUnfolded.cxx,
src/XSPlot/Plot/
Plot.cxx,
.h,
PlotCommand.cxx,
.h,
PlotCommandCreator.cxx,
PlotGroup.cxx,
.h,
src/XSUser/Handler/
xsSetplot.cxx,
xsShow.cxx,
and rebuild xspec.
|
12.3.0y |
The setplot id option is not actually displaying any emission lines on plots.
Our thanks to Kip Kuntz for pointing this out.
Report added on Dec 04, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/EmissionLines/
LineList.cxx,
src/XSPlot/Plot/
Plot.cxx,
PlotCommand.cxx,
src/XSPlot/Plt/
Plt.cxx,
src/XSUser/Handler/
xsSetplot.cxx,
and rebuild xspec.
|
12.3.0z |
This improves the model command exception-handling in the unlikely
case an error is thrown after the creation of a new model but before the
model command finishes execution.
Report added on Dec 11, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/
Model.cxx,
src/XSUser/Handler/
xsModel.cxx,
and rebuild xspec.
|
12.3.0aa |
When fitting with a table model, if the upper or lower parameter hard-limit value
equals the corresponding boundary in the table, the fit may terminate with an
out-of-bounds error. However this should only be possible if the hard-limit value is
outside the boundary in the table. Our thanks to Pierre-Olivier Petrucci and
Delphine Porquet for pointing this out.
Report added on Dec 11, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/Component/OGIPTable/
OGIPTable.cxx,
and rebuild xspec.
|
12.3.0ab |
A couple of improvements made to the save command output:
Gain parameters are now written out to the save file. Also
previously when a parameter was linked to another parameter in the same model
but belonging to a higher-numbered data group, the save output
was not written in way which could reproduce the link. It now handles this properly
by issuing a newpar command to reload the link. Our thanks to Ed Kellogg for pointing this out.
Report added on Dec 19, 2006.
The fix is to replace headas/Xspec/src/XSModel/Data/Detector/
Response.cxx,
src/XSModel/GlobalContainer/
DataContainer.cxx,
ModelContainer.cxx,
and rebuild xspec.
|
12.3.0ac |
The projct mixing model is not properly handling the case where
multiple observations are used if all of the observations in a particular
region do NOT have the same model energy arrays. Our thanks to Dong-Woo Kim
for pointing this out.
Report added on Dec 22, 2006.
The fix is to replace headas/Xspec/src/XSModel/Model/MixFunction/
Projection.cxx,
and rebuild xspec.
|
12.3.0ad |
An enhancement patch for adding new tclout options:
  tclout statmethod - output the name of the stat method currently in use.
  tclout weight - output the name of the current weighting function.
  tclout noticed [< n >] - output the noticed channels for spectrum < n > .
  tclout noticed energy [< n >] - output the noticed energies for spectrum < n > .
Report added on Jan 05, 2007.
The update is to replace headas/Xspec/src/XSUser/Handler/
HandlerUtils.cxx,
.h,
xsTclout.cxx,
and rebuild xspec.
|
12.3.0ae |
Patch fix to prevent segmentation faults during mostly obscure cases involving
parameter links between active and inactive models.
Report added on Jan 05, 2007.
The fix is to replace headas/Xspec/src/XSModel/GlobalContainer/
ModelContainer.cxx,
.h,
src/XSModel/Parameter/
Parameter.cxx,
src/XSUser/Handler/
xsModel.cxx,
and rebuild xspec.
|
12.3.0af |
An enhancement patch which adds Fortran-callable wrapper functions
equivalent to xspec11's xsatbl and xsmtbl routines. This
allows users writing local models in Fortran to access xspec12's table
model interpolation functionality, and is required in order to use the
swind1 model which was recently added to the "Additional Models" page.
Included with this patch is a general calculation efficiency improvement
when fitting with table models.
Report added on Jan 05, 2007.
The update is to replace headas/Xspec/src/tools/initpackage/
xspackage.tmpl,
src/XSModel/
Makefile,
src/XSModel/Model/
Model.cxx,
src/XSModel/Model/Component/
AddTableComponent.cxx,
.h,
Component.cxx,
.h,
MixComponent.cxx,
.h,
MulTableComponent.cxx,
.h,
TableComponent.cxx,
.h,
src/XSModel/Model/Component/OGIPTable/
FtoOGIPTable.cxx,
OGIPTable.cxx,
.h,
src/XSModel/Parameter/
Parameter.cxx,
src/XSUser/Handler/
xsAddcomp.cxx,
xsEditmod.cxx,
xsModel.cxx,
xsNewpar.cxx,
and rebuild xspec.
|
12.3.0ag |
The linear interpolation algorithm for rebinning is not being properly reset for certain
cases. This bug affects the calculation of table models which contain a
redshift parameter, when that parameter has been varied either during
a fit or manually with the newpar command. It may also affect the projct
mixing model when it is used on multiple observations that do not all have the same
model energy arrays.
Report added on Jan 05, 2007.
The fix is to replace headas/Xspec/src/XSModel/Model/Component/OGIPTable/
OGIPTable.cxx,
src/XSUtil/Numerics/
LinearInterp.cxx,
and rebuild xspec.
|
12.3.0ah |
The fit does not converge properly using cstat for some datasets with
low counts in the source and background.
Report added on Jan 05, 2007.
The fix is to replace headas/Xspec/src/XSFit/StatMethod/Cstat/
Cstat.cxx,
and rebuild xspec.
|
12.3.0ai |
Bug fix for plot icounts. The plot had been wrongly
assuming that all AREASCALE values are the same for every channel in a
spectrum.
Report added on Feb 16, 2007.
The fix is to replace headas/Xspec/src/XSPlot/Commands/
PlotIcounts.cxx,
and rebuild xspec.
|
12.3.0aj |
tclout peakrsid is not working when using cstat or lstat.
Report added on Feb 16, 2007.
The fix is to replace headas/Xspec/src/XSFit/StatMethod/Cstat/
Cstat.cxx,
Lstat.cxx,
and rebuild xspec.
|
12.3.0ak |
Corrected keV to Angstrom conversion constant using CODATA(2002) fundamental
constant values per the NIST website.Surprisingly the error of 1 in the 6th
significant digit is visible when plotting grating spectra in wavelength space.
Our thanks to Carlos Gabriel for pointing this out.
Report added on Feb 16, 2007.
The fix is to replace headas/Xspec/src/XSUtil/Numerics/
Numerics.h,
and rebuild xspec.
|
12.3.0al |
Bug fix for error command when using the migrad fitting
method from the MINUIT library. Frozen parameters were not being taken into
account correctly when calling the MINUIT code.
Report added on Feb 16, 2007.
The fix is to replace headas/Xspec/src/XSFit/FitMethod/Minuit/
Minuit.cxx,
and rebuild xspec.
|
12.3.0am |
A memory error in the kerrbb model component can cause a seg fault if
the model is used with multiple response matrices and the first one does not
have the largest number of energy bins. Our thanks to Diana Hannikainen for pointing this out.
Report added on Feb 26, 2007.
The fix is to replace headas/Xspec/src/XSFunctions/
kerrbb.f,
and rebuild xspec.
|
Older Versions:
|