— jupyter: jupytext: formats: ipynb,md text_representation: extension: .md format_name: markdown format_version: ‘1.2’ jupytext_version: 1.7.1 kernelspec: display_name: Python 3 language: python name: python3 —

Working with XSPEC models

One of the most powerful aspects of XSPEC is a huge modeling community. While in 3ML, we are focused on building a powerful and modular data analysis tool, we cannot neglect the need for many of the models thahat already exist in XSPEC and thus provide support for them via astromodels directly in 3ML.

For details on installing astromodels with XSPEC support, visit the 3ML or astromodels installation page.

Tip: astromodels / 3ML already have ZDust, absorption and APEC models built in!

Let’s explore how we can use XSPEC spectral models in 3ML.

import warnings

warnings.simplefilter("ignore")
import numpy as np

np.seterr(all="ignore")

{'divide': 'warn', 'over': 'warn', 'under': 'ignore', 'invalid': 'warn'}

import matplotlib.pyplot as plt

%%capture
from threeML import set_threeML_style
from jupyterthemes import jtplot

%matplotlib inline
jtplot.style(context="talk", fscale=1, ticks=True, grid=False)


set_threeML_style()

We do not load the models by default as this takes some time and 3ML should load quickly. However, if you need the XSPEC models, they are imported from astromodels like this:

from astromodels.xspec.factory import *

Loading xspec models...done

The models are indexed with XS_ before the typical XSPEC model names.

plaw = XS_powerlaw()
phabs = XS_phabs()
phabs

• description: The phabs model from XSpec (https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XspecModels.html)
• formula: $n.a.$
• parameters:
  • nh:
    • value: 1.0
    • desc: (see https://heasarc.gsfc.nasa.gov/xanadu/xspec/manual/XspecModels.html)
    • min_value: 0.0
    • max_value: 1000000.0
    • unit:
    • is_normalization: False
    • delta: 0.001
    • free: True

The spectral models behave just as any other astromodels spectral model and can be used in combination with other astromodels spectral models.

from astromodels import Powerlaw

am_plaw = Powerlaw()

plaw_with_abs = am_plaw * phabs


fig, ax = plt.subplots()

energy_grid = np.linspace(0.1, 10.0, 1000)

ax.loglog(energy_grid, plaw_with_abs(energy_grid))
ax.set_xlabel("energy")
ax.set_ylabel("flux")

Text(0, 0.5, 'flux')

XSPEC Settings

Many XSPEC models depend on external abundances, cross-sections, and cosmological parameters. We provide an interface to control these directly.

Simply import the XSPEC settings like so:

from astromodels.xspec.xspec_settings import *

Calling the functions without arguments simply returns their current settings

xspec_abund()

'angr'

xspec_xsect()

'vern'

xspec_cosmo()

(70.0, 0.0, 0.7300000190734863)

To change the settings for abundance and cross-section, provide strings with the normal XSPEC naming conventions.

xspec_abund("wilm")
xspec_abund()

 Solar Abundance Vector set to wilm:  Wilms, J., Allen, A. & McCray, R. ApJ 542 914 (2000) (abundances are set to zero for those elements not included in the paper).

'wilm'

xspec_xsect("bcmc")
xspec_xsect()

 Cross Section Table set to bcmc:  Balucinska-Church and McCammon, 1998

'bcmc'

To alter the cosmological parameters, one passes either the parameters that should be changed, or all three:

xspec_cosmo(H0=68.0)
xspec_cosmo()

(68.0, 0.0, 0.7300000190734863)

xspec_cosmo(H0=68.0, q0=0.1, lambda_0=70.0)
xspec_cosmo()

(68.0, 0.10000000149011612, 70.0)