The QDP ``extraction'' programs

The following text describes some software that reads a Ginga HDS file (e.g., a time series) and extracts the required data (i.e., a light curve in this example) and writes this data to a QDP file. That data is then accessible to QDP, and can be displayed, and fitted by the QDP software (the graphical part of which is based on PGPLOT). It is possible to produce a publication-quality graph showing, for example, a Ginga light curve.

1. The program ginga_cube extracts auxiliary housekeeping (HK) data or LAC count rates from a data cube (or time series). The following example extracts the SUD and LAC count rates from a background subtracted and attitude corrected data cube. The program prompts for the spectral channel, detector idents and the start and stop time of the data to be extracted. Normally, the input file should be a time series, otherwise only the contents of one spectral channel will be extracted. QDP will display the LAC count rates and the SUD rates on the X-axis and Y-axis respectively. Note that the LAC count rate and auxiliary HK data can be extracted as a function of time; to do this, PLT_X parameter should be set to TIME.

   qcl>ginga_cube
    
   ** GINGA_CUBE Version 1.1 Mon Aug 18 15:01:03 1997 **
    
   GNG_NCUBE Number of data files = 0 =1
   GNG_DATIN001 Data filenames =mkn335_91a.sub_corr
   PLT_X Data to be plotted on x-axis =lac
   PLT_Y Data to be plotted on y-axis =sud 
   Datafile has 48 energy channels
   PLT_EN Energy channel to plot = 1 =4
   Datafile has  2 ident channels
   PLT_ID1 First ident channel to plot = 1 =
   PLT_ID2 Last ident channel to plot = 2 =
   PLT_TSTART Start time of plot = 0.0 =
   PLT_TEND End time of plot = 50304.0 =
    Opening file: mkn335_91a_cube.qdp
                          
   qcl>

2. The program ginga_time extracts a light curves from a Ginga data file into a QDP file which can be used as input to the xronos timing analysis package. The following is an example of its use:

   qcl>ginga_time
    
   ** GINGA_TIME Version 1.1 Mon Aug 18 14:51:11 1997 **
    
   GNG_NCUBE Number of data files = 0 =1
   GNG_DATIN001 Data filenames =mkn335_91a.time
    Opening file: mkn335_91a_time.qdp
                          
   qcl>

3. The program ginga_phad extracts pulse height spectra from a Ginga data file. The following is an example of its use:

   qcl>ginga_phad
    
   ** GINGA_PHAD Version 1.1 Mon Aug 18 14:58:06 1997 **
    
   GNG_NCUBE Number of data files = 0 =1
   GNG_DATIN001 Data filenames =mkn335_91a.phad
    Opening file: mkn335_91a_phad.qdp
                          
   qcl>

4. The program ginga_sub extracts light curves, in six energy bands (1.0-3.9 keV; 3.9-6.8 keV; 6.8-10.0 keV; 10.0-13.7 keV; 13.7-18.3 keV; 18.3-27.9 keV), from a Ginga data cube. The following is an example of its use:

   qcl>ginga_sub
    
   ** GINGA_SUB Version 1.1 Mon Aug 18 16:22:30 1997 **
    
   GNG_NCUBE Number of data files = 0 =1
   GNG_DATIN001 Data filenames =mkn335_91a.sub_corr
   Datafile has  2 ID channels
   PLT_ID ID channel to plot = 1 =1
    Opening file: mkn335_91a_sub.qdp
                          
   qcl>

5. The program ginga_radec extracts the LAC count rate, SUD, SOL2, RA, Dec and TRANSMISSION data from a Ginga data cube or time series. Normally, the input file should be a time series, otherwise the contents of one spectral channel will only be extracted. The following is an example of its use:

   qcl>ginga_radec
    
   ** GINGA_RADEC Version 1.1 Mon Aug 18 16:27:30 1997 **
    
   GNG_NCUBE Number of data files = 0 =1
   GNG_DATIN001 Data filenames =mkn335_91a.sub_corr
   Datafile has 48 PHA channels
   PLT_PHA PHA channel to plot = 1 =4
   Datafile has  2 ID channels
   PLT_ID ID channel to plot = 1 =1
    Opening file: mkn335_91a_radec.qdp
                          
   qcl>

6. The program pl_spec extracts the results from the spectral files produced by the program spf (see section 7.4). The programs prompts for the number of instrument files used in the fit and the spectral file root name. The program also asks whether the user requires a hardcopy of the spectral results (the word "print" must be alias to the print command at the user's site; e.g., print might be an alias of the command lpr -Pprinter_name). The following example produces two output files: mkn335_91a.qdp and mkn335_91a.pco, the latter being invoked within the former when displayed using QDP.

   qcl>pl_spec
    
   ** PL_SPEC Version 1.0 Mon Aug 18 14:44:00 1997 **
    
   PLT_PRINT Print results listing (Y/N) = NO =
   PLT_NINST Number of instrument files = 1 =
   PLT_NAME Spectral file root name =mkn335_91a
   qcl>

7. The program ginga_fold extracts the results from the programs foldcb, foldts, etc. (see section 8.2). The program prompts for the number and names of the input files and, in the case of multiple folding, whether the user requires the chi-square versus period results. The following example produces two output files: mkn335_91a_fold.qdp and mkn335_91a_fold.pco.

   qcl>ginga_fold
    
   ** GINGA_FOLD Version 1.1 Tue Sep  9 23:15:15 1997 **
    
   GNG_NCUBE Number of data files = 0 =1
   GNG_DATIN001 Data filenames =mkn335_91a.fld
   GNG_MULTI Do you want to see chi-square versus period? = Yes =yes
    Opening file: mkn335_91a_fold.qdp
    Opening file: mkn335_91a_fold.pco
                          
   qcl>