Last modified: December 2023

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/xszmshift.html
AHELP for CIAO 4.16 Sherpa

xszmshift

Context: models

Synopsis

The XSPEC zmshift convolution model: redshift a multiplicative model.

Syntax

xszmshift

The xszmshift model is a convolution model component.

Description

The model is described at [1] .


Example

>>> create_model_component("xszmshift", "mdl")
>>> print(mdl)

Create a component of the xszmshift model and display its default parameters. The output is:

mdl
   Param        Type          Value          Min          Max      Units
   -----        ----          -----          ---          ---      -----
   mdl.Redshift frozen            0       -0.999           10           

ATTRIBUTES

The attribute for this object is:

Attribute Definition
Redshift The redshift.

Notes

Unlike XSPEC, the convolution model is applied directly to the model, or models, rather than using the multiplication symbol.

References

Changes in CIAO

Added in CIAO 4.13

XSPEC version

CIAO 4.16 comes with support for version 12.13.1e of the XSPEC models. This can be checked with the following:

% python -c 'from sherpa.astro import xspec;
print(xspec.get_xsversion())'
12.13.1e

Bugs

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

See Also

models
xsvmshift, xszashift