make_instmap_weights

Context: Tools::Response

Synopsis

make_instmap_weights - produces a weighted spectrum file usable with mkinstmap in order to create a weighted exposure map.

Syntax

make_instmap_weights  outfile model paramvals emin emax ewidth [abund]
[xsect] [verbose] [clobber]

Description

This tool creates a two-column ASCII file; the first column specifies the energy in keV (E_i) and the second column specifies a spectral weighting (W_i); from any Sherpa model. The spectral weight column should sum to 1. The spectral file is then used to compute the weighted instrument map as a linear combination of monochromatic maps at energies E_i with weights W_i for several energy-weight pairs. To learn more about spectral weightings and their affect on instrument maps, look at the "Calculating Spectral Weights for mkinstmap" analysis thread.

Examples

Example 1

unix% make_instmap_weights weights.txt "xsphabs.abs1*powlaw1d.p1"
paramvals="abs1.nh=2.2;p1.gamma=1.6" emin=0.5 emax=10.0 ewidth=0.25

Create a spectral weights table, weights.txt, using an absorbed power-law with spectral index of 1.6 and neutral hydrogen column density of 2.2E+22 cm**-2 between 0.5-10.0 keV, with 0.25 keV energy bins. Note that parameter values must be separated by a semi-colon and that the paramvals name had to be given on the command line since its value containined the "=" character.

The output file (weights.txt) can be used as the value for the spectrumfile parameter of mkinstmap.

Example 2

unix% make_instmap_weights weights.txt "xszphabs.abs1*xsapec.apec1"
paramvals="abs1.nh=2.2;abs1.redshift=1.3;apec1.kt=6.4;apec1.redshift=zab
s1.redshift" xsect="vern" abund="wilm"

Create a spectral weights table using a XSpec redshifted, absorbed APEC plasma model. The redshift of the plasma model is linked to the photoelectric absorption redshift parameter and the plasma temperature is set to 6.4 keV. The XSpec solar abundance, used in plasma models, is set to Wilms, Allen & McCray (2000, ApJ 542, 914) and the photoelectric cross-section is set to Verner et al. (1996, ApJ 465, 487).

Parameters

name	type	ftype	def	min	max	reqd
outfile	file	output				yes
model	string					yes
paramvals	string					yes
emin	real		INDEF			yes
emax	real		INDEF			yes
ewidth	real		INDEF			yes
abund	string		angr			no
xsect	string		vern			no
verbose	integer		3	0	5	no
clobber	boolean		no			no

Detailed Parameter Descriptions

Parameter=outfile (file required filetype=output default=)

The name of the spectral weights file to create.

The weights file created listing the energy bin center in keV in the first column and normalized weighting in the second column.

Parameter=model (string required default=)

Sherpa model used to derive spectral weighting.

Any Sherpa model(s) may be used to determine a spectral weighting, as long as the model is entered as a string. For example: "xsphabs.abs1*powlaw1d.p1".

Parameter=paramvals (string required default=)

Sherpa model parameters used to derive spectral weighting.

Model parameters listed as a string, with each parameter seperated by a semi-colon. For example: "abs1.nh=1.3;p1.gamma=1.7".

Parameter=emin (real required default=INDEF)

Lower bound of model energy range in keV.

Parameter=emax (real required default=INDEF)

Upper bound of model energy range in keV.

Parameter=ewidth (real required default=INDEF)

Width of each energy bin in keV.

Parameter=abund (string not required default=angr)

Set XSpec solar abundance.

Sets the elemental abundance table used in XSpec plasma-code models.

Parameter=xsect (string not required default=vern)

Set XSpec photoelectric cross-section.

Set the photoelectric cross-section used in XSpec absorption models.

Parameter=verbose (integer not required default=3 min=0 max=5)

Verbose can be from 0 to 5, generating different amounts of output.

Parameter=clobber (boolean not required default=no)

If set to yes, existing output files will be overwritten.

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.

Changes in the 4.12.1 (December 2019) release

Default cross-section table changed to vern

The default setting for the xsect parameter has been changed from bcmc to vern, to match the default behavior of the XSPEC 12.10.1 model library.

Bugs

There are no known bugs for this tool.