NRAO Home  >  Green Bank  |  Wiki Topic:    GB > Data > SdfitsUsage
   Changes | Index | Contents | Search | Statistics | Jump to Topic
Using the GBT SDFITS Application

  Main     Usage     FITS Specification     Updates  


Getting Started

Type sdfits -help to review the command line options.

Usage Instructions

usage:
    sdfits [OPTIONS] PROJECT_DIR [OUTPUT_PREFIX]

sdfits will reduce a GBT observation indicated by PROJECT_DIR into a set of
single dish (SD) FITS files whose names are prefixed with OUTPUT_PREFIX.
If OUTPUT_PREFIX is not given, the project name is used for this purpose.

PROJECT_DIR must be a complete path to a GBT observation directory.

OUTPUT FILES
    A separate SDFITS file is generated for each backend requested.

    Each file generated will have a name beginning with OUTPUT_PREFIX and
    ending with a suffix that reflects the data mode chosen by the user
    as well as the backend.

    The suffix has the form ".MODE.BACKEND.fits", where MODE is "avg",
    "cal", or "raw", and BACKEND is "acs", "sp", or "dcr".
    Examples are "MyData.avg.sp.fits" and "MyData.raw.dcr.fits".

OPTIONS
    -backends=DEVICES
          The DEVICES can be one or more (comma-separated) of the following:
              acs - autocorrelating spectrometer
              sp  - spectral processor
              dcr - digital continuum receiver
          Backends are processed in user-listed order.

          If -backends is not given, data from all three backends will be
          processed.

    -mode=MODE
          The MODE can be only one of the following:

              avg - Each row is from one sampler, and is the spectrum of the
                    entire scan, averaged over all calibrated integrations
                    from that scan.

              cal - Each row is from one sampler, and is the spectrum of a
                    calibrated integration.
              raw - Each row is from one sampler, and is the spectrum of the
                    raw data of a single phase.

          If -mode is not given, raw mode is assumed.

    -quiet
          All non-error related messages are suppressed.

    -scans=SCAN_NUMBER_LIST
          This option can be used to specify which scans to target.  If not
          given, all scans are targeted.  This list is a comma-separated
          sequence of items, with no spaces.  An item can be a single
          integer, or a range specification.  If more then one of the
          specified scan numbers exists in the project for the requested
          backends, each instance of the scan will be targeted.  To target
          only one of these duplicate scan numbers, use the -timestamp option.

          A range specification can have one of three forms:
            a:b     Scan numbers a through b, inclusive.
            a:      Scan numbers no less than a.
            :b      Scan numbers no greater than b.

          Scans are processed in user-listed order (per backend).  Example scan
          lists are:
            -scans=1,4,5:18
            -scans=2,18:40,5
            -scans=:24
            -scans=1,2,18:

    -timestamp=STARTTIME,ENDTIME
          This option can be used to target scans by the UTC timestamp of the
          start of the scan (used to name the raw M&C FITS) files.
          If STARTTIME is omitted then all data from STARTTIME to the
          end of available data is filled (-scans is also used to possibly
          limit the data to be filled). If STARTTIME is omitted so that the
          option is ",ENDTIME" with the leading comma then data will be filled
          up to and including ENDTIME (again, using -scans). If both times are
          included then all data from STARTTIME to ENDTIME is filled
          consistent with -scans. The times are specified exactly as they
          appear in the raw M&C FITS file names: YYYY_MM_DD_HH:MM:SS. This is
          identical to how TIMESTAMP is specified within GBTIDL to resolve
          duplicate scan numbers. The timestamps will be compared only against
          this date in the M&C files for that scan. If a timestamp occurs in
          the middle of a scan then either that scan is excluded (if the
          comparison is with STARTTIME) or included (if the comparison is with
          ENDTIME). No attempt will be made to select individual integrations
          based on the -timestamp arguments.

          Example timestamps are:
            -timestamps=2006_08_13_02:51:42,2006_08_13_08:22:06
            -timestamps=,2006_08_13_08:22:06
            -timestamps=2006_08_13_02:51:42

    -noindex
          Do not create an Index File in parallel with sdfits file.

    -append
          Files are appended instead of being overwritten.

    -fixbadlags
          Attempt to find and fix bad lags in ACS data.  The locations
          of the lags that were fixed are written to a log file.  The
          name of the log file is OUTPUT_PREFIX.MODE.acs.fixed_lags.
          This fix should only be used if you know that your data suffer
          from lag dropouts.  Full documentation on how the lags fixed is
          applied is available at 
          http://wiki.gb.nrao.edu/bin/view/Software/ModificationRequest15C306


    -sigmafactor=SIGMA_FACTOR
          This is part of the fixbadlags option.
          Lags are bad when they deviate from a comparison mean value
          by more than SIGMA_FACTOR times the standard deviation of the
          comparison data around that mean.  This defaults to 6.

    -spikestart=SPIKE_START
          This is part of the fixbadlags option.
          Single bad lags (spikes or drop outs) are searched for starting
          with the SPIKE_START lag.  This defaults to 200.

    -version
          Show the program version information.

Examples

Spectrometer, raw mode, all scans:
sdfits -backends=acs /home/archive/test-data/tape-0001/T_LBAND_26MAR03
Spectrometer, calibrated mode, scan 24:
sdfits -scans=24 -backends=acs -mode=cal /home/archive/test-data/tape-0001/T_LBAND_26MAR03 scan24
Spectrometer, averaged mode, scan 24:
sdfits -scans=24 -backends=acs -mode=avg /home/archive/test-data/tape-0001/T_LBAND_26MAR03 scan24
Spectral Processor, raw mode, scans 6, 5, 8, and 7:
sdfits -scans=6:5,8:7 -backends=sp -mode=raw /home/archive/science-data/tape-0001/AGBT02A_038_01 scans_6.5.8.7
DCR, calibrated mode, through scan 3:
sdfits -scans=:3 -backends=dcr -mode=cal /home/archive/science-data/tape-0001/AGBT01A_014_08
All 3 backends, averaged mode, scans 13 (acs), 52 (sp), and 1 (dcr):
sdfits -scans=1,13,52 -mode=avg /home/archive/test-data/tape-0001/TGBT01A_004_03
All 3 backends, averaged mode, scans 1 (dcr), 52 (sp), and 13 (acs):
sdfits -backends=dcr,sp,acs -scans=1,13,52 -mode=avg /home/archive/test-data/tape-0001/TGBT01A_004_03
Raw mode, fixing bad lags in scans 45 to 50 (acs)
sdfits -backends=acs -scans=45:50 -fixbadlags /home/gbtdata/AGBT05C_020_03
The log file produced by this command looks like this:
# timestamp scan sampler int phaseid channels
2006_03_01_20:53:39 45 B21 1 0 2048:3071
2006_03_01_20:53:39 45 B21 3 0 2048:3071
2006_03_01_20:56:03 46 B22 3 0 4558,5300,5446
2006_03_01_20:58:26 47 B17 1 0 5682,6464
2006_03_01_21:05:40 50 B21 1 1 5616,6820
This lists the regions and spikes that were found and fixed.

Topic SdfitsUsage . { Edit | Attach | Ref-By | Printable | Diffs | r1.8 | > | r1.7 | > | r1.6 | More }
Revision r1.8 - 13 Feb 2007 - 20:03 GMT - BobGarwood Content copyright © 1999-2007 by the contributing authors.
All material on this collaboration platform is the property of the contributing authors.