Last modified: December 2018

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

load_xsclumin

Context: models

Synopsis

calculate luminosity. XSpec convolution model *Experimental*.

Description

A convolution model to calculate the luminosity 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. These would then need to be converted to a luminosity using your favorite Cosmology. See also the calc_kcorr function for applying a K correction to a spectral model.

xsclumin Parameters

Number Name Description
1 Emin Minimum source-frame energy over which luminosity is calculated (keV)
2 Emax Maximum source-frame energy over which luminosity is calculated (keV)
3 Redshift Redshift of the source
4 lg10Lum log (base 10) of the luminosity in erg/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_xsclumin
sherpa> load_xsclumin("clumin")
sherpa> xsphabs.gal()
sherpa> xspowerlaw.pl()
sherpa> xsgaussian.gs()
sherpa> clumin.emin = 0.5
sherpa> clumin.emax = 7
sherpa> clumin.redshift = 0.2
sherpa> set_source(clumin(gal * (pl + gs)))

Luminosity of the absorbed model

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

Example 2

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

Luminosity of the un-absorbed model

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

Example 3

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

Luminosity of a component

If the gaussian normalization is fixed to a non-zero value then this calculates the unabsorbed luminosity 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_xscflux, 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