NAME

ftchkpha -- checks the validity of a FITS pha file.

USAGE

ftchkpha [infile=]filename1 (outfile=filename2) (clobber=yes/no)

DESCRIPTION

The task performs consistency and keyword checks on an input FITS file to determine whether it satisfies the spectral file standard, reporting the results to the terminal or a text file.

The task checks for mandatory keywords and optional keywords. Optional keywords are recommended to supply further detailed informations regarding data sets.

For more information about the standard, see the memo OGIP Spectral File Format, OGIP/92-007 (or in PDF).
https://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/spectra/ogip_92_007/ogip_92_007.html
https://heasarc.gsfc.nasa.gov/docs/heasarc/ofwg/docs/spectra/ogip_92_007.pdf - PDF

The mandatory keywords checked are:

TELESCOP, INSTRUME, FILTER, EXPOSURE, AREASCAL, BACKFILE, BACKSCAL, CORRFILE, CORRSCAL, RESPFILE, ANCRFILE, HDUCLASS, HDUCLAS1, HDUVERS, CHANTYPE, DETCHANS

The optional keywords checked are:

XFLTXXXX, POISSERR, OBJECT, RA-OBJ, DEC-OBJ, EQUINOX, RADECSYS, DATE-OBS, TIME-OBS, DATE-END, TIME-END, CREATOR, HDUCLAS2, HDUCLAS3, HDUCLAS4

PARAMETERS

infile [filename]
The input file name containing PHA or PI data

(outfile = pha.log) [filename]
The name of the output log file name. Default is set to 'pha.log'. To change the output file name, use outfile=filename in the command line.

(clobber = yes) [boolean]
Flag specifying whether or not a pre-existing file with the same name as that requested as the output file from this task will be overwritten.

EXAMPLES

  1. ftchkpha test.pha

  2. ftchkpha test.pha outfile=testpha.log

  3. ftchkpha test.pha outfile=testpha.log clobber=yes

LAST MODIFIED

January 2018