Last modified: December 2018

URL: http://cxc.harvard.edu/sherpa/ahelp/load_xscflux.html
AHELP for CIAO 4.11 Sherpa v1

load_xscflux

Context: models

Synopsis

calculate flux. XSpec convolution model *Experimental*.

Description

A convolution model to calculate the flux of other model components.

The Sherpa commands calc_energy_flux, calc_photon_flux, and sample_flux, as well as the Calculating Model Flux and Flux Uncertainty thread can also be used.

xscflux Parameters

Number Name Description
1 Emin Minimum energy over which flux is calculated (keV)
2 Emax Maximum energy over which flux is calculated (keV)
3 lg10Flux log (base 10) flux in erg/cm^2/s

Loading the X-Spec convolution models

Please see ahelp xsconvolve for information on how to load the model.

Notes

XSpec version

This information is taken from the XSpec User's Guide. Version 12.10.0e of the XSpec models is supplied with CIAO 4.11.


Examples

Example 1

sherpa> from sherpa_contrib.xspec.xsconvolve import load_xscflux
sherpa> load_xscflux("cflux")
sherpa> xsphabs.gal()
sherpa> xspowerlaw.pl()
sherpa> xsgaussian.gs()
sherpa> cflux.emin = 0.5
sherpa> cflux.emax = 7
sherpa> set_source(cflux(gal * (pl + gs)))

Flux of the absorbed model

If the power-law or gaussian normalization is fixed to a non-zero value then the above will calculate the flux and error on the entire model (absorbed). The energy range is taken to be 0.5 to 7 keV.

Example 2

sherpa> set_source(gal * cflux(pl + gs)))

Flux of the un-absorbed model

If the power-law or gaussian normalization is fixed to a non-zero value then this calculates the unabsorbed flux and error.

Example 3

sherpa> set_source(gal * (pl + cflux(gs)))

Flux of a component

If the gaussian normalization is fixed to a non-zero value then this calculates the unabsorbed flux and error of the gaussian component.


About Contributed Software

This script is not an official part of the CIAO release but is made available as "contributed" software via the CIAO scripts page. Please see this page for installation instructions - such as how to ensure that the parameter file is available.


Bugs

For a list of known bugs and issues with the XSPEC models, please visit the XSPEC bugs page.

See Also

models
list_model_components, list_models, load_xsclumin, load_xscpflux, load_xsgsmooth, load_xsireflect, load_xskdblur, load_xskdblur2, load_xskerrconv, load_xslsmooth, load_xspartcov, load_xsrdblur, load_xsreflect, load_xsrfxconv, load_xsrgsxsrc, load_xssimpl, load_xsvashift, load_xsvmshift, load_xsxilconv, load_xszashift, load_xszmshift, models, tablemodel, xs, xsconvolve