- sherpa.astro.ui.calc_kcorr(z, obslo, obshi, restlo=None, resthi=None, id=None, bkg_id=None)
Calculate the K correction for a model.
The K correction (, , , ) is the numeric factor applied to measured energy fluxes in an observed energy band to estimate the flux in a given rest-frame energy band. It accounts for the change in spectral energy distribution between the desired rest-frame band and the rest-frame band corresponding to the observed band. This is often used when converting a flux into a luminosity.
z (number or array, >= 0) – The redshift, or redshifts, of the source.
obslo (number) – The minimum energy of the observed band.
obshi (number) – The maximum energy of the observed band, which must be larger than
restlo (number or
None) – The minimum energy of the rest-frame band. If
resthi (number or
None) – The maximum energy of the rest-frame band. It must be larger than
id (int or str, optional) – Use the source expression associated with this data set. If not given then the default identifier is used, as returned by
bkg_id (int or str, optional) – If set, use the model associated with the given background component rather than the source model.
- Return type:
number or array of numbers
Integrate the unconvolved source model over a pass band.
Create the independent axis for a 1D data set.
This is only defined when the analysis is in ‘energy’ units.
If the model contains a redshift parameter then it should be set to 0, rather than the source redshift.
If the source model is at zero redshift, the observed energy band is olo to ohi, and the rest frame band is rlo to rhi (which need not match the observed band), then the K correction at a redshift z can be calculated as:
frest = calc_energy_flux(rlo, rhi) fobs = calc_energy_flux(olo*(1+z), ohi*(1+z)) kz = frest / fobs
The energy ranges used - rlo to rhi and olo*(1+z) to ohi*(1+z) - should be fully covered by the data grid, otherwise the flux calculation will be truncated at the grid boundaries, leading to incorrect results.
Calculate the K correction for an X-Spec apec model, with a source temperature of 6 keV and abundance of 0.3 solar, for the energy band of 0.5 to 2 keV:
>>> dataspace1d(0.01, 10, 0.01) >>> set_source(xsapec.clus) >>> clus.kt = 6 >>> clus.abundanc = 0.3 >>> calc_kcorr(0.5, 0.5, 2) 0.82799195070436793
Calculate the K correction for a range of redshifts (0 to 2) using an observed frame of 0.5 to 2 keV and a rest frame of 0.1 to 10 keV (the energy grid is set to ensure that it covers the full energy range; that is the rest-frame band and the observed frame band multiplied by the smallest and largest (1+z) terms):
>>> dataspace1d(0.01, 11, 0.01) >>> zs = np.linspace(0, 2, 21) >>> ks = calc_kcorr(zs, 0.5, 2, restlo=0.1, resthi=10)
Calculate the k correction for the background dataset bkg_id=2 for a redshift of 0.5 over the energy range 0.5 to 2 keV with rest-frame energy limits of 2 to 10 keV.
>>> calc_kcorr(0.5, 0.5, 2, 2, 10, bkg_id=2)