STScI Logo

efits2qp xray.xdataio


NAME · USAGE · DESCRIPTION · PARAMETERS · EXAMPLES · BUGS · SEE_ALSO

NAME

efits2qp -- Convert an Einstein FITS file (containing BINTABLE extensions) into an IRAF/PROS QPOE file.

USAGE

efits2qp fitsfile inst datatype qpoefile

DESCRIPTION

efits2qp converts an Einstein FITS file (containing BINTABLE extensions) into an IRAF/PROS QPOE file. The user must specify the full name of the FITS file as well as the appropriate Einstein instrument type (ipc or hri). If the instrument is "ipc", the user must specify the datatype of the FITS file (event, slew, or unscreened). If the instrument is "hri", the datatype is set to "event".

The conversion is performed by the task fits2qp with the parameters set to the values appropriate to the particular instrument and datatype.

In addition, if the input FITS file is of datatype "event", the qpaddaux task is run to convert the Einstein TGR records to the general TSI extension.

If the input FITS file is from the IPC unscreened dataset (IPCU), fits2qp creates an intermediate file ("root_unsrtd.qp") which is then sorted by the task qpsort to the specified output qpoefile name, and then deleted.

PARAMETERS

fitsfile = ""

The input FITS file name.

inst = "" (hri or ipc)

Einstein instrument type.

datatype = "" (event, slew, or unscreened)

If the input instrument is "ipc", the user must provide the datatype of the input FITS file. If the input instrument is "hri", the datatype is set to "event".

qpoefile = "."

The output IRAF/PROS QPOE file name. A ".qp" extension will be added to any specified name that does not contain this extension. If the null string is specified, the name will be the same as the input FITS root with a ".qp" extension. If a "." is used, the name will be the same as the input FITS root without the path so that the output file will be written to the current working directory. (Note that if the input FITS file is from the IPCU data set, an intermediate file "root_unsrtd.qp" will be written to the same directory as the output qpoefile.)

(clobber = no) [boolean]

If the output QPOE file already exists, this flag specifies whether or not it can be overwritten.

(display = 1) [int]

The level of stdout display. A setting of 0 should display no output except warnings. Settings above 3 are only useful for debugging purposes.

(qp_internals = yes) [boolean]

Boolean flag controlling whether the internal QPOE parameters are prompted for (see below), or whether they are defaulted to values that are internally hardwired. This parameter is not usually changed by the user. (Prompting is normally turned off during stand-alone debugging only).

(qp_pagesize = 2048) [int]

Page size for the QPOE file. This parameter is internal to the QPOE file and should not normally be changed.

(qp_bucketlen = 4096) [int]

Bucket length for the QPOE file. This parameter is internal to the QPOE file and should not normally be changed.

(qp_mkindex = yes) [boolean]

Boolean flag to indicate whether or not an index should be made for the QPOE file. This parameter is internal to the QPOE file and should not normally be changed.

The qp_mkindex flag should only be set to "yes" for FITS files with position sorted events. The IPC unscreened FITS files are not position sorted; hence, for IPCU data, this task will override any user specified value and set the parameter to "no". The default value of "yes" is used for all other datasets.

(qp_key = "") [string]

Key on which to make the QPOE index. This parameter is internal to the QPOE file and should not normally be changed. With the parameter qp_mkindex set to "yes", fits2qp generates a QPOE index of "y x". This parameter is not used if qp_mkindex is set to "no" (for instance, for the IPCU dataset).

(qp_debug = 0) [int]

Debug level for QPOE internals. This parameter is internal to the QPOE file and should not normally be changed.

(sortsize = 1000000) [int]

For IPCU data, this parameter is used when sorting the events. This parameter represents the number of bytes that are to be sorted at a time. The user can then tailor the task to the amount of available memory. Use "help qpsort" to see more details on sorting.

EXAMPLES

1. Use efits2qp to convert an HRI event file.

ei> efits2qp
input FITS file name: /data/hrievt2/data/17h/H1700S37.XPA
Einstein instrument (hri|ipc): hri
output IRAF/PROS QPOE file name (.): H1043.qp

Using FITS file /data/hrievt2/data/17h/H1700S37.XPA to create QPOE file.

Writing output QPOE file: H1043.qp

aux=.convtgr, type=convtgr -> H1043.qp

2. Use efits2qp to convert an IPC event file.
ei> efits2qp
input FITS file name: /data/ipcevt1/data/04h/i0423n15.xpa
Einstein instrument (hri|ipc): ipc
datatype of FITS file (event|slew|unscreened): event
output IRAF/PROS QPOE file name (.):    

Using FITS file /data/ipcevt1/data/04h/i0423n15.xpa to create QPOE file.

Writing output QPOE file: ./i0423n15.qp

aux=.convtgr, type=convtgr -> ./i0423n15.qp

3. Use efits2qp to convert an IPC slew file.

ei> efits2qp
input FITS file name: /data/slewcd/data/08h/s0824s42.f3d
Einstein instrument (hri|ipc): ipc
datatype of FITS file (event|slew|unscreened): slew
output IRAF/PROS QPOE file name (.): slew.qp

Using FITS file /data/slewcd/data/08h/s0824s42.f3d to create QPOE file.

Writing output QPOE file: slew_stemp.qp

slew_stemp.qp[y=2:] (; no exp.) -> slew.qp
Creating QPOE output file: slew.qp

4. Use efits2qp to convert an IPC unscreened file.
ei> efits2qp
input FITS file name: /data/ipcu1/data/00h/i0036s71.upa
Einstein instrument (hri|ipc): ipc
datatype of FITS file (event|slew|unscreened): unscreened
output IRAF/PROS QPOE file name (.): ipcu.qp

Using FITS file /data/ipcu1/data/00h/i0036s71.upa to create QPOE file.

char strings not yet implemented - skipping
Writing output QPOE file: ipcu_unsrtd.qp

ipcu_unsrtd.qp[y=2:] (; no exp.) -> ipcu.qp
Creating QPOE output file: ipcu.qp

BUGS

The slew and IPCU datasets have a few events which contain y pixel values of 1. There is a current IRAF bug which allows these events to "leak" into any spatial screening, i.e., any region. Because of this bug, these events are always removed from the data by the current version of this task.

For the slew dataset, the FITS2QP task is used to create an intermediate file "root_stemp.qp". A call to QPCOPY is used to remove the y=1 events from the intermediate file, and write out the final QPOE file. The intermediate file is then deleted.

For the IPCU dataset, the events are removed during the QPSORT call.

SEE ALSO

See fits2qp for details on how the FITS file is converted into a QPOE file. See qpaddaux for details on how the TGR records are converted into the TSI extension. See qpsort for details on the sorting of the IPCU data. For the conversion of Einstein FITS image files, see strfits . For direct access to the FITS files on the Einstein CD-ROM archive, see the eincdrom package.


Source Code · Search Form · STSDAS