NAME

xafilter - Generates an EHK file and a MKF filter file for XRISM

USAGE

xafilter mkconf attfile orbfile reference outehkfile outmkffile

DESCRIPTION

The xafilter task runs the xamkehk task to generate an extended housekeeping file, using orbit and attitude files for a given observation. The task then runs makefilter to generate an MKF filter file from an input configuration file. This MKF file combines information from various instrument, general housekeeping, and auxiliary files for a given observation, into a common time-ordered data file. The EHK and MKF files are used to filter the science (event) data.

The task xafilter takes an input configuration file that is either an ASCII file or a FITS file, possibly stored in calibration database, CalDB. The configuration file contains the file name, extension, and column names of the parameters that need to be sampled, as well as other characteristics; see the help file for makefilter for details on configuration file format requirements. If the user supplies an input FITS configuration file, the extension should be named MKCONF. The tool also requires an observation-specific attitude file ('attfile') and orbit file ('orbfile') that describe the location and pointing of the telescope; these files are used as input to xamkehk. An optional time reference file ('reference') and additional CalDB files describing the orbit ('cor2file', 'cor3file', 'saafile', 'teldeffile', 'rsl_teldeffile') and time sampling parameters of the EHK output file ('tsart', 'tstop', 'bintime', 'textend'), are also passed to xamkehk. See the help file for xamkehk for details.

This task outputs an MKF file produced by makefilter, and an EHK file produced by xamkehk. These files can be further used with 'maketime' to create good time intervals (GTI) based on specified filtering criteria. See the help for those tools for more information.

PARAMETERS

mkfconf [filename CALDB|file name]
Input makefilter configuration file.

attfile [filename]
Input attitude file.

orbfile [filename]
Input orbit file, assumed to have the same format as Suzaku version 2 orbit files.

reference = NONE [filename NONE|file name]
Reference file supplying the actual time points to be calculated for the output file, overriding the 'tstart' and 'tstop' parameters; the 'bintime' parameter is not relevant when a reference file is supplied. If set to NONE, the start and stop times are obtained either from the input parameters 'tstart' and 'tstop', or they supplied by the input attitude file.

(teldeffile = CALDB) [filename CALDB|file name]
Name of the Xtend teldef file giving the coordinate systems of the XTD instrument, used to obtain SKY to FOC coordinate transformation parameters. If set to CALDB, the file is read from the calibration database.

(rsl_teldeffile = CALDB) [filename CALDB|file name]
Name of the Resolve teldef file giving the coordinate systems of the RSL instrument, used to obtain higher coordinate transformation parameters. If set to CALDB, the file is read from the calibration database.

(leapsecfile = CALDB) [filename CALDB|file name]
Name of the file giving the table of leap seconds. If set to CALDB, the file is read from the calibration database.

(cor2file = CALDB) [filename CALDB|file name]
Name of the file that provides the cutoff rigidity, as a function of terrestrial coordinates, used to fill the COR2 column. If set to CALDB, the file used for Suzaku is read from the calibration database.

(cor3file = CALDB) [filename CALDB|file name]
Name of the file that provides the cutoff rigidity, as a function of terrestrial coordinates, used to fill the COR3 column. If set to CALDB, the file calculated for the year 2016.0, based on the IGRF 2015 data (https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html), is read from the calibration database.

(saafile = CALDB) [filename CALDB|file name]
Name of the file which contains the vertices that define the SAA (South Atlantic Anomaly) for each instrument. If set to CALDB, the file is read from the calibration database.

outehkfile [filename]
Name of output EHK file.

outmkffile [filename]
Name of output makefilter (MKF) file.

(attext = ATTITUDE) [string]
Name of the extension in the attitude file ('attfile') with pointing information.

(attform = EULER) [string EULER|QUAT]
Format of the input attitude column in the 'attext' extension of 'attfile'.

(attcol = EULER) [string]
Name of the input attitude column in the 'attext' extension of 'attfile'.

(orbext = ORBIT) [string]
Name of the extension in the orbit file ('orbfile').

(orbform = KEPLERIAN) [string VECTOR|COMPONENTS|KEPLERIAN]
Format of the input orbit velocity column in the 'orbext' extension of 'orbfile'.

(orbcol = A,E,I,AN,AP,MA) [string]
Name of the input orbit column in the 'orbext' extension of 'orbfile'.

(timecol = TIME) [string]
Name of the column containing mission time in the reference file.

(tstart = 0.0) [double]
Start of mission time interval [s] of the output file. If either 'tstart' or 'tstop' parameters are 0.0, the time interval is set equal to the time range of the reference file if there is one, or else to that of the attitude file.

(tstop = 0.0) [double]
End of mission time interval [s] of the output file. If either 'tstart' or 'tstop' parameters are 0.0, the time interval is set equal to the time range of the reference file if there is one, or else to that of the attitude file.

(bintime = 1.0) [double]
Time sampling interval [s] of the output file. This parameter is not relevant if a reference file is used to supply the time points (see parameter 'reference').

(textend = 0.0) [double]
Time [s] added to the beginning and end of the output file time interval, preceding the 'tstart' parameter and the following 'tstop' parameter.

(infileroot = ) [string]
Prefix of the input HK files for applying the 'mkconf' file.

(buffer = -1) [integer -1|0|N]
Rows to buffer (-1=auto, 0=none, N>0=number of rows).

(cleanup = yes) [boolean yes|no]
Delete temporary files if 'cleanup=yes'.

(clobber = no) [boolean yes|no]
Overwrites existing output files if set to yes.

(chatter = 2) [integer 0|1|2|3]
Chatter level for output. Set to 0 to suppress output, or to 1, 2, or 3 for increasing the chatter of the output.

(logfile = !DEFAULT) [string DEFAULT|NONE|file name]
Log file name. If set to DEFAULT, uses the name of the task and, if preceded by "!", overwrites the file if it exists. If set to NONE, no log file is created.

(debug = no) [boolean yes|no]
Diagnostic output is printed to the screen if set to yes.

(history = yes) [boolean yes|no]
Records task parameters in HISTORY.

EXAMPLES

1. Run xafilter using the configuration file in CalDB, and the attitude, orbit, and housekeeping files corresponding to the sequence 100050020.

    xafilter mkfconf=xa_gen_mkfconf_20191001v004.fits attfile=xa100050020.att orbfile=xa100050020.orb reference=NONE \
    outehkfile=xafilttest1.ehk outmkffile=xafilttest2.mkf infileroot=xa100050020 clobber=yes
    

SEE ALSO

xamkehk, makefilter, maketime

LAST MODIFIED

November 2, 2023