The sherpa.astro.xspec module

This document describes the base classes for XSPEC models, and the utility routines - such as querying and retrieving the abundance table information. The models provided by XSPEC are described in The sherpa.astro.xspec module; also see The sherpa.astro.xspec module for a general description of the sherpa.astro.xspec module.

Classes

XSBaseParameter(modelname, name, val[, min, ...])

An XSPEC parameter.

XSParameter(modelname, name, val[, min, ...])

An XSPEC parameter where you exceed the hard limits.

XSModel(name, pars)

The base class for XSPEC models.

XSAdditiveModel(name, pars)

The base class for XSPEC additive models.

XSMultiplicativeModel(name, pars)

The base class for XSPEC multiplicative models.

XSConvolutionKernel(name, pars)

The base class for XSPEC convolution models.

XSConvolutionModel(model, wrapper)

Evaluate a model and pass it to an XSPEC convolution model.

XSTableModel(filename[, name, parnames, ...])

Interface to XSPEC table models.

Functions

get_xsabund([element])

Return the X-Spec abundance setting or elemental abundance.

get_xschatter()

Return the chatter level used by X-Spec.

get_xscosmo()

Return the X-Spec cosmology settings.

get_xspath_manager()

Return the path to the files describing the XSPEC models.

get_xspath_model()

Return the path to the model data files.

get_xsstate()

Return the state of the XSPEC module.

get_xsversion()

Return the version of the X-Spec model library in use.

get_xsxsect()

Return the cross sections used by X-Spec models.

get_xsxset(name)

Return the X-Spec model setting.

read_xstable_model(modelname, filename[, etable])

Create a XSPEC table model.

set_xsabund(abundance)

Set the elemental abundances used by X-Spec models.

set_xschatter(level)

Set the chatter level used by X-Spec.

set_xscosmo(h0, q0, l0)

Set the cosmological parameters used by X-Spec models.

set_xspath_manager(path)

Set the path to the files describing the XSPEC models.

set_xsstate(state)

Restore the state of the XSPEC module.

set_xsxsect(name)

Set the cross sections used by X-Spec models.

set_xsxset(name, value)

Set a X-Spec model setting.

The sherpa.astro.xspec module

Class Inheritance Diagram