[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


writest2f Source code in writest2f.pro

writest2f

Name
             writest2f
Purpose
             read XTE/PCA standard2f lightcurves from different
             subobservations and featuring different detector
             combinations; merge them, with optional background and
             deadtime correction; write merged lightcurve to FITS
             file (using MJD and UTC); Poisson errors are included by
             default
Category
             RXTE timing tools
Calling Sequence
             writest2f,path=path,dirs=dirs,out=out, $
               object=object, $
               noback=noback,faint=faint,q6=q6,$
               earthvle=earthvle,skyvle=skyvle, $
               exclusive=exclusive,top=top, $
               nopcu0=nopcu0,fivepcu=fivepcu, $
               cass=cass,deadcorr=deadcorr,noerror=noerror
Input Parameters
             path      : string, path to the directories containing
                         the lightcurves to be merged and to the
                         directory containing the merged lightcurve
             dirs      : string array, directories containing
                         the lightcurves to be merged
             out       : string, directory to contain the merged lightcurve
Optional Input Parameters
             object    : string, name of the source,
                         default: ''
Keyword Parameters
             noback    : if set, the merged lightcurve is not
                         background corrected,
                         default: noback=0, skyvle=1 (Cyg X-1!)
             faint,q6,earthvle,,skyvle :
                         if set, background subtraction using the
                         according model background lightcurve is
                         performed,
                         default: noback=0, skyvle=1 (Cyg X-1!)
             exclusive : if set, only input lightcurve file names including
                         '_excl' are considered,
                         default: exclusive=0
             top       : if set, only input lightcurve file names including
                         '_top' are considered,
                         default: top=0
             nopcu0    : if set, only input lightcurve file names including
                         '_ign0' are considered,
                         note: deadtime correction algorithm is not
                         correct for these lightcurves!
                         default: nopcu0=0
             fivepcu   : if set, normalize count rates wrt to whole
                         PCA, i.e, wrt five PCUs
                         default: fivepcu=0, i.e., give average count
                         rate per PCU
             cass      : if set, use CASS paths
                         default: cass=0, i.e., use Tuebingen paths
             deadorr   : if set, the merged lightcurve is deadtime
                         corrected,
                         default: deadcorr=0
             noerror   : if set, the merged lightcurve does not
                         contain an error array,
                         default: noerror=0
Output Parameters
             none, but see side effects
Optional Output
             none
Common Blocks
             none
Side Effects
             writes the lightcurve to a FITS file, path and filename
             are build using the following inputs: path, out,
             (noback), (fivepcu), (deadcorr)
Restrictions
             the lightcurves to be merged have to be named according
             to the Tuebingen extraction scripts
Procedures Used
             readxtedata, writelc
Example
        path='/xtearray/xtescratch/katja/cygex/P50110/
        dirs=['28.00','28.01','28.02','28.03']
        out='28'
        object='Cyg X-1'
        writest2f,path=path,dirs=dirs,out=out,object=object, $
                 /exclusive,/deadcorr
Revision History
             Version 1.1, 2001 Mar 22, Katja Pottschmidt
                          initial revision
             Version 1.2, 2001 Mar 22, Katja Pottschmidt
                          removed @ compilations
             Version 1.3, 2001 Mar 22, Katja Pottschmidt
                          minor change in header
             Version 1.4, 2001 May 09, Eckart Göhler
                          added propagation of /faint keyword
                          to readxtedata

Last modified by pro2html on 2005 January 04 at 16:44 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically