NeSDaC
wgtiflt
<![CDATA[
WGTIFLT (may95) ftools.saxwfc WGTIFLT (Nov95)
NAME
wgtiflt -- Filters a FITS table by selecting only the rows that have
a time stamp within an specified set of time intervals.
Additionally removes and stores events located in any of a number
of given areas into a separate new FITS file.
USAGE
wgtiflt infile gtifile outfile [coptions]
DESCRIPTION
Selects rows from in input FITS table and writes them to an
output table if the time stamp for that row falls within one of an
input set of "Good Time Intervals" (GTIs).
Optionally removes and stores events located in any of a number
of given areas into a separate new FITS file. These clip areas are
defined in an instrument calibration file.
Automatically the parameters that are read in will be copied
in the Primary Header of each FITS file.
Records with bad (=negative time) are always removed.
PARAMETERS
infile [string]
The name and extension number in square brackets of the input
FITS table extension containing the list of events to be
filtered. If no extension is given the complete file with all
its extension will be processed.
gtifile [string]
The name of the Good Time Interval FITS file to be used to
filter the input table. This is a FITS table or bintable
extension which contains 2 columns defining the start and stop
times of a set of Good Time Intervals. The column values in
this table are given in units of seconds relative to a start
time specified in the extension header (see the description
of the gtidate and gtitime parameters).
outfile [string]
The name of the output "filtered" FITS table containing the
selected events from the input file. This table will contain
the same number and orderof columns contained in the input
table. If the copyall parameter is set equal to 'no' then this
FITS file will consist of a null primary array followed by a
table or bintable extension (depending on the type of the input
extension).
(clipout=yes) [boolean]
If YES, then the task will clip and store events located in a
a number of given areas into a separate new FITS file.
(clipfile=" ") [string]
The name of the output "clipped" FITS table containing the
selected events from the input file which are located in a
a number of given rectangular areas. This table will contain
the same number and order of columns contained in the input
table. It is useful to get the counts of the In-Flight
Calibration sources in a file for separate processing.
(calfile1="-") [string]
The name of the input FITS file that contains the coordinates
of the area boxes used for clipping and storing all events being
located in any of these rectangulars. The data only pertains to
events of SAX WFC-1. The purpose is to store separately all the
events that come from the In-Flight Calibration sources for
further gain calculations. For a description of the relevant
table in this file, see TBD.
(calfile2="-") [string]
Same as for calfile1, only used for SAX WFC-2
(tcolumn="WFC_TIME") [string]
The name of the column in INFILE that contains the time stamp
value that is used to determine if that row falls within one of
the input Good Time Intervals. The values in this column
should be in units of seconds relative to the start time ??
specified by the obsdate and obstime keywords in the header of
the extension.
(xcolumn="RAWX") [string]
Name for the column in the in/output file containing the X
coordinate of the pixel.
(ycolumn="RAWY") [string]
Name for the column in the output file containing the Y
coordinate of the pixel.
(obsdate="-") [string]
The name of the keyword containing the reference date in the
input events table. The value can either be blank (or "-") to
defeat the reference checking, in julian days or in 'dd/mm/yy'
format.
(obstime="MJDREF") [string]
The name of the keyword containing the reference time in the
input events table in 'hh:mm:ss.ddd' format. This parameter is
only used if obsdate is in dd/mm/yy format.
(obsunit="T_UNIT") [string]
The name of the keyword containing the units of the time column.
If omitted unites of 1 second are assumed.
(gticols="START,STOP") [string]
The name of the columns in GTIFILE containing start and stop
times.
(gtidate="MJDREF") [string]
The name of the keyword containing the reference date in the
input GTI table. The value can either be blank (or "-") to
defeat the reference checking, in julian days or in 'dd/mm/yy'
format. It must have the same format as the obsdate parameter.
(gtitime="-") [string]
The name of the keyword containing the reference time in the
input GTI table in 'hh:mm:ss.ddd' format. This parameter is
only used if obsdate is in dd/mm/yy format.
(exposure="ONTIME") [string]
The name of the keyword containing the exposure time in the
input and output FITS file. If the keyword doesn't exist it
will be created.
(clipout=yes) [boolean]
If YES, then the task will clip and store events located in a
a number of given areas into a separate new FITS file.
(copyall=yes) [boolean]
If the copyall parameter is set equal to 'NO' then the output
FITS files will consist of a null primary array followed by a
table or bintable extension (depending on the type of the input
extension). If copyall equal YES, then the primary array and
any other extensions in the input file will also be copied to
the output file.
(verbsty=0) [integer]
The verbosity level will control the output volume.
EXAMPLES
1. Filter the second extension in a FITS file named events.fits
using a GTI file named gti.fits and place filtered results in the
FITS file out.fits. All other parameters take on their default
values.
ft> wgtiflt events.fits[2] gti.fits out.fits
2. Filter all extensions in a FITS file named events.fits using
a GTI file named gti.fits and place filtered results in the FITS
file out.fits. The COPYALL flag is set to yes, thus copying the
primary array and any other extensions in the input file to the
output file.
ft> wgtiflt events.fits gti.fits out.fits COPYALL=yes
KNOWN BUGS
'obsdate' and 'obstime' does not work like documented. For WFC
only 'obsdate = -' and 'obstime = MJDREF' will work properly.
SEE ALSO
fltime, mgtime, maketime, wmakgti, wmrggti
]]>
Back to: