xrtproducts help file

NAME

xrtproducts -- Generate high level product data files from a cleaned event file.

USAGE

xrtproducts infile outdir [parameter = ]

DESCRIPTION

'xrtproducts' extracts high level product data files, i.e. spectra, light curves and images, for the XRT Photon Counting (PC), Windowed Timing (WT) and Photodiode (PD) modes data using as input the calibrated and screened event file (Level 2). For the XRT Image mode data, 'xrtproducts' produces a sky coordinates image plot.

The Photon Counting mode products are: spectrum, light curve and image. The source spectrum and light curve are extracted by filtering the data on a spatial region in sky coordinates. If the parameter 'regionfile' is set to DEFAULT the user, through the parameters 'ra', 'dec' and 'radius', can specify the Right Ascension and Declination of the center and the radius of a circular extraction region. A region file with an arbitrary shape can be input through the parameter 'regionfile'. This file should have a format compatible with 'xselect' and 'ds9'. A full field of view image in sky coordinates in the 0.5-10 keV band is produced if the parameter 'imagefile' is different from 'NONE'.
Windowed Timing mode products are: spectrum, light curve and image. The WT mode has only information in one one spatial dimension. If the parameter 'regionfile' is set to DEFAULT the user, through the parameters 'ra', 'dec' and 'radius', can specify the Right Ascension and Declination of the center and the radius of a circular extraction region. A region file with an arbitrary shape can be input through the parameter 'regionfile'. An image in RAW coordinates is produced if the parameter 'imagefile' is different from 'NONE'.
Low rate and Piledup Photodiode modes products are: spectrum and light curve. The PD modes, Low Rate and Piledup, do not have spatial information and all the events are used to create a spectrum and a light curve.
Image mode products are: image plot. The task'xrtproducts' generates a plot of the full field of view image in sky coordinates.

Spectra and light curves for all modes are not background subtracted. By setting the parameter 'bkgextract' to 'yes' the user can also extract the spectrum and light-curve of the background from a region file specified by the parameter 'bkgregionfile'. For the PC and WT modes, the region definition is assumed to be always in sky coordinates. The user can set the binsize (in seconds) and the minimum and maximum PI channels of the extracted light curve via the parameters 'binsize', 'pilow' and 'pihigh', respectively. Moreover, the user can apply a time filter to the event file providing in input a fits GTI file (parameter 'gtifile').

If the parameter 'phafile' is different from 'NONE' the spectrum is extracted and the ARF file is calculated via the task 'xrtmkarf'. Only for PC and WT modes, the arf calculation takes into account an input exposure map if the parameter 'expofile' is different from 'NONE'. The ARF file can also be generated by running separately 'xrtmkarf' (see 'xrtmkarf' help).

By default (input parameter 'correctlc' set to 'yes'), the task also generates a telescope vignetting and Point Spread Function (PSF) corrected light-curve (parameter 'lccorrfile') by an internal run of the 'xrtlccorr' task (see help file). In this case, it is necessary to specify in input also the attitude file (parameter 'attfile') and the Housekeeping Header Packets file (parameter 'hdfile').

By setting the parameter 'plotdevice' to GIF or PS, the user can choose the device for the plots of the image, light curve and spectrum generated.

PARAMETERS

infile [file name]: Name of the input FITS event file to be processed. Unix-compressed file are allowed.
regionfile [file name]: Name of the source region file for spatial filtering. If DEFAULT a standard spatial region is used for products extraction. For PC and WT modes the standard spatial region is a CIRCLE specified through the parameters 'ra', 'dec' and 'radius'.
(bkgextract = no) [boolean]: If set to yes, extract background products for PC and WT mode.
bkgregionfile [file name]: Name of the input background region file (used only if bkgextract=yes).
outdir [directory name]: Directory for the output files.
stemout [string]: Stem for the output files. Input 'DEFAULT' to use Standard Naming Convention.
ra [string]: Right Ascension (J2000.0) of the center of the region to be used for spatial filtering.
dec [string]: Declination (J2000.0) of the center of the region to be used for spatial filtering.
radius [real]: Source radius of the circular region for spatial filtering in pixel (only for PC and WT).
(binsize = -99) [real]: Bin size (seconds) for the light curve. If <0 a default value is used (2.51 s for PC, 1 s for WT and PD, 0.1 s for WT in SETTLING mode).
(display = no): If 'yes' is input, plots the image of the field on the screen.
(lcfile = DEFAULT) [file name]: Name of the output source light curve file or DEFAULT to use stem or NONE for none.
(phafile = DEFAULT) [file name]: Name of the output source spectrum file or DEFAULT to use stem or NONE for none.
(bkglcfile = DEFAULT) [file name]: Name of the output background light curve file or DEFAULT to use stem or NONE for none (used only if bkgextract=yes).
(bkgphafile = DEFAULT) [file name]: Name of the output background spectrum file or DEFAULT to use stem or NONE for none (used only if bkgextract=yes).
(imagefile = DEFAULT) [file name]: Name of the output image file or DEFAULT to use stem or NONE for none.
(gtifile = NONE) [file name]: Name of the input GTI file for spectrum and light curve extraction or NONE for none
(arffile = DEFAULT) [file name]: Name of the output ARF file. DEFAULT to use stem.
(rmffile = CALDB) [file name]: Name of the input RMF file. If set to CALDB (default), use the file in the Calibration Database.
(mirfile = CALDB) [file name]: Name of the input mirror on-axis effective area file. If set to CALDB (default), use the file in the Calibration Database. Used only if parameter 'inarffile' is NONE.
(transmfile = CALDB) [file name]: Name the input filter transmission file. If set to CALDB (default), use the file in the Calibration Database. Used only if parameter 'inarffile' is NONE.
(inarffile = CALDB) [file name]: Name of the input on-axis Ancillary Response Function (ARF) file. If set to 'CALDB' (default value), use the file in the Calibration Database. If set to NONE the on-axis ARF is calculated using the parameters 'mirfile' and 'transmfile'.
(psffile = CALDB) [file name]: Name the input psf FITS file. If CALDB is input (default), use the file in the Calibration Database.
(vigfile = CALDB) [file name]: Name input vignetting FITS file.If CALDB is input (default), use the file in the Calibration Database.
(psfflag = yes) [boolean]: If set to 'yes', correct for the PSF when calculates the ARF.
(extended = no) [boolean]: Extended source flag for ARF generation.
(arfboxsize = 20) [integer]: Size in pixel for the subimage boxes for ARF generation (used if extended=yes).
expofile [file name]: Name of the input exposure map file (or NONE for none).
(plotdevice = gif): Device for plots (gif or ps).
(pilow = 30) [integer]: Minimum PI value for light curve extraction
(pihigh = 1000) [integer]: Maximum PI value for light curve extraction
(correctlc = yes): If set to 'yes', correct source light-curve with the xrtlccorr module.
attfile [file name]: Name of the input Attitude FITS file (only if correctlc=yes).
hdfile [file name]: Name of the input Housekeeping Header Packets FITS file (only if correctlc=yes).
(outinstrfile = DEFAULT) [file name]: Name of the output Instrument Map file or 'DEFAULT' for standard name (only if correctlc=yes).
(corrfile = DEFAULT) [file name]: Name of the output corrected source LC file or DEFAULT for standard name (only if correctlc=yes).
(lccorrfile = DEFAULT) [file name]: Name of the output corrected source LC file or DEFAULT for standard name (only if correctlc=yes).
(wtnframe = 10) [integer]: Number of frames used to create instrument map for WT? (only if correctlc=yes).
(pcnframe = 4) [integer]: Number of frames used to create instrument map for PC? (only if correctlc=yes).
(lcenergy = 1.5) [real]: Energy value (keV units) for PSF and vignetting LC correction (only if correctlc=yes).
(clobber = no): If set to 'yes', overwrite the output files with same name if they exist.
(chatter = 3) [integer]: Verbosity Level from 0 to 5.
(history = yes) [boolean]: If set to 'yes', include history records.
(cleanup = yes) [boolean]: If set to 'yes', delete temporary files.

EXAMPLES

From a Photon Counting mode event file generates spectrum, ARF file, corrected light-curve and image of a source included in the region of 20 pixels radius centered on celestial coordinates (RA,Dec)=(43.5645,45.2048). The binsize of the light curve has been set to 100 s.
```
>  xrtproducts infile=sw00073125003xpcw2po_cl.evt stemout=DEFAULT regionfile=DEFAULT 
   outdir=./ binsize=100 ra=43.5645 dec=45.2048 radius=20 expofile=sw00073125003xpcw2po_ex.img 
   attfile=sw00073125003pat.fits hdfile=sw00073125003xhdtc.hk 
```
From a Windowed Timing mode event file generates spectrum, ARF file, corrected light-curve and image of a source included in the input spatial region 'source.reg'. The energy spectrum and light-curve of the background (described in the input spatial region 'back.reg') are also generated. The binsize of the light-curves has been set to 1 second.
```
>  xrtproducts infile=sw00599287000xwtw2po_cl.evt regionfile=source.reg outdir=./
   bkgextract=yes bkgregionfile=back.reg binsize=1 expofile=sw00599287000xwtw2po_ex.img
   hdfile=sw00599287000xhdtc.hk attfile=sw00599287000pat.fits 
```

BUGS

LAST MODIFIED

June 2015