About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Last modified: December 2008

URL: http://cxc.harvard.edu/sherpa4.1/calc_kcorr.py.html
AHELP for Sherpa 4.1

calc_kcorr

Context: py.sherpa

Synopsis

Calculate the k correction

Syntax

calc_kcorr(z, obslo, obshi, [restlo, resthi, id, bkg_id] )

Description

The calc_kcorr command calculates the k correction for a spectral model, redshift, and energy range for a source or background dataset. The energy range is taken to be obslo <= energy < obshi .

  • z - the redshift can be a scalar or a 1-D array; the return value matches that of z. If it is an array, the k correction is evaluated for each redshift in the array.
  • obslo - observed-frame lower energy limit (keV)
  • obshi - observed-frame upper energy limit (keV)
  • restlo - rest-frame lower energy limit (keV); default=obslo
  • resthi - rest-frame upper energy energy (keV); default=obshi
  • id - the id of the dataset to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id")
  • bkg_id - the id of the background, if calculating the kcorr for the background; default is the first background associated with the id

Example 1

sherpa> calc_kcorr(0.5, 0.5, 2)

Calculate the k correction for a redshift of 0.5 over the energy range 05:2 keV.

Example 2

sherpa> calc_kcorr(0.5, 0.5, 2, 2, 10, bkg_id=2)

Calculate the k correction for the background dataset bkg_id=2 for a redshift of 0.5 over the energy range 05:2 keV with rest-frame energy limits of 2:10 keV.

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.

Last modified: December 2008



The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory.
60 Garden Street, Cambridge, MA 02138 USA.    Email: cxcweb@head.cfa.harvard.edu
Smithsonian Institution, Copyright © 1998-2004. All rights reserved.