mktgresp

Context: Tools::Response

Synopsis

Create ARF and RMF files for each spectral order and grating arm in a TypeII PHA file

Syntax

mktgresp  infile evtfile outroot [orders] [wvgrid_arf] [wvgrid_chan]
[asolfile] [bpixfile] [mskfile] [dtffile] [pbkfile] [dafile] [osipfile]
[parallel] [nproc] [verbose] [clobber]

Description

The 'mktgresp' tool will create the ARF and RMF for each spectral order and grating arm in a Type II PHA file. It runs the mkgrmf tool and the fullgarf script with the appropriate inputs using the energy and channel grids.

For ACIS data, the default PHA files will have 12 spectra for HETG: +/- 3 orders for each MEG and HEG, and 6 for LETG: +/- 3 orders. Since HRC lacks energy resolution, the spectra cannot be order separated so there are only 2 spectra: +/- 1 which represents the contribution from all orders.

The tool will automatically try to locate the auxiliary files needed to make the response products: aspect solution, bad-pixel file, mask, dead time factors (HRC only), and parameter block (ACIS only). If any of these cannot be found, it will produce an error and users will need to set the file name via the parameter file.

Examples

Example 1

unix% mktgresp acis_repro_pha2.fits acis_repro_evt2.fits acis_repro

The ARF and RMF for each spectral order and grating arm in the input PHA file is created using the default energy and channel grids.

unix% /bin/ls acis_repro*.arf acis_repro*.rmf
acis_repro_heg_m1.arf  acis_repro_heg_p2.arf  acis_repro_meg_m3.arf
acis_repro_heg_m1.rmf  acis_repro_heg_p2.rmf  acis_repro_meg_m3.rmf
acis_repro_heg_m2.arf  acis_repro_heg_p3.arf  acis_repro_meg_p1.arf
acis_repro_heg_m2.rmf  acis_repro_heg_p3.rmf  acis_repro_meg_p1.rmf
acis_repro_heg_m3.arf  acis_repro_meg_m1.arf  acis_repro_meg_p2.arf
acis_repro_heg_m3.rmf  acis_repro_meg_m1.rmf  acis_repro_meg_p2.rmf
acis_repro_heg_p1.arf  acis_repro_meg_m2.arf  acis_repro_meg_p3.arf
acis_repro_heg_p1.rmf  acis_repro_meg_m2.rmf  acis_repro_meg_p3.rmf

Example 2

unix% mktgresp hrc_repro_pha2.fits hrc_repro_evt2.fits hrc_repro
orders=-3,-2,-1,1,2,3

Since HRC does not have sufficient energy resolution to sort orders, the grating PHA file calls the spectra the +1, and -1 orders, but they are actually sum of all spectral orders. For proper analysis, users should include the higher order ARFs and RMFs in their analysis. The "orders" parameter can be set to the list of orders required (typically up to 8th to cover the array). (Note: both positive and negative orders must be specified.)

unix% /bin/ls hrc_repro*.arf hrc_repro*.rmf
hrc_repro_leg_m1.arf  
hrc_repro_leg_m1.rmf  
hrc_repro_leg_m2.arf  
hrc_repro_leg_m2.rmf  
hrc_repro_leg_m3.arf  
hrc_repro_leg_m3.rmf  
hrc_repro_leg_p1.arf  
hrc_repro_leg_p1.rmf  
hrc_repro_leg_p2.arf
hrc_repro_leg_p2.rmf
hrc_repro_leg_p3.arf
hrc_repro_leg_p3.rmf

Parameters

name	type	def	min	max	units	reqd	stacks
infile	file					yes
evtfile	file					yes
outroot	file					yes
orders	string	INDEF				no
wvgrid_arf	string	compute			Angstrom	no
wvgrid_chan	string	compute			Angstrom	no
asolfile	file					no	yes
bpixfile	file					no
mskfile	file					no
dtffile	file					no
pbkfile	file					no
dafile	file	CALDB				no
osipfile	file	CALDB				no
parallel	boolean	yes				no
nproc	integer	INDEF	1			no
verbose	integer	1	0	5
clobber	boolean	no

Detailed Parameter Descriptions

Parameter=infile (file required)

Input type II pha file

The input type II PHA file produced by either tgextract or tgextract2.

Parameter=evtfile (file required)

Input event file

The input event file with the extraction region attached. This file is also used to locate the auxiliary files with the information stored in the header.

Parameter=outroot (file required)

Output path and root file name for the products

The output file name will be

${root}_${arm}_${pm}${order}.${type}

where ${root} is this parameter. ${arm} is the grating arm: 'leg', 'meg', or 'heg'. ${pm} is 'p' for positive/plus orders and 'm' for minus/negative orders. ${order} is the integer order number: for ACIS the default PHA file will have orders '1', '2', and '3'. For HRC, only '1'. The ${type} identifies the file as either 'arf' or 'rmf'.

Parameter=orders (string not required default=INDEF)

The list of orders to create grating responses.

By default, orders="INDEF", mktgresp will create response file for each order (tg_m) value in the infile spectrum. However, for HRC/LETG observations, users may want to create higher order responses and/or ACIS users may want to only create first order responses (especially for faint sources). If this parameter is set, the orders listed will be created for each grating arm (tg_part) and source in the infile.

Parameter=wvgrid_arf (string not required default=compute units=Angstrom)

Wavelength grid of rmf and arf

Wavelength grid for the arf specification string. This string may specify compute, a file, or an explicit energy grid. For example, to use a grid for the MEG that ranges from 1 to 41.96 angstroms with 8192 channels set. The units for this parameter is angstroms.


  wvgrid_arf="1.0:41.96:#8192"

This is the same grid that you would get with


  wvgrid_arf=compute

The default grids for the three grating types are

Grating type	wvgrid_arf
MEG	1.0:41.96:#8192
HEG	1.0:21.48:#8192
LEG	1.0:205.8:#16384

Parameter=wvgrid_chan (string not required default=compute units=Angstrom)

Enter channel-side wavelength grid [angstroms]

Specification string for the channel side wavelength grid. This string may specify compute, a file, or an explicit energy grid. In general this is set to be the same as the arf grid. However, there is no compelling reason that the fitting engine needs the ARF and the RMF on the same grid so this has been left as a user adjustable parameter. The units for this parameter is angstroms.