SPEX 4.0 documentation
Contents:
News
Install
Conda/Mamba
Compile from source
Using SPEX
General examples
How to run SPEX
How to convert spectra to SPEX format
Analysis threads
Fitting a CCD spectrum
Modeling particle background
Fitting interstellar dust absorption
Import UV/Optical data
PION setup for AGN warm absorber
PION setup for emission and absorption features in AGN
Fitting two different spectra simultaneously
How to use the SPEX user model
Use any Xspec model in SPEX
Use local Xspec model ismabs in SPEX
Performance
Optimizing model performance
Exercises
Powerlaw
Powerlaw with a Gaussian line
Statistics, binning and more
Stellar Spectra
Supernova remnants
Relativistic lines
AGN winds
Command syntax
Abundance: standard abundances
Aerror: Estimate atomic data errors for model parameters
Ascdump: ascii output of plasma and spectral properties
Ascdump output table properties
Bin: rebin the spectrum
Calculate: evaluate the spectrum
Comp: create, delete and relate spectral components
Data: read response file and spectrum
DEM: differential emission measure analysis
Distance: set the source distance
Egrid: define model energy grids
Elim: set flux energy limits
Error: Calculate the errors of the fitted parameters
Fit: spectral fitting
Ibal: set type of ionisation balance
Ignore: ignoring part of the spectrum
Ion: select ions for the plasma models
Log: Making and using command files
Menu: Menu settings
Model: show the current spectral model
Multiply: scaling of the response matrix
Obin: optimal rebinning of the data
Par: Input and output of model parameters
Plot: Plotting data and models
Quit: finish the program
Rbin: optimal rebinning of the data and response, including saving
Reset: Reset the data and/or model
Sector: creating, copying and deleting of a sector
Shiftplot: shift the plotted spectrum for display purposes
Simulate: Simulation of data
Step: Grid search for spectral fits
Syserr: systematic errors
System: call system executables
Use: reuse part of the spectrum
Var: various settings for the plasma models
Vbin: variable rebinning of the data
Watch: track time and subroutines
Spectral models
Absm: Morrison & McCammon absorption model
Amol: interstellar dust absorption model
APEC: collisional ionisation equilibrium model (External)
Bb: blackbody model
Cf: isobaric cooling flow differential emission measure model
Cie: collisional ionisation equilibrium model
Clus: projected cluster model
Comt: comptonisation model
CX: model for charge exchange plasmas
Dabs: dust absorption model
Dbb: disk blackbody model
Delt: delta line model
Dem: differential emission measure model
Dust: dust scattering model
Ebv: Galactic interstellar extinction model
Etau: simple transmission model
Euve: EUVE absorption model
File: model read from a file
Gain: Modify the energy scale of the model to compensate instrumental gain errors
Gaus: gaussian line model
Hot: collisional ionisation equilibrium absorption model
Hyd: model with user-own hydrodynamical simulation
Knak: segmented power law transmission model
Laor: relativistic line broadening model
Line: transmission model for a single spectral line
Lpro: spatial broadening model
Mbb: modified blackbody model
Musr: User defined multiplicative model
Neij: non-equilibrium ionisation jump model
Pdem: DEM models
Pion: SPEX photoionised plasma model
Pow: power law model
Reds: redshift model
Refl: reflection model
Rrc: radiative recombination continuum model
Slab: thin slab absorption model
Spei: relativistic line broadening model
Spln: spline continuum model
SSD: Shakura-Sunyaev disk model
Tpho: Time-dependent, non-equilibrium, photoionised plasma model
User: User defined model
Vblo: rectangular velocity broadening model
Vcom: Compton shoulder broadening model
Vgau: gaussian velocity broadening model
Vpro: velocity profile broadening model
Warm: continuous photoionised absorption model
Wdem: power law differential emission measure model
Xabs: photoionised absorption model
Plotting reference
Plot devices
Plot types
Plot colours
Plot line types
Plot text
Plot captions
Plot symbols
Plot axis units and scales
Plot asciidump file format
Spextools
Trafo
Stepcontour
Xabsinput
Hydro driver
Rgsvprof
RGS_fluxcombine
RGS_fmat
Uvtospex
Calling SPEX from Fortran
Python API Interface
Basic usage of PYSPEX
Basic PYSPEX commands
Data related commands
Model related commands
Ascdump commands
Optimization & Simulation commands
Plot commands
Log commands
Reset command
Jupyter Notebooks
Astropy units and tables
Spex class structure
Data class structure
Model class structures
Optimization & Simulation functions
Plot functions
Ascdump class
Logging commands
Fortran API Interface
Using the Fortran API
Create a basic SPEX Fortran program
Main SPEX API
Data related procedures
Model related procedures
Optimization & Simulation functions
Plot functions
Help & troubleshooting
Commandline help
Solving SPEX problems
Find known issues
Report issues
SPEX Theory
SPEX Atomic Code & Tables
The SPEX Atomic Code & Tables (SPEXACT)
Plasma model in SPEX 3.0
Absorption model theory
Atomic database for the absorbers
Non-equilibrium ionisation (NEI) calculations
Non-thermal electron distributions
Supernova remnant model theory
SPEX 2 notation of atomic transitions
Modelling and fitting
Calculating models on grids
Different types of spectral components
Sectors and regions
Spectral Fitting
Testing model significance
Optimal definition of respons matrices
Definition of the micro-turbulent velocity in SPEX
Supernova remnant model theory
Changelog
Credits
repository
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
U
|
V
_
__init__() (pyspex.spex.Spex method)
A
abun() (pyspex.spex.Spex method)
abun_show() (pyspex.spex.Spex method)
Abundance (class in pyspex.spex.model)
adum_xspec_qdp() (pyspex.spex.plot.PlotModel method)
Aerror (class in pyspex.spex.model)
aerror() (pyspex.spex.Spex method)
Ascdump (class in pyspex.spex.ascdump)
ascdump() (pyspex.spex.spex.Spex method)
B
bin() (pyspex.spex.Spex method)
,
[1]
built-in function
calc_energy()
fitsexist()
fitsgetlun()
fitstype()
memo_a1()
memo_i1()
memo_i2()
memo_i3()
memo_r1()
memo_r2()
memo_r3()
printerror()
sys_datum()
sys_getenv()
C
calc() (pyspex.spex.Spex method)
calc_energy()
built-in function
chiplot() (pyspex.spex.plot.PlotData method)
chitype() (pyspex.spex.plot.PlotDataReg method)
close() (pyspex.spex.log.Log method)
com() (pyspex.spex.Spex method)
com_del() (pyspex.spex.Spex method)
com_rel() (pyspex.spex.Spex method)
command() (pyspex.spex.Spex method)
comp_delete() (pyspex.spex.model.Model method)
comp_new() (pyspex.spex.model.Model method)
comp_set_rel() (pyspex.spex.model.Model method)
Component (class in pyspex.spex.model)
D
Data (class in pyspex.spex.data)
data() (pyspex.spex.Spex method)
,
[1]
data_del() (pyspex.spex.Spex method)
,
[1]
data_save() (pyspex.spex.Spex method)
,
[1]
dist() (pyspex.spex.Spex method)
dist_cosmo() (pyspex.spex.Spex method)
dist_get() (pyspex.spex.Spex method)
Distance (class in pyspex.spex.model)
E
Egrid (class in pyspex.spex.model)
egrid() (pyspex.spex.Spex method)
egrid_get() (pyspex.spex.Spex method)
egrid_read() (pyspex.spex.Spex method)
egrid_save() (pyspex.spex.Spex method)
egrid_set() (pyspex.spex.Spex method)
egrid_step() (pyspex.spex.Spex method)
elim() (pyspex.spex.model.Fluxes method)
(pyspex.spex.Spex method)
elimflux (pyspex.spex.model.Fluxes attribute)
Error (class in pyspex.spex.fit)
error() (pyspex.spex.fit.Error method)
(pyspex.spex.Spex method)
,
[1]
execute() (pyspex.spex.log.Log method)
F
Fit (class in pyspex.spex.fit)
fit() (pyspex.spex.fit.Fit method)
(pyspex.spex.Spex method)
,
[1]
fit_chisq() (pyspex.spex.Spex method)
,
[1]
fit_cstat() (pyspex.spex.Spex method)
,
[1]
fit_method() (pyspex.spex.Spex method)
,
[1]
fit_print() (pyspex.spex.fit.Fit method)
(pyspex.spex.Spex method)
,
[1]
fit_set_ann() (pyspex.spex.Spex method)
,
[1]
fit_stat() (pyspex.spex.Spex method)
,
[1]
fit_stat_inst() (pyspex.spex.Spex method)
,
[1]
fitsexist()
built-in function
fitsgetlun()
built-in function
fitstype()
built-in function
flux_get() (pyspex.spex.Spex method)
Fluxes (class in pyspex.spex.model)
G
get() (pyspex.spex.ascdump.Ascdump method)
(pyspex.spex.model.Abundance method)
(pyspex.spex.model.Aerror method)
(pyspex.spex.model.Distance method)
(pyspex.spex.model.Egrid method)
(pyspex.spex.model.Fluxes method)
(pyspex.spex.model.Ibal method)
(pyspex.spex.model.Spectrum method)
get_method() (pyspex.spex.fit.Fit method)
get_statistic() (pyspex.spex.fit.Fit method)
get_value() (pyspex.spex.fit.Error method)
grid() (pyspex.spex.model.Egrid method)
I
Ibal (class in pyspex.spex.model)
ibal() (pyspex.spex.Spex method)
ibal_show() (pyspex.spex.Spex method)
ignore() (pyspex.spex.Spex method)
,
[1]
ignore_all() (pyspex.spex.model.Ions method)
ignore_ion() (pyspex.spex.model.Ions method)
ignore_iso() (pyspex.spex.model.Ions method)
ignore_z() (pyspex.spex.model.Ions method)
Instrument (class in pyspex.spex.data)
Ions (class in pyspex.spex.model)
ions_all() (pyspex.spex.Spex method)
ions_ion() (pyspex.spex.Spex method)
ions_iso() (pyspex.spex.Spex method)
ions_line() (pyspex.spex.Spex method)
ions_show() (pyspex.spex.Spex method)
ions_z() (pyspex.spex.Spex method)
L
line() (pyspex.spex.model.Ions method)
lmax_all() (pyspex.spex.model.Ions method)
lmax_ion() (pyspex.spex.model.Ions method)
lmax_iso() (pyspex.spex.model.Ions method)
lmax_z() (pyspex.spex.model.Ions method)
Log (class in pyspex.spex.log)
log_close() (pyspex.spex.Spex method)
log_exe() (pyspex.spex.Spex method)
log_out() (pyspex.spex.Spex method)
log_save() (pyspex.spex.Spex method)
M
memo_a1()
built-in function
memo_i1()
built-in function
memo_i2()
built-in function
memo_i3()
built-in function
memo_r1()
built-in function
memo_r2()
built-in function
memo_r3()
built-in function
Model (class in pyspex.spex.model)
module
pyspex.spex
pyspex.spex.data
pyspex.spex.log
pyspex.spex.model
N
new_all() (pyspex.spex.model.Ions method)
new_ion() (pyspex.spex.model.Ions method)
new_iso() (pyspex.spex.model.Ions method)
new_z() (pyspex.spex.model.Ions method)
nmax_all() (pyspex.spex.model.Ions method)
nmax_ion() (pyspex.spex.model.Ions method)
nmax_iso() (pyspex.spex.model.Ions method)
nmax_z() (pyspex.spex.model.Ions method)
O
obin() (pyspex.spex.Spex method)
,
[1]
old_all() (pyspex.spex.model.Ions method)
old_ion() (pyspex.spex.model.Ions method)
old_iso() (pyspex.spex.model.Ions method)
old_z() (pyspex.spex.model.Ions method)
output() (pyspex.spex.log.Log method)
P
par() (pyspex.spex.Spex method)
par_aset() (pyspex.spex.model.Model method)
par_couple() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
par_decouple() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
par_fix() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
par_free() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
par_get() (pyspex.spex.model.Model method)
par_norm() (pyspex.spex.Spex method)
par_norm_get() (pyspex.spex.model.Model method)
par_norm_set() (pyspex.spex.model.Model method)
par_range() (pyspex.spex.Spex method)
par_set() (pyspex.spex.model.Model method)
par_set_range() (pyspex.spex.model.Model method)
par_show() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
par_show_classic() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
par_show_couple() (pyspex.spex.model.Model method)
par_show_flux() (pyspex.spex.model.Model method)
par_show_free() (pyspex.spex.model.Model method)
par_show_param() (pyspex.spex.model.Model method)
par_text() (pyspex.spex.Spex method)
par_write() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
Parameter (class in pyspex.spex.model)
plot() (pyspex.spex.plot.PlotArea method)
(pyspex.spex.plot.PlotData method)
(pyspex.spex.plot.PlotModel method)
plot_area() (pyspex.spex.spex.Spex method)
plot_chi() (pyspex.spex.plot.PlotData method)
(pyspex.spex.spex.Spex method)
plot_comp() (pyspex.spex.plot.PlotData method)
(pyspex.spex.spex.Spex method)
plot_data() (pyspex.spex.plot.PlotData method)
(pyspex.spex.spex.Spex method)
plot_model() (pyspex.spex.spex.Spex method)
PlotArea (class in pyspex.spex.plot)
PlotAreaInst (class in pyspex.spex.plot)
PlotAreaReg (class in pyspex.spex.plot)
PlotData (class in pyspex.spex.plot)
PlotDataInst (class in pyspex.spex.plot)
PlotDataReg (class in pyspex.spex.plot)
PlotModel (class in pyspex.spex.plot)
PlotModelSector (class in pyspex.spex.plot)
printerror()
built-in function
pyspex.spex
module
pyspex.spex.data
module
pyspex.spex.log
module
pyspex.spex.model
module
Q
qc_all() (pyspex.spex.model.Ions method)
qc_ion() (pyspex.spex.model.Ions method)
qc_iso() (pyspex.spex.model.Ions method)
qc_z() (pyspex.spex.model.Ions method)
R
read() (pyspex.spex.model.Egrid method)
Region (class in pyspex.spex.data)
reset() (pyspex.spex.spex.Spex method)
reset_gacc() (pyspex.spex.model.Var method)
S
save() (pyspex.spex.log.Log method)
(pyspex.spex.model.Egrid method)
Sector (class in pyspex.spex.model)
sector() (pyspex.spex.Spex method)
sector_copy() (pyspex.spex.model.Model method)
(pyspex.spex.Spex method)
sector_del() (pyspex.spex.Spex method)
sector_delete() (pyspex.spex.model.Model method)
sector_new() (pyspex.spex.model.Model method)
set() (pyspex.spex.model.Abundance method)
(pyspex.spex.model.Distance method)
(pyspex.spex.model.Egrid method)
(pyspex.spex.model.Ibal method)
set_ann() (pyspex.spex.fit.Fit method)
set_bnoise() (pyspex.spex.fit.Simulate method)
set_calc() (pyspex.spex.model.Var method)
set_cosmo() (pyspex.spex.model.Distance method)
set_cxcon() (pyspex.spex.model.Var method)
set_dchi() (pyspex.spex.fit.Error method)
set_doppler() (pyspex.spex.model.Var method)
set_gacc() (pyspex.spex.model.Var method)
set_ibalmaxw() (pyspex.spex.model.Var method)
set_instrument() (pyspex.spex.fit.Simulate method)
set_line() (pyspex.spex.model.Var method)
set_mekal() (pyspex.spex.model.Var method)
set_method() (pyspex.spex.fit.Fit method)
set_newcooldr() (pyspex.spex.model.Var method)
set_newcoolexc() (pyspex.spex.model.Var method)
set_noise() (pyspex.spex.fit.Simulate method)
set_occstart() (pyspex.spex.model.Var method)
set_pixsec() (pyspex.spex.model.Var method)
set_random_seed() (pyspex.spex.fit.Simulate method)
set_statistic() (pyspex.spex.fit.Fit method)
set_statistic_inst() (pyspex.spex.fit.Fit method)
set_step() (pyspex.spex.model.Egrid method)
set_syserr() (pyspex.spex.fit.Simulate method)
show() (pyspex.spex.fit.Fit method)
(pyspex.spex.model.Ions method)
Simulate (class in pyspex.spex.fit)
simulate() (pyspex.spex.fit.Simulate method)
(pyspex.spex.Spex method)
,
[1]
simulate_exposure() (pyspex.spex.fit.Simulate method)
Spectrum (class in pyspex.spex.model)
Spex (class in pyspex.spex)
start() (pyspex.spex.fit.Error method)
sys_datum()
built-in function
sys_getenv()
built-in function
syserr() (pyspex.spex.Spex method)
,
[1]
U
update() (pyspex.spex.data.Data method)
(pyspex.spex.data.Instrument method)
(pyspex.spex.data.Region method)
(pyspex.spex.fit.Fit method)
(pyspex.spex.model.Abundance method)
(pyspex.spex.model.Component method)
(pyspex.spex.model.Ibal method)
(pyspex.spex.model.Ions method)
(pyspex.spex.model.Model method)
(pyspex.spex.model.Parameter method)
(pyspex.spex.model.Sector method)
(pyspex.spex.model.Var method)
(pyspex.spex.plot.PlotArea method)
(pyspex.spex.plot.PlotAreaInst method)
(pyspex.spex.plot.PlotAreaReg method)
(pyspex.spex.plot.PlotData method)
(pyspex.spex.plot.PlotDataInst method)
(pyspex.spex.plot.PlotDataReg method)
(pyspex.spex.plot.PlotModel method)
(pyspex.spex.plot.PlotModelSector method)
use() (pyspex.spex.Spex method)
,
[1]
use_all() (pyspex.spex.model.Ions method)
use_ion() (pyspex.spex.model.Ions method)
use_iso() (pyspex.spex.model.Ions method)
use_z() (pyspex.spex.model.Ions method)
V
Var (class in pyspex.spex.model)
var_calc() (pyspex.spex.Spex method)
var_cxcon() (pyspex.spex.Spex method)
var_doppler() (pyspex.spex.Spex method)
var_gacc() (pyspex.spex.Spex method)
var_ibalmaxw() (pyspex.spex.Spex method)
var_line() (pyspex.spex.Spex method)
var_mekal() (pyspex.spex.Spex method)
var_newcooldr() (pyspex.spex.Spex method)
var_newcoolexc() (pyspex.spex.Spex method)
var_occstart() (pyspex.spex.Spex method)
vbin() (pyspex.spex.Spex method)
,
[1]