NAME
cdi - create a detector-image from one or several eventfile(s)
SYNOPSIS
* cdi
* cdi -p [options] evl di
The program can be started with no arguments at all, in which case the
parameter values are taken from the parameterfile.
Alternatively, values can be passed via the commandline, the required items
as command arguments, the optional ones as valued switches.
The table lists all the parameters used by cdi, the second column lists the
paramater key names used in the parameterfile, the first column gives the
corresponding switch letter,
cdi parameters
switch key value IO description
expfile stringo di, detector image file (FITS).
evtfile list i evl, simple eventfile or list of eventfiles.
I insfile stringi overrides the IDF name as inferred from the
(first) input eventfile.
the event selection time intervals are read from
the g(ood)t(ime)i(nterval) file gti. Default
action is to apply the HK data based gti-file
g gtifile stringi created during WFC-StageI.
Explicit selection of a time interval (-t,-T)
cancels the automatic use of the gtifile, an
explicit -g filename will be used.
select events within one of the time intervals,
events from the intervals are gathered into one
image. The time interval must be specified in
modified julian days (MJD). By default, all
t t_filtr range i events are used. The time unit is not
particularly easy to use, the numbers are large
and do not readily relate to a date, however it
allows you to select any event detected over the
WFC's life time. Several interval can be
specified in the form of a comma separated list.
as -t, however the interval time(s) is in seconds
from the start time of the first input(event)
T t_ftrsec range i file.
(if both -t and -T are present, the -T switch is
ignored.
for a value e0-e1 assemble a detector image,
selecting events with an energy in the
WFC-channel range from e0 to e1 (incl). You can
specify more ranges (up to 32), each range
e e_filtr range i defines a detector image. The images are stored
as a 3 dimensional FITS image. The default value
of this parameter is 1-31, ie. generate 1 image
with no energy resolution, all events are
accumulated in one detector image.
Select events detected in the lower (-z0 (equiv.
z z_filtr range i -z0-0)) or the upper ((-z1) detector compartment.
default value is (-z0-1), do not discriminate.
area= x0-x1:y0-y1. Select events with a detector
coordinate in a rectangle with lower left corner
p p_filtr area i (x0,y0) and upper right corner (x1,y1). Several
area's can be specified in the form of a comma
separated list.
select events detected under a support structure
w wsbar int i bar (i= 1) or only those events NOT under such a
bar (i= -1). (i= -1 is not equivalent to a run
with no -w parameter at all. ........ explain)
append to the outputfile a count vs. time
histogram (lightcurve) of the events in the form
of a FITS Binary table. The parameter value
b tbin real i specifies the resolution (time-bin length) in
seconds. The table will contain a column for
every detector plane created, only the events
selected for the image are used in the lightcurve
In cases of non-nominal satellite stability, the
StageI processing software has the option to
partition the observation period in a number of
intervals. For each interval a nominal instrument
pointing is computed, event detector(!)
coordinates are corrected for drift within this
interval and the event is labeled with the
interval's index. The -b switch selects the
f b_filtr int i events with a particular range of pointing
indeces. (b0 is equivalent to b0-b0). Currently,
the StageI software deos not provide this
functionality.
(Alternative - we may delete this procedure, as
the pointing clusters define a event partition in
time also, providing the user with the time
intervals for a selected pointing makes this
event labeling superfluous.)
p debug int i only as first commandline argument: ignore
parameterfile, set debuglevel. general
i title stringi file title, description cq. comments. general
L logfile stringi redirect diagnostic and informational messages.
see general
mode "ql" i has meaning for (some) parameterfile
parsers/readers only.
DESCRIPTION
Read one or more eventfiles, creating a 2 (or 3) dimensional image.
-binning- detector pixel size as defined in the instrument data file used.
-linearisation-
EXAMPLE
We have 2 eventfiles
* WOP816_0034w2prn1.fits
* WOP816_0036w2prn1.fits
the command (assuming valid environment variables are set)
cdi -p2 -e2-12,13-25 -b2.0 WOP816_0034w2prn1.fits,WOP816_0036w2prn1.fits WOP816
produces the follwing output
===============================================================================
cdi Tue Jan 7 17:24:06 1997 page 1
------------------------------------------------------------
[E]cdi_defaultgtiname: cannot extract gti filename from "WOP816_0034w2prn1.fits"
+ use "-g gtifile" (parameter gtifile) to override default.
(StageI standard software produces a gti file with a default name, cf.
StageI naming conventions)
[1]evt_assemble: tstart=50317.32992, tend=50317.45865, 5562 bins
[1]evt_open: "WOP816_0034w2prn1.fits"[SCI_NM], 1 of 2.
+ time 50317.32992 - 50317.38663 (MJD) [ 4899.73 sec.]
[1]evt_open: "WOP816_0036w2prn1.fits"[SCI_NM], 2 of 2.
+ time 50317.39621 - 50317.45865 (MJD) [ 5394.96 sec.]
evt_assemble: scanned 2 files, accepted 6266656 events in detector image
9830.385 sec. exposure time, starting (UT) Thu Aug 22 07:55:04 1996
and produces a file WOP816.exp. The ftool fstruct run on WOP816.exp produces
No. Type EXTNAME BITPIX Dimensions(columns) PCOUNT GCOUNT
0 PRIMARY -32 680 680 2 0 1
1 BINTABLE WFC_Eventspec 8 16(4) 32 0 1
2 BINTABLE WFC_DetLcv 8 8(1) 5562 0 1
The created file contains a
* PRIMARY FITS IMAGE (NAXIS=3), containing two 2-dimensional detector
images, the first with events with an energy in the range 2-12
(channels), the second in the range 13-25.
* BINARY TABLE extension WFC_Eventspec list the number of events found in
each channel. though there are 32 columns, only channels 2-25
(2-12+13-25) as selected, are filled.
* BINARY TABLE extension WFC_DetLcv list the number of events found in 2
second wide timebins, the table has 1 entry, an array with 2 elements
(real (4byte) data-type, hence the 8byte width reported by fstruct),
the lightcurve for the first and second energy range respectively.
NOTE
SEE ALSO