Display the time-dependent gain correction for a given chip location.
show_tgain_corr chipid chipx chipy [outdev] [outfile] [type] [title]
[scriptfile] [clobber] [verbose]
This tool displays the size of the time-dependent gain
correction - i.e. how much the energy or PHA value of an event
changes - for a given source location (chip number and
location). The units of the plot are controlled by the type
parameter (either "energy" or "pha"). The tool can create the
plot either in a X-window (outdev="xserve") or to a file
(outdev="cps" or outdev="gif").
This script is intended to help users who want to
know whether they need to re-process their ACIS data to include
the time-dependent gain correction. This correction, which is
discussed on the CIAO web site, varies with location and observation time. The
correction is calculated for a single location and a range of
times.
unix% show_tgain_corr 3 962 964 title="ACIS I3 aimpoint"
This creates a plot in a X-window which shows the correction for an on-axis source observed with ACIS-I3. The units of the plot are energy.
The title parameter is used to add text to the start of the plot title.
unix% show_tgain_corr 3 962 964 title="ACIS I3 aimpoint" type=pha
This creates a plot in a X-window which shows the correction for an on-axis source observed with ACIS-I3. The units of the plot are PHA.
unix% show_tgain_corr 7 252 510 title="ACIS S3 aimpoint"
outfile=corr.ps outdev=cps
This creates a postscript file (corr.ps) which show the correction for an on-axis source observed with ACIS-S3.
unix% show_tgain_corr 7 252 510 title="ACIS S3 aimpoint"
outfile=corr.gif outdev=gif
This creates a GIF file called corr.gif.
Parameter=chipid (integer required default=3 min=0 max=9)
ACIS chip number
This parameter is used to define which ACIS chip you wish to see the correction for. The allowed parameters are 0-9 (for the 10 chips ACIS-0
to ACIS-9).
Parameter=chipx (integer required default=962 min=1 max=1024)
ACIS chip x coordinate
This parameter specifies the X coordinate of the location of the ACIS chip to use for the correction.
Parameter=chipy (integer required default=964 min=1 max=1024)
ACIS chip y coordinate
This parameter specifies the Y coordinate of the location of the ACIS chip to use for the correction.
Type of output file
What device should be used to display the plot. The allowed values are:
- xserve - display the plot in a X-window
- cps - create a postscript file
- gif - create a GIF file
Output file (if outdev is not xserve)
The name of the file in which the plot should be stored. This parameter is ignored if outdev=xserve.
Units for the plot
Should the correction be displayed as a function of energy or PHA?
Title string (can be blank)
If the title parameter is blank then the plot title lists the CCD number and chip coordinates of the location used to calculate the correction. Otherwise the contents are used as the plot title, with the location appended to the end of the string after being surrounded by "[]" characters.
Parameter=scriptfile (file filetype=input default=./show_tgain_corr.sl)
File containing the S-Lang function show_tgain_corr()
The function used to create the plot is stored in a separate file to the tool. This parameter is used to specify the location of the file.
It is unlikely that this parameter needs to be changed from its default value.
Verbose level
If set to a non-zero value then the tool will
output extra information when run.
This information is only likely to be useful when debugging the
tool.
|
![[CIAO Logo]](../imgs/ciao_logo_navbar.gif){kind=logo}