sdlist.py

Go to the documentation of this file.

#
# This file was generated using xslt from its XML file
#
# Copyright 2009, Associated Universities Inc., Washington DC
#
import sys
import os
from  casac import *
import string
from taskinit import casalog
#from taskmanager import tm
import task_sdlist
def sdlist(infile='', antenna=0, scanaverage=False, outfile='', overwrite=False):

        """ASAP SD task: list summary of single dish data
        Keyword arguments:
        infile -- name of input SD dataset
        antenna -- antenna name or id (only effective for MS input). 
        scanaverage -- average integrations within scans
                options: (bool) True,False
                default: False
                example: if True, this happens in read-in
                For GBT, set False!
        outfile -- Name of output file for summary list
                default: '' (no output file)
                example: 'mysd_summary.txt'
        overwrite -- overwrite the output file if already exists
                options: (bool) True,False
                default: False


        DESCRIPTION:

        Task sdlist lists the scan summary of the dataset after importing
        as a scantable into ASAP.  It will optionally output this summary
        as file.

        Note that if your PAGER environment variable is set to 'less' and
        you have set the 'verbose' ASAP environment variable to True
        (the default), then the screen version of the summary will page.
        You can disable this for sdlist by setting
        sd.rcParams['verbose']=False
        before running sdlist.  Set it back afterwards if you want lots
        of information.

        WARNING for the GBT raw SDFITS format data as input:
        SDtasks are able to handle GBT raw SDFITS format data since the 
        data filler is available. However, the functionality is not well 
        tested yet, so that there may be unknown bugs.  

  
        """

#
#    The following is work around to avoid a bug with current python translation
#
        mytmp = {}

        mytmp['infile'] = infile
        mytmp['antenna'] = antenna
        mytmp['scanaverage'] = scanaverage
        mytmp['outfile'] = outfile
        mytmp['overwrite'] = overwrite
        pathname='file:///'+os.environ.get('CASAPATH').split()[0]+'/share/xml/'
        trec = casac.utils().torecord(pathname+'sdlist.xml')

        casalog.origin('sdlist')
        if trec.has_key('sdlist') and casac.utils().verify(mytmp, trec['sdlist']) :
            result = task_sdlist.sdlist(infile, antenna, scanaverage, outfile, overwrite)

        else :
          result = False
        return result