NAME

USAGE

DESCRIPTION

The xteprefilter task produces a prefilter-style filter file for an RXTE observation. It is meant to be used with pcaprepobsid, but can be run individually.

The prefilter task can select many more orbit and angle related columns compared to the standard xtefilt task. Thus, it may be useful for additional screening of data. This task is meant to supplement, and not replace, the standard XTE filter file. The XTE filter file (*.xfl) should be kept, and the new prefilter-style file (*.mkf) can be used to do additional screening.

By default the task will consult the existing xtefilt-generated filter file (FP*.xfl) for various information such as RA, Dec, and time selections. However, the user can override this. Also, the user can decide which columns for prefilter to calculate, if the default value is insufficient.

In addition to the xtefilt-generated filter file, the task needs access to the observation's orbit and attitude files which should be found in the standard observation directory locations (obsid/orbit and obsid/acs/FH0e*), which the user must specify.

PARAMETERS

orbfile [filename]

Name of RXTE orbit file for an observation. This file will be located in obsid/orbit/FP*.

attfile [filename]

Name of RXTE attitude file for an observation. This file will be located in obsid/acs/FH0e*.

xflfile [filename]

Name of filter file generated by xtefilt. This file will have a name of the form FP*.xfl, and may be located in obsid/stdprod/FP*.xfl, or may be another name if the user has recreated it.

mkfile [filename]

Name of the output prefilter-style (*.mkf) file.

(filtcolumns="ALLV6 SUN_BODY_VECT EARTH_BODY_VECT") [string]

Columns that prefilter is required to compute. Please see the help file for prefilter for more information.

(ra="INDEF") [string]

Right ascension of target in J2000 degrees. Use INDEF to query the value from the xflfile.

(dec="INDEF") [string]

Declination of target in J2000 degrees. Use INDEF to query the value from the xflfile.

(tstart="INDEF") [string]

Start time of the filter file, in MET seconds. Use INDEF to query the value from the xflfile.

(tstop="INDEF") [string]

Stop time of the filter file, in MET seconds. Use INDEF to query the value from the xflfile.

(timestep="INDEF") [string]

Time sample of the filter file, in seconds. Use INDEF to query the value from the xflfile.

(cleanup="YES") [boolean]

If yes, then clean up temporary files. If no, temporary files remain. This is typically for debugging.

(clobber = NO) [boolean]

If the output file already exists, then setting "clobber = yes" will cause it to be overwritten.

(chatter = 1) [integer, 0 - 5]

Controls the amount of informative text written to standard output. Setting chatter = 4 or higher will produce detailed diagnostic output; chatter = 1 prints out a basic diagnostic message. The default is to produce a brief summary on output.

(history = YES) [boolean]

If history = YES, then a set of HISTORY keywords will be written to the header of the specified HDU in the output file to record the value of all the xteprefilter task parameters that were used to produce the output file.

SEE ALSO

prefilter

xtefilt

pcaprepobsid

LAST MODIFIED