PCARMF (Jul09) ftools.xte PCARMF (Jul09)
NAME
pcarmf -- creates a .rmf file for an specified anode chain (i.e.
combination of layers) in a given pcu
USAGE
pcarmf outfile pcuid lld_code cdate chatter
DESCRIPTION
This task creates a response matrix for a particular pcu with 900
energy channels and 256 pulse height channels. Half of the 900
channels are between 0 and 10 keV; half are between 10 and 70 keV.
Channels are equally spaced within these ranges except that channel
boundaries are created at Xenon photoelectrc absorption edges.
Future versions may need more channels around the K edge. The user
specifies the desired pcu, anode chain, the name of the energy to
channel conversion file, and the date of the obsevation.
PARAMETERS
outfile [file name]
The name of the output .rmf file.
pcuid [integer]
The desired pcu. Note that the pcu's are numbered from 0 to 4.
lld_code [integer]
The desired lld code. The valid values are: (1, 2, 3) = (L1,
R1, L1+R1), (4, 8, 12) = (L2, R2, L2+R2), (16, 32, 48) = (L3,
R3, L3+R3), 63 = all xenon layers, 64 = propane layer. In
addition, users may specify the "back" layers, L2+R2+L3+R3,
using a value of 60.
(e2c_model = 3) [integer]
The energy to channel model. The only model supported by this
version is 3, which first translates the energy of the photon
into the number of secondary electrons, and then allows a
quadratic fit for channel number as a function of number of
electrons. The x-axis (number of electrons) is renormalized to
be approximately the energy for convenience for plotting inside
xspec.
(e2cfile = "caldb") [file name]
The name of the file containing the channel to energy
parameters. If e2cfile = CALDB, PCARMF will search the
calibration data base for the appropriate file, based on values
of pcuid, lld, e2c_model, and date. Any other string is
interpretted as a FITS file in the local directory, unless
nofits is set to 1.
(nofits = 0) [integer]
If this flag is 1, then c2efile is interpretted as the name of
a local ascii file with the parameters of channel to energy
conversion. For expert use only.
(scale_hack = 0) [integer]
If this flag is 1, then a fudge factor is applied to the
response matrix which forces the fit to the Crab for a
particular layer/detector to be the same as that obtained by
including all the layers and detectors. For expert use only.
(scale_file = "none") [file name]
If scale_hack = 1, this local ascii file is assumed to contain
the efficiency corrections. In absence of this file, no
correction is done. The file must contain 25 rows, each with
an energy and correction value. Efficiencies at energies below
the lowest tabulated value will not be changed, nor will
efficiencies above the highest tabulated value. For
intermediate energies, the efficency correction is a linear
interpolation between the nearest tabulated points. Note that
the energies must increase monotonically. For expert use only.
cdate [string]
The date of the observation, in the form yyyy-mm-dd.
chatter [integer]
Chatter parameter controlling how much to tell the user.
Larger values give more information.
(clobber = yes) [string]
Delete output file if it exists? (override with !filename)
(xe_gm_cm2_l1_p) [real*4]
Density in gm/cm^2 of Xe in layer 1. for each of the
detectors. The default value varies from detector to detector:
pcu0/1 0.0071; pcu2 0.0070; pcu3 0.0067; pcu4 0.0068
(xe_gm_cm2_l2_p) [real*4]
Density in gm/cm^2 of Xe in layer 2 for each of the detectors.
The default value varies from detector to detector:
pcu0/1/2 0.0058; pcu3 3C0.0055; pcu4 0.0057
(xe_gm_cm2_l3_p) [real*4]
Density in gm/cm^2 of Xe in layer 3 for each of the detectors.
The default value varies from detector to detector: pcu0
0.0057; pcu1 0.0056; pcu2 0.0058; pcu3 0.0054; pcu4 0.0057
(xe_gm_cm2_pr) [real*4]
The amount of xenon in the propane layer, given in gm/cm^2.
The default value varies from detector to detector: pcu0
12.2e-05; pcu1 8.88e-05;pcu2 12.9e-5;pcu3 18.3e-5;pcu4 16.4e-5.
(pr_gmcm2 = 0.00264) [real*4]
Density in gm/cm^2 of the Propane layer.
(my_gmcm2_p) [real*4]
Density in gm/cm^2 of the summed mylar windows. The default
value varies from detector to detector: pcu0 0.0071; pcu1 0.0072;
pcu2 0.0069; pcu3 0.0074; pcu4 0.0069
(al_gmcm2 = 12.0e-5) [real*4]
Density in gm/cm^2 of the summed aluminum.
(xe_gmcm2_dl = 0.0e-3) [real*4]
Density in gm/cm^2 of the Xenon cell boundary layer.
The default value varies from detector to detector: pcu0
2.23e-4; pcu1 1.93e-4; pcu2 4.2e-4; pcu3/4 5.1e-4
(xe_kedge_veto = 0.81) [real*4]
Non-self veto fraction above the K-edge.
(xe_ledge_veto = 0.91) [real*4]
Non-self veto fraction above the L3-edge.
(xeKedge = 34.561) [real*4]
Xenon K-edge energy in keV.
(xeL3edge = 4.782) [real*4]
Xenon L3 absorption edge in keV.
(xeL2edge = 5.104)
Xenon L2 absorption edge keV.
(xeL1edge = 5.453) [real*4]
Xenon L1 absorption edge keV.
(EscFracKb = 0.3) [real*4]
The fraction of events above the Xenon K-edge which are
detected in the Xenon K-Beta escape peak. Version 1.0 of
PCARMF treats this fraction as independent of LLD, and
independent of energy. Brookhaven data suggest that this ratio
may vary by ~ 10 % as energy varies from 34-60 keV
(EscEnerKb = 33.62) [real*4]
The offset in keV of the Xenon K-Beta escape peak.
(EscFracKa = 0.39) [real*4]
The fraction of events above the Xenon K-edge which are
detected in the Xenon K-Alpha escape peak. Version 1.0 of
PCARMF treats this fraction as independent of LLD, and
independent of energy. Brookhaven data suggest that these
assumptions are justified.
(EscEnerKa = 29.70) [real*4]
The offset in keV of the Xenon K-Alpha escape peak.
(EscFracL1 = 0.000) [real*4]
Fraction of L-alpha escape for 1st layer.
(EscFracL2 = 0.008) [real*4]
Fraction of L-alpha escape for 2nd layer.
(EscFracL3 = 0.021) [real*4]
Fraction of L-alpha escape for 3rd layer.
(EscEnerLa = 4.110) [real*4]
Energy in keV of the L-alpha escape photon.
(DeltaE_L3 = 0.085) (DeltaE_L2 = 0.032) (DeltaE_L1 = 0.012) (DeltaE_K = 0.180)
The offset, in keV, in the channel to energy law observed at
the Xenon edges. The default values are from the literature.
The values that are reported to XSPEC as the channel boundaries
are not always strictly adjacent; this is necessary for display
purposes in energy space, but causes some gaps for some display
options. The calculation is believed to get the effective
channel width correctly.
(delta_el_L = 3.9) [real*4]
Electron offset for L escape.
(delta_el_Ka = -2.26) [real*4]
Electron offset for K-alpha escape.
(delta_el_Kb = 3.84) [real*4]
Electron offset for K-beta escape
(LBL_sigma = 11.0) [real*4]
Use LBL Xenon cross sections ?
(energy_scale = 1.0) [real*4]
Fudge on channels per keV.
(area_factor = 1.0) [real*4]
Global (multiplicative) area fudge factor.
(epoint = 18.3) [real*4]
Reference energy for electron tracks.
(track_coeff = 0.038) [real*4]
Coefficient for electron tracks.
(track_exp = 3.3) [real*4]
Exponent for electron tracks.
(resolution_factor = 0.10) [real*4]
Multiplicative coefficient on resolution.
(pcc_coeff = 0.0138) [real*4]
Partial charge coefficient.
(w_xe_fact = 0.475) [real*4]
Scale factor for w_xe.
(xe_pr_daily_change) [real*4]
Daily increase of xenon in propane layer, for each detector.
(cdate0_ = "1997-12-20") [real*4]
Reference date for xenon increase in propane layer for each detector.
(xe_gm_cm2_pr_p) [real*4]
The amount of xenon in the propane layer on the second reference
date, given in gm/cm^2. As of v11.7 release (July 2009) only valid for PCUs
0 and 1.
(xe_pr_daily_change_p) [real*4]
Daily increase in xenon in propane layer after the second reference date
for each detector. As of v11.7 release (July 2009) only valid for PCUs
0 and 1.
(cdate1_) [real*4]
Second reference date for xenon in propane layer. For PCUs 0 and 1
is effectively a date of the propane layer loss. For other PCUs not
valid (as of July 2009).
EXAMPLES
1.
2.
NOTES:
BUGS
PCARMF.V11.7
Please report problems to xtehelp@athena.gsfc.nasa.gov.
SEE ALSO