NAME

xtedatamode - Summarize XTE PCA / HEXTE science data files

USAGE

         xtedatamode indir outfile 

DESCRIPTION

xtedatamode provides a summary of XTE data files for a given observation.

The task scans an observation directory and creates a summary of the contents of each science file. By default, both the PCA and HEXTE instrument subdirectories are scanned, but this is controlled by the subdirs parameter.

At the default chatter level of 1, a textual table is printed to the console that describes each found file. The task also creates a text-delimited file for machine parsing.

The user specifies the input observation directory. The user may also optionally supply which instrument subdirectories to search using the subdirs parameter (which defaults to "pca,hexte" to scan both instrument directories.

The console table prints one line per science file. The columns in the table are:

• Filename - name of the file with path and suffix components stripped away
• EA - for PCA, the EDS Event Analyzer slot used, or for HEXTE which HEXTE cluster
• Inst - which instrument the file represents (PCA or HEXTE)
• Kp - whether this file should be kept for analysis or not, based on several heuristics
• DataMode - the instrumental DATAMODE used to collect the data in the file
• Nch - number of spectral bins available in the file, or 0 for unbinned or single-binned data
• DLCG - a set of flag columns, indicating whether the file has selectable information. Here "selectable" means the user can request a subset of this data type. For example, PCA Standard2 has selectable detector, layer and channel information, but most binned modes have summed over detector and layer so would not be selectable for those attributes.
  • D - whether the file contains selectable detector information
  • L - whether the file contains selectable PCA layer information
  • C - whether the file contains selectable channel information
  • G - whether the file has been gain corrected on-board or not
• TimeBn - human-readable time bin or time resolution size. For event modes, this is the resolution of the event timestamp. For some binned modes, more than one sample is present per FITS row and TimeBn is the time window of a single sample.
• TStart - Start time of the data file, offset from reference time, as hh:mm. For observations that span more than one day, this will appear as DDD+hh:mm where DDD is a day offset.
• Dur - Duration of the file, as Stop-Start, and ignoring any gaps, as hh:mm

The output file is a more detailed, machine parsable textual table containing similar information.

PARAMETERS

indir [filename]

Name of input directory containing a single RXTE observation ID. The input directory must be structured as it is stored in the archive, i.e., an FMI file, subdirectories named pca/, acs/, and so on.

outfile [filename]

Name of output file for a detailed machine-parsable table of information. Set to "-" for standard output, or "NONE" to disable output. Since temporary files are created using this output filename, if "-" or "NONE" are specified, then the current working directory is used for temporary files, so care must be taken to be sure the current working directory is writable.

(subdirs = 'pca,hexte') [string]

Name of subdirectories to scan for XTE science files.

(fieldsep = '||') [string]

Field separator to use for the outfile. Do not use a comma because internal string values may have a comma.

(matchglob = "{FS*,SE*.evt*,GX*.evt*}") [string]

Wildcard matching pattern for science files.

(cleanup = yes) [boolean]

Clean up scratch files?

(chatter = 1) [int] range 0-5

Verbosity level of output. At level 0, no output is produced, unless outfile="-". At level 1, a human readable table is produced. At level 2 and higher, additional debugging information is produced.

(clobber = yes) [boolean]

Overwrite output files? By default this is YES, and the task does not function properly if you set it to NO.

(history = yes) [boolean]

Write standard HEADAS parameter history into output file?

EXAMPLES

  # Scan observation 11111-01-01-01.  Do not produce a machine parsable file

  xtedatamode indir=./11111-01-01-01 NONE

  # Save machine parsable file to myfile.txt.
  
  xtedatamode indir=./11111-01-01-01 myfile.txt
  
  # Disable human readable output but print machine parsable file to standard
  # output.
  
  xtedatamode indir=./11111-01-01-01 - chatter=0

SEE ALSO

pcaprepobsid

CATEGORY