[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

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


readasm Source code in readasm.pro

readasm

Name
           readasm
Purpose
           Read an ASM 1dwell lightcurve, bin to a desired
           temporal resolution...
Category
           RXTE tools
Calling Sequence
           readasm,time,rate,error,filename,mjd=mjd,tstart=tstart, $
              tend=tend,chi2=chi2,ra_obj=ra_obj,dec_obj=dec_obj,  $
              maxchi2=maxchi2,color=color,time_col=time_col, $
              ratea=ratea,errora=errora,chia=chia, $
              rateb=rateb,errorb=errorb,chib=chib, $
              ratec=ratec,errorc=errorc,chic=chic
Input Parameters
           filename: name of the file to be read, WITHOUT THE SUFFIX
                     (.lc or .col)
Optional Input Parameters
           none
Keyword Parameters
           mjd   : if set, return time as a MJD (=JD-2400000.5)
           tstart: start of time-interval to be read
           tend  : end of time-interval
           units of tstart and tend are either MET
           (in days), or MJD, if the MJD switch is set.
           maxchi2: set maxchi2 to the maximum reduced chi^2 value
                   you still want to accept
           minchi2: set minchi2 to the minimum reduced chi^2 value
                   you still want to accept
           exptime: set exptime to select only dwells with a complete
                    exposure time of 90 sec.
           ssc_n:  select ssc number (0,1 or 2) (only for the case
                   color=0, see below)
           color  : select ASM color.
                        0: total  band (...d1.lc files)
                      for the ...d1.col files, the follwing bands are
                      possible:
                        1: ASM channel  410...1188 1.3 -- 3.0keV
                        2: ASM channel 1189...1860 3.0 -- 5.0keV
                        3: ASM channel 1861...4750 5.0 --12.2keV
                        4: Three ASM colors plus total, from separate
                           files (total in main time, rate, etc.)
Output Parameters
           time  : time of each time-bin (mid of interval)
           rate  : ASM count-rate (1-10 keV)
           error : uncertainty
Optional Output
           chi2     : reduced chi^2 values for the returned lightcurve
           ra_obj   : Object right ascension in degrees
           dec_obj  : Object declination in degrees
           time_col : time for separate colors
           ratea..c : rates for separate colors
           errora..c: errors for separate colors
           chia..c  : reduced chi^2 values for separate colors
Common Blocks
           none
Side Effects
           none
Restrictions
           hopefully none; tend has to be larger than tstart
Procedure
           see code
Example
           readasm,time,rate,error,'xa_herx1_d1',/mjd
           ...read all available  ASM data on Her X-1, return time as
           MJD
Revision History
 $Log: readasm.pro,v $
 Revision 1.10  2004/08/13 15:28:29  wilms
 updated exposure keyword to work with individual energy bands
           Version 1.0, 1997/10/06, Joern Wilms
           Version 1.1, 1998/07/07, Joern Wilms / Sara Benlloch:
             * added maxchi2 keyword and chi2 optional output.
             * removed dt keyword (no internal rebinning is done)
           Version 2.0, 1999/08/14, Joern Wilms:
             * added option to select for ASM color
           Version 2.1, 1999/09/22, Michael Nowak:
             * added screening to make sure color files have either 3
               or 6 legitimate colors only at any given time, to
               remove spurious points
             * added option to output 3 colors simultaneously
             * maxchi2 applies to all 3 channels simultaneously,
               equally
            Version 2.2, 1999/10/19, Michael Nowak
             * color=4 now outputs 3 colors plus total
             * changed color lightcurve screening to compare to total
               integrated lightcurve, and screen for specific,
               acceptable channel patterns
            Version 2.3, 1999/11/04, Joern Wilms
             * integated back into aitlib, changed small typo in the
               color selection.
            Version 2.4, 1999/11/16, Sara Benlloch
             * added filename_end variable to avoid mistakes with the
               definition of the filenames.
            Version 2.5, 1999/11/29, Sara Benlloch
             * added option ra_obj and dec_obj to output
            Version 2.6, 2000/11/28, Sara Benlloch (IAAT),
             * added keywords; minchi2,exptime,ssc_n
            Version 2.7, 2001/04/19, Katja Pottschmidt (IAAT),
             * changed loop variable nt to long, substituted color suffix
               b for c in two places where necessary

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

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

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